Добавление возможностей SMS в приложение Rails

Статический IP-адрес: если у вас уже есть статический IP-адрес у вашего интернет-провайдера, это не составляет труда. Просто настройте маршрутизатор для перенаправления запросов с внешнего порта 3000 на ваш внутренний сервер через порт 3000 и используйте свой внешний IP в качестве URL-адреса SMS в Twilio.

Showoff.io: согласно их веб-сайту , это «самый простой способ поделиться локальным хостом через Интернет». И это довольно просто на самом деле. Просто установите их гем и запустите их двоичный файл с внутренним портом, которым вы хотите поделиться, и он сгенерирует короткий URL, который вы можете использовать извне. Вы можете бесплатно пользоваться услугой в течение пяти минут или приобрести один из платных планов. На момент написания этой статьи планы составляют 1 доллар за однодневный пропуск или 5 долларов без ограничений.
Пример использования:

	# Manual install
	gem install showoff—io
	# Or via Bundle
	gem ‘showoff-io’, group: :development
	bundle install
	# Sharing your localhost on port 3000
	show 3000

view raw
gistfile1.rb
hosted with by GitHub

Tunnlr: Подобно Showoff.io , это служба пересылки, которая позволяет вам использовать локальный сервер для внешних пользователей. Их текущий гем tunnlr_connector (1.0.3) работает только с Rails, но его легко расширить для работы с другими фреймворками. На момент написания этой статьи вы можете бесплатно пользоваться этой услугой в течение 30 дней, после чего она стоит 5 долларов в месяц. Одна вещь, которую вы должны сделать, это зарегистрироваться в службе, прежде чем вы сможете использовать драгоценный камень. Он задаст вам вопросы о вашей учетной записи в процессе настройки.

Пример использования:

	# Manual install
	gem install tunnlr_connector
	# Or via Bundle
	gem ‘tunnlr_connector’, group: :development
	bundle install
	# Configure for the first time
	rake tunnlr:configure
	# Sharing your localhost
	rake tunnlr:start

view raw
gistfile1.rb
hosted with by GitHub

Из трех приведенных выше вариантов я лично использую Tunnlr, и это то, что мы будем использовать в этом примере. Это чрезвычайно полезно при работе в разработке и взаимодействии с песочницей Twilio.

После запуска Tunnlr скопируйте созданный URL-адрес и вставьте его в поле «SMS-URL» на панели инструментов Twilio. Не забудьте добавить / подтверждение в конец URL:

Мы все готовы сейчас. Ответ на сообщение о подтверждении, которое мы получили ранее, обновит наш статус пользователя до подтвержденного.

Не забывайте всегда указывать PIN-код с панели мониторинга Twilio к сообщениям, которые вы отправляете в режиме песочницы, в противном случае Twilio ответит сообщением об ошибке. Давай и попробуй.

Написание юнит-тестов и имитация внешних звонков

Последняя часть — это написание тестов для нашего приложения и насмешка по внешним вызовам API Twilio. Я должен упомянуть, что я собираюсь рассказать только о функциональном тесте для UsersController, чтобы продемонстрировать, как работает mocking . Я оставляю другие тесты в качестве упражнения для читателя.

Во время тестов вы должны избегать вызовов внешних служб и отправки реальных текстовых сообщений. Вот где насмешливые объекты пригодятся. В этой статье я буду использовать RR , потрясающий «тестовый двойной» фреймворк.

В вашем Gemfile добавьте следующее и запустите пакетную установку :

	group :test do
	gem ‘rr’
	end

view raw
gistfile1.rb
hosted with by GitHub

Затем откройте test / test_helper.rb и добавьте следующее, что позволит нам использовать RR для насмешки вызовов API Twilio:

	class ActiveSupport::TestCase
	include RR::Adapters::TestUnit
	end

view raw
test_helper.rb
hosted with by GitHub

Теперь откройте test / functions / users_controller_test.rb и добавьте следующее:

	require ‘test_helper’
	class UsersControllerTest < ActionController::TestCase
	test «#new» do
	get :new
	assert_response :success
	assert_template :new
	end
	test «#create succeeds» do
	assert_difference ‘User.count’ do
	post :create, user: {name: ‘John Doe’, email: ‘[email protected]’, phone: ‘555-444-3434’}
	assert_response :ok
	end
	end
	test «#create fails on validation» do
	assert_no_difference ‘User.count’ do
	post :create, user: {name: ‘Joe’}
	assert_response :ok
	assert_template :new
	assert !assigns(:user).valid?
	end
	end
	end

view raw
users_controller_test.rb
hosted with by GitHub

Если вы запустите этот тест, он потерпит неудачу. Не потому, что тест написан неправильно, а потому, что REST-клиент Twilio не может выполнить запрос к указанному ресурсу. Это происходит главным образом из-за того, что наш код пытается отправить реальное текстовое сообщение в тестовом режиме.

Пусть начнется насмешка!

Первое, что нам нужно сделать, это создать ложный класс, который содержит метод method_missing, который возвращает экземпляр self . Это позволяет нам смоделировать цепочку методов в коде Twilio client.account.sms.messages.create () :

	class MockedTwilioClient
	def method_missing(*args)
	self
	end
	end

view raw
mocked_client.rb
hosted with by GitHub

Следующим шагом является использование метода mock для записи клиентского объекта Twilio и возврата экземпляра нашего класса MockedTwilioClient :

mock(Twilio::REST::Client).new(»,»){ MockedTwilioClient.new }

view raw
gistfile1.rb
hosted with by GitHub

Наконец, собрав все вместе, наш тест должен выглядеть так:

	require ‘test_helper’
	class MockedTwilioClient
	def method_missing(*args)
	self
	end
	end
	class UsersControllerTest < ActionController::TestCase
	test «#new» do
	get :new
	assert_response :success
	assert_template :new
	end
	test «#create succeeds» do
	mock(Twilio::REST::Client).new(»,»){ MockedTwilioClient.new }
	assert_difference ‘User.count’ do
	post :create, user: {name: ‘John Doe’, email: ‘[email protected]’, phone: ‘555-444-3434’}
	assert_response :ok
	end
	end
	test «#create fails on validation» do
	assert_no_difference ‘User.count’ do
	post :create, user: {name: ‘Joe’}
	assert_response :ok
	assert_template :new
	assert !assigns(:user).valid?
	end
	end
	end

view raw
users_controller_test.rb
hosted with by GitHub

Теперь, когда вы запускаете тесты, он не только проходит, но и проверяет внешние вызовы API Twilio из нашего UsersController .

Вывод

В этой статье показано, как просто добавить возможности SMS в приложение Rails, и у вас должно быть достаточно знаний, чтобы применить полученные знания в своих собственных проектах. В нем также описаны шаги, которые необходимо предпринять, чтобы вывести свой локальный сервер Rails в Интернет; и как можно применять объектный макет, чтобы избежать вызова внешних сервисов во время теста.

Для упрощения примера были сделаны несколько ярлыков, и вы должны использовать их по своему усмотрению. Пример:

• Лучшие проверки, лучшие тесты
• В UsersController # create код, отправляющий текстовое сообщение, следует переместить в модель User в действие after_create и, возможно, даже выполнить как фоновое задание или отправить его в очередь для последующей обработки.
• … вы поняли идею.

Ресурсы

Twilio:

• Сайт: www.twilio.com
• Драгоценный камень: twilio-ruby

Showoff.io:

• Сайт: www.showoff.io
• Драгоценный камень: showoff-io

Tunnlr:

• Сайт: www.tunnlr.com
• Gem: tunnlr_connector

RR:

• Сайт: www.github.com/btakita/rr
• Драгоценный камень: рр