twilio_base 1.8.0

data/spec/lib/twilio_base/helpers/protocols_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Helpers::Protocols do
+  describe '#extract_mpoa' do
+    let(:correct_number) { '+442039605098' }
+
+    context 'the number can be matched' do
+      it 'returns the same number received through PSTN' do
+        examples = %w[
+          +442039605098
+          +442039605098
+          442039605098
+        ]
+
+        examples.each do |eg|
+          expect(
+            Helpers::Protocols.extract_mpoa(eg)
+          ).to eq(correct_number)
+        end
+      end
+
+      it 'returns a number from SIP address' do
+        examples = %w[
+          sip:+442039605098@somedomain.com
+          sip:+442039605098@mns-interconnect-test.sip.ie1-ix.twilio.com
+          sip:442039605098@mns-interconnect-test.sip.ie1-ix.twilio.com
+        ]
+
+        examples.each do |eg|
+          expect(
+            Helpers::Protocols.extract_mpoa(eg)
+          ).to eq(correct_number)
+        end
+      end
+    end
+
+    context 'the number cannot be matched' do
+      it 'returns the same string' do
+        str = 'un_matchable'
+
+        expect(
+          Helpers::Protocols.extract_mpoa(str)
+        ).to eq(str)
+      end
+    end
+  end
+end

data/spec/services/twilio_base/api_key_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe TwilioBase::ApiKey do
+  describe '.create' do
+    it 'creates a new api key' do
+      expect { described_class.create }
+        .to change { TwilioBase::Fake::ApiKey.keys.count }.by(1)
+    end
+
+    it 'assigns friendly name to the key' do
+      described_class.create
+
+      expect(TwilioBase::Fake::ApiKey.keys.last.friendly_name)
+        .to eq TwilioBase::ApiKey::FRIENDLY_NAME
+    end
+  end
+end

data/spec/services/twilio_base/application_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec.describe TwilioBase::Application do
+  let(:attributes) do
+    {
+      friendly_name: 'Base Application',
+      sms_url: sms_url,
+      sms_method: 'POST',
+      voice_url: voice_url,
+      voice_method: 'POST'
+    }
+  end
+  let(:sms_url) { 'https://sms_url.com' }
+  let(:voice_url) { 'https://voice_url.com' }
+
+  describe '#create' do
+    it 'creates a new application on Twilio' do
+      expect { described_class.create(attributes) }
+        .to change { TwilioBase::Fake::Application.applications.count }.by(1)
+    end
+
+    it 'assigns correct values to the applcation' do
+      application = described_class.create(attributes)
+      expect(application.friendly_name).to eq 'Base Application'
+      expect(application.sms_url).to eq sms_url
+      expect(application.sms_method).to eq 'POST'
+      expect(application.voice_url).to eq voice_url
+      expect(application.voice_method).to eq 'POST'
+    end
+  end
+end

data/spec/services/twilio_base/phone_number_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+RSpec.describe TwilioBase::PhoneNumber do
+  describe '.find_or_create' do
+    before do
+      ENV['COUNTRY_CODE'] = 'GB'
+    end
+
+    after do
+      ENV['COUNTRY_CODE'] = nil
+    end
+
+    context 'phone number exists' do
+      it 'does not create a new phone number' do
+        number = FactoryBot.generate(:phone_number)
+        phone_number = TwilioBase::Fake::IncomingPhoneNumber
+          .new.create(phone_number: number)
+
+        expect { described_class.find_or_create(phone_number.phone_number) }
+          .not_to(
+            change { TwilioBase::Fake::IncomingPhoneNumber.phone_numbers.count }
+          )
+      end
+
+      it 'returns the phone number' do
+        number = FactoryBot.generate(:phone_number)
+        phone_number = TwilioBase::Fake::IncomingPhoneNumber
+          .new.create(phone_number: number)
+
+        expect(described_class.find_or_create(phone_number.phone_number))
+          .to eq phone_number
+      end
+    end
+
+    context 'phone number does not exist' do
+      it 'does creates a new phone number' do
+        expect { described_class.find_or_create(nil) }
+          .to change {
+            TwilioBase::Fake::IncomingPhoneNumber.phone_numbers.count
+          }.by(1)
+      end
+
+      it 'returns the phone number' do
+        expect(described_class.find_or_create(nil))
+          .to eq TwilioBase::Fake::IncomingPhoneNumber.phone_numbers.last
+      end
+    end
+  end
+end

data/spec/services/twilio_base/protocols/voice/base_spec.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe TwilioBase::Protocols::Voice::Base do
+  describe '#action_url' do
+    it 'returns params[:action_url]' do
+      action_url = 'https://url.com'
+      params = {
+        action_url: action_url
+      }
+      to = '+1234567890'
+      protocol = described_class.new(params: params, to: to)
+
+      expect(protocol.action_url).to eq(action_url)
+    end
+  end
+
+  describe '#action_url_attributes' do
+    it 'returns failover_contact_uri param' do
+      to = '+1234567890'
+      protocol = described_class.new(params: {}, to: to)
+
+      expected_result = { endpoint: to }
+
+      expect(protocol.action_url_attributes).to eq(expected_result)
+    end
+  end
+
+  describe '#caller_uuid' do
+    it 'returns caller uuid param' do
+      caller_uuid = '+447777777777'
+      params = {
+        caller_uuid: caller_uuid
+      }
+      protocol = described_class.new(
+        params: params,
+        to: '+1234567890'
+      )
+
+      caller_uuid = protocol.caller_uuid
+      expect(caller_uuid).to eq(caller_uuid)
+    end
+
+    it 'returns caller uuid param from sip_address' do
+      params = {
+        caller_uuid: 'sip:+447777777777@somedomain.com'
+      }
+      protocol = described_class.new(
+        params: params,
+        to: '+1234567890'
+      )
+
+      caller_uuid = protocol.caller_uuid
+      expect(caller_uuid).to eq('+447777777777')
+    end
+
+    context 'caller uuid is blank' do
+      it 'returns anonymous number' do
+        protocol = described_class.new(
+          params: {},
+          to: '+1234567890'
+        )
+        caller_uuid = protocol.caller_uuid
+
+        expected = TwilioBase::Protocols::Voice::Base::ANONYMOUS_NUMBER
+        expect(caller_uuid).to eq(expected)
+      end
+    end
+  end
+
+  describe '#endpoint' do
+    it 'returns "to" attribute' do
+      to = '+1234567890'
+      protocol = described_class.new(to: to)
+
+      expect(protocol.endpoint).to eq(to)
+    end
+  end
+
+  describe '#name' do
+    it 'returns :number' do
+      protocol = described_class.new(to: '+1234567890')
+
+      expect(protocol.name).to eq(:number)
+    end
+  end
+
+  describe '#status_callback_events' do
+    it 'returns STATUS_CALLBACK_EVENTS' do
+      protocol = described_class.new(to: '+1234567890')
+
+      expected =
+        TwilioBase::Protocols::Voice::Base::STATUS_CALLBACK_EVENTS.join(' ')
+      expect(protocol.status_callback_events).to eq(expected)
+    end
+  end
+
+  describe '#status_callback_url' do
+    it 'returns the status callback url param' do
+      status_callback_url = 'abc.com'
+      params = {
+        status_callback_url: status_callback_url
+      }
+      protocol = described_class.new(to: '+1234567890', params: params)
+
+      expect(protocol.status_callback_url).to eq(status_callback_url)
+    end
+  end
+
+  describe '#timeout' do
+    it 'returns the timeout params' do
+      timeout = 50
+      params = {
+        timeout: timeout
+      }
+      protocol = described_class.new(to: '+1234567890', params: params)
+
+      expect(protocol.timeout).to eq(timeout)
+    end
+  end
+
+  describe '#wait_url' do
+    it 'returns wait_url params' do
+      wait_url = 'http://abc.com'
+      params = {
+        wait_url: wait_url
+      }
+      protocol = described_class.new(to: '+1234567890', params: params)
+
+      expect(protocol.wait_url).to eq(wait_url)
+    end
+  end
+end

data/spec/services/twilio_base/protocols/voice/pstn_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe TwilioBase::Protocols::Voice::Pstn do
+  describe '#name' do
+    it 'returns :number' do
+      pstn = described_class.new(to: '+1234567890')
+
+      expect(pstn.name).to eq(:number)
+    end
+  end
+end

data/spec/services/twilio_base/protocols/voice/sip_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe TwilioBase::Protocols::Voice::Sip do
+  describe 'validations' do
+    context 'to is blank' do
+      it 'raises an error' do
+        expect { described_class.new(to: nil) }
+          .to raise_error('To cannot be blank')
+      end
+    end
+  end
+
+  describe '#endpoint' do
+    it 'returns the endpoint' do
+      endpoint = '53435@test.net'
+      params = {
+        headers: {
+          call_sid: 'CAsid'
+        }
+      }
+      sip = described_class.new(params: params, to: endpoint)
+
+      sip_headers = build_sip_headers(
+        headers: {
+          'X-CallSid' => 'CAsid'
+        }
+      )
+
+      possible_results = build_possible_results(
+        headers: sip_headers,
+        sip_endpoints: endpoint
+      )
+      expect(possible_results).to include(sip.endpoint)
+    end
+
+    context 'to: is an array' do
+      it 'samples the array' do
+        endpoints = %w[53435@test.net 62424@test.net]
+        params = {
+          headers: {
+            call_sid: 'CAsid'
+          }
+        }
+        sip = described_class.new(params: params, to: endpoints)
+
+        sip_headers = build_sip_headers(
+          headers: {
+            'X-CallSid' => 'CAsid'
+          }
+        )
+
+        possible_results = build_possible_results(
+          headers: sip_headers,
+          sip_endpoints: endpoints
+        )
+        expect(possible_results).to include(sip.endpoint)
+      end
+    end
+
+    context 'header has blank value' do
+      it 'returns -' do
+        endpoint = '3000@127.0.0.1'
+        params = {
+          headers: {
+            blank_value: '',
+            call_sid: 'CAsid'
+          }
+        }
+        sip = described_class.new(params: params, to: endpoint)
+
+        expected_result = build_sip_headers(
+          headers: {
+            'X-BlankValue' => '-',
+            'X-CallSid' => 'CAsid'
+          }
+        )
+
+        expect(sip.endpoint).to eq("sip:#{endpoint}?#{expected_result}")
+      end
+    end
+  end
+
+  describe '#name' do
+    it 'returns :sip' do
+      sip = described_class.new(params: {}, to: '+1234567890')
+
+      expect(sip.name).to eq(:sip)
+    end
+  end
+
+  def build_sip_headers(headers: {})
+    Addressable::URI.new(query_values: headers).query
+  end
+
+  def build_possible_results(headers:, sip_endpoints:)
+    sip_endpoints = Array(sip_endpoints)
+
+    sip_endpoints.map do |endpoint|
+      "sip:#{endpoint}?#{headers}"
+    end
+  end
+end

data/spec/services/twilio_base/protocols/voice_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe TwilioBase::Protocols::Voice::Default do
+  describe '.init' do
+    context 'with pstn voice protocol' do
+      before do
+        stub_const('ENV', ENV.to_h.merge('VOICE_PROTOCOL' => 'pstn'))
+      end
+
+      it 'inits Protocols::Voice::Pstn' do
+        allow(TwilioBase::Protocols::Voice::Pstn).to receive(:new)
+
+        described_class.init(protocol: 'pstn', to: '+1234567890')
+
+        expect(TwilioBase::Protocols::Voice::Pstn).to have_received(:new)
+          .with(params: {}, to: '+1234567890')
+      end
+    end
+
+    context 'with sip voice protocol' do
+      before do
+        stub_const('ENV', ENV.to_h.merge('VOICE_PROTOCOL' => 'sip'))
+      end
+
+      it 'inits Protocols::Voice::Sip' do
+        allow(TwilioBase::Protocols::Voice::Sip).to receive(:new)
+
+        described_class.init(to: '+1234567890')
+
+        expect(TwilioBase::Protocols::Voice::Sip).to have_received(:new)
+          .with(params: {}, to: '+1234567890')
+      end
+
+      context 'protocol is passed as a symbol' do
+        it 'inits Protocols::Voice::Sip' do
+          allow(TwilioBase::Protocols::Voice::Sip).to receive(:new)
+
+          described_class.init(protocol: :sip, to: '+1234567890')
+
+          expect(TwilioBase::Protocols::Voice::Sip).to have_received(:new)
+            .with(params: {}, to: '+1234567890')
+        end
+      end
+    end
+  end
+end

data/spec/services/twilio_base/request_verification_service_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+RSpec.describe TwilioBase::RequestVerificationService do
+  describe '#verify' do
+    context 'when signature present' do
+      context 'when post' do
+        it 'validates validator with form hash params' do
+          validator_double = double(
+            'validator',
+            validate: true
+          )
+
+          env = {
+            'REQUEST_METHOD' => 'POST',
+            'HTTP_X_TWILIO_SIGNATURE' => 'twilio_signature',
+            'rack.request.form_hash' => {},
+            'rack.request.query_hash' => ''
+          }
+
+          described_class.new(validator_double).verify(uri: '', env: env)
+
+          expect(validator_double).to have_received(:validate)
+            .with('', {}, 'twilio_signature')
+        end
+
+        it 'returns true' do
+          validator_double = double(
+            'validator',
+            validate: true
+          )
+
+          env = {
+            'REQUEST_METHOD' => 'POST',
+            'HTTP_X_TWILIO_SIGNATURE' => 'twilio_signature',
+            'rack.request.form_hash' => {},
+            'rack.request.query_hash' => ''
+          }
+
+          expect(
+            described_class.new(validator_double).verify(uri: '', env: env)
+          ).to be_truthy
+        end
+      end
+
+      context 'when is not post' do
+        it 'validates validator with query hash params' do
+          validator_double = double(
+            'validator',
+            validate: true
+          )
+
+          env = {
+            'REQUEST_METHOD' => 'PUT',
+            'HTTP_X_TWILIO_SIGNATURE' => 'twilio_signature',
+            'rack.request.form_hash' => {},
+            'rack.request.query_hash' => ''
+          }
+
+          described_class.new(validator_double).verify(uri: '', env: env)
+
+          expect(validator_double).to have_received(:validate)
+            .with('', '', 'twilio_signature')
+        end
+
+        it 'returns true' do
+          validator_double = double(
+            'validator',
+            validate: true
+          )
+
+          env = {
+            'REQUEST_METHOD' => 'PUT',
+            'HTTP_X_TWILIO_SIGNATURE' => 'twilio_signature',
+            'rack.request.form_hash' => {},
+            'rack.request.query_hash' => ''
+          }
+
+          expect(
+            described_class.new(validator_double).verify(uri: '', env: env)
+          ).to be_truthy
+        end
+      end
+    end
+
+    context 'when signature is empty' do
+      it 'returns false' do
+        validator_double = double(
+          'validator',
+          validate: true
+        )
+
+        env = {
+          'REQUEST_METHOD' => 'POST',
+          'HTTP_X_TWILIO_SIGNATURE' => nil,
+          'rack.request.form_hash' => {},
+          'rack.request.query_hash' => ''
+        }
+
+        expect(
+          described_class.new(validator_double).verify(uri: '', env: env)
+        ).to be_falsey
+      end
+    end
+  end
+end

data/spec/services/twilio_base/routers/voice/base_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe TwilioBase::Routers::Voice::DirectDial do
+  include Rails.application.routes.url_helpers
+
+  describe '#route' do
+    context 'protocol is PSTN' do
+      it 'returns dial Twiml' do
+        protocol = TwilioBase::Protocols::Voice::Pstn.new(
+          to: '+1234567890',
+          params: {
+            action_url: 'https://someurl.com',
+            status_callback_url: 'https://somestatusurl.com'
+          }
+        )
+        direct_dial = described_class.new(protocol: protocol)
+
+        expected_result = dial_twiml(
+          params: {
+            action_url: protocol.action_url,
+            caller_id: protocol.caller_uuid,
+            endpoint: protocol.endpoint,
+            protocol: protocol.name,
+            status_callback_events: protocol.status_callback_events,
+            status_callback_url: protocol.status_callback_url
+          }
+        )
+
+        expect(direct_dial.route).to eq(expected_result)
+      end
+
+      context 'with yield block' do
+        it 'returns direct diall Twiml using yield block' do
+          protocol = TwilioBase::Protocols::Voice::Pstn.new(
+            params: {
+              action_url: 'https://someurl.com',
+              status_callback_url: 'https://somestatusurl.com'
+            },
+            to: '+1234567890'
+          )
+          direct_dial = described_class.new(protocol: protocol)
+          voice_response = Twilio::TwiML::VoiceResponse.new
+
+          expected_result = dial_twiml(
+            params: {
+              action_url: protocol.action_url,
+              caller_id: protocol.caller_uuid,
+              endpoint: protocol.endpoint,
+              play_urls: '/audio.wav',
+              protocol: protocol.name,
+              status_callback_events: protocol.status_callback_events,
+              status_callback_url: protocol.status_callback_url
+            }
+          )
+
+          result = direct_dial.route { voice_response.play(url: '/audio.wav') }
+          expect(result).to eq(expected_result)
+        end
+      end
+    end
+
+    context 'protocol is Sip' do
+      it 'returns sip dial Twiml' do
+        protocol = TwilioBase::Protocols::Voice::Sip.new(
+          params: {
+            action_url: 'https://someurl.com',
+            sip_endpoint: '124@abc.net',
+            status_callback_url: 'https://somestatusurl.com'
+          },
+          to: '+442039605098'
+        )
+        direct_dial = described_class.new(protocol: protocol)
+
+        expected_result = dial_twiml(
+          params: {
+            action_url: protocol.action_url,
+            caller_id: protocol.caller_uuid,
+            endpoint: protocol.endpoint,
+            protocol: protocol.name,
+            status_callback_url: protocol.status_callback_url,
+            status_callback_events: protocol.status_callback_events
+          }
+        )
+
+        expect(direct_dial.route).to eq(expected_result)
+      end
+    end
+  end
+end