sms_broker 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed1f6bc1988ca3ab9a96cac009892365ddcf39ef
-  data.tar.gz: c61521552f75df630c6fd9bea3829cc590bffa6f
+  metadata.gz: 6a4b480fcb3af10834e7dcceab54bb7a11a638fa
+  data.tar.gz: c092ef5cc010867c9defb38a62c4597546d057da
 SHA512:
-  metadata.gz: f4b7658d1d99dfa94ef72292f50f813d17ab9e41640c6b351c65b4b71b1a5c2780422923ca00ffe297c44cef357f5a2bb745df944c349edd6e9d3a2dc12b2653
-  data.tar.gz: 8aba81f06d37acbfabb28afd7c4ae3a28b452420c3849b69784573244ee1884c31dfda212c6d583fa3d32a620431f447e48ed57906f68ed870f000dce6bcd4a1
+  metadata.gz: 8572edd992371e259eac5aec974a67b346c6f231fd9ca9965b8f9dfe529837b744fbe3981f3ded4de331b6fa4b75e5c92cd478f372a62718620ecee02a7292ff
+  data.tar.gz: 1d32ba4504a1c751ec8e341a57f945166080116459209aecfb8df1435466e9ddb03b6c66521be5111b8b9e5748af45f68103ddcef79f63960eed2cf588f8aa64

data/lib/sms_broker.rb

@@ -3,6 +3,7 @@ require 'compel'
 require 'twilio-ruby'
 require 'sms_broker/client/response/error'
 require 'sms_broker/client/response/success'
+require 'sms_broker/client/response/voice_success'
 require 'sms_broker/configuration'
 require 'sms_broker/service'
 
@@ -18,4 +19,8 @@ module SmsBroker
   def message(body)
     service.message(body)
   end
+
+  def voice_message(body)
+    service.voice_message(body)
+  end
 end

data/lib/sms_broker/client/nexmo.rb

@@ -21,6 +21,20 @@ module SmsBroker
         end
       end
 
+      def send_voice_message(message)
+        response = client.initiate_tts_call \
+          text: message[:text],
+          from:  message[:from],
+          to: serialize_to_number(message[:to]),
+          lg: message[:lang]
+
+        if voice_success_response?(response)
+          Response::NexmoVoiceSuccess.new(response)
+        else
+          Response::NexmoVoiceError.new(response)
+        end
+      end
+
       private
 
       def success_response?(response)
@@ -28,6 +42,10 @@ module SmsBroker
         # right now only one message per call
         !response['messages'].empty? && response['messages'][0]['status'] == '0'
       end
+
+      def voice_success_response?(response)
+        response['status'] == '0'
+      end
     end
   end
 end

data/lib/sms_broker/client/response/error.rb

@@ -26,3 +26,4 @@ end
 
 require 'sms_broker/client/response/nexmo_error'
 require 'sms_broker/client/response/twilio_error'
+require 'sms_broker/client/response/nexmo_voice_error'

data/lib/sms_broker/client/response/nexmo_voice_error.rb

@@ -0,0 +1,21 @@
+module SmsBroker
+  module Client
+    module Response
+      class NexmoVoiceError < Error
+        def initialize(nexmo_response)
+          super :nexmo, nexmo_response, serialize_error_response(nexmo_response)
+        end
+
+        private
+
+        def serialize_error_response(nexmo_response)
+          errors = {}.tap do |hash|
+            hash[nexmo_response['status']] = nexmo_response['error']
+          end
+
+          errors
+        end
+      end
+    end
+  end
+end

data/lib/sms_broker/client/response/nexmo_voice_success.rb

@@ -0,0 +1,33 @@
+module SmsBroker
+  module Client
+    module Response
+      class NexmoVoiceSuccess < VoiceSuccess
+        def initialize(nexmo_response)
+          super :nexmo, nexmo_response, serialize(nexmo_response)
+        end
+
+        private
+
+        def serialize(response)
+          {
+            call_id: response['call_id'],
+            to: response['to'],
+            raw: response_to_hash(response)
+          }
+        end
+
+        def response_to_hash(response)
+          attributes = %w(
+            call_id to status error_text
+          )
+
+          {}.tap do |hash|
+            attributes.each do |attr|
+              hash[attr.to_sym] = response[attr]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sms_broker/client/response/voice_success.rb

@@ -0,0 +1,31 @@
+module SmsBroker
+  module Client
+    module Response
+      class VoiceSuccess
+        attr_reader :raw,
+                    :service,
+                    :serialized
+
+        def initialize(service, response, serialized)
+          @raw = response
+          @service = service
+          @serialized = serialized
+        end
+
+        def success?
+          true
+        end
+
+        def to
+          serialized[:to]
+        end
+
+        def call_id
+          serialized[:call_id]
+        end
+      end
+    end
+  end
+end
+
+require 'sms_broker/client/response/nexmo_voice_success'

data/lib/sms_broker/client/twilio.rb

@@ -24,6 +24,14 @@ module SmsBroker
         Response::TwilioError.new(exception)
       end
 
+      def send_voice_message(_message)
+        message = 'twillio voice message integration is not implemented'
+        exception = \
+          Exceptions::NotImplemented.new(message)
+
+        raise exception
+      end
+
       private
 
       def success_response?(response)

data/lib/sms_broker/exceptions/not_implemented.rb

@@ -0,0 +1,7 @@
+module SmsBroker
+  module Exceptions
+    class NotImplemented < StandardError
+      attr_accessor :errors
+    end
+  end
+end

data/lib/sms_broker/service.rb

@@ -1,8 +1,10 @@
 require 'sms_broker/message_sender'
+require 'sms_broker/voice_message_sender'
 require 'sms_broker/client/base'
 require 'sms_broker/client/nexmo'
 require 'sms_broker/client/twilio'
 require 'sms_broker/exceptions/invalid_service'
+require 'sms_broker/exceptions/not_implemented'
 
 module SmsBroker
   CLIENTS = {
@@ -40,5 +42,9 @@ module SmsBroker
     def message(message)
       MessageSender.new(client).message(message)
     end
+
+    def voice_message(message) #could have another params like lang
+      VoiceMessageSender.new(client).message(message)
+    end
   end
 end

data/lib/sms_broker/version.rb

@@ -1,3 +1,3 @@
 module SmsBroker
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

data/lib/sms_broker/voice_message_sender.rb

@@ -0,0 +1,90 @@
+module SmsBroker
+  class VoiceMessageSender
+    attr_reader :client,
+                :errors
+
+    def initialize(client)
+      @client = client
+    end
+
+    def to(number)
+      @voice_message_to = number
+
+      self
+    end
+
+    def message(text)
+      @voice_message_text = text
+
+      self
+    end
+
+    def with(options)
+      @voice_message_options = options
+
+      self
+    end
+
+    def deliver
+      unless valid?
+        return Client::Response::Error.new(client.name, errors, errors)
+      end
+
+      response = client.send_voice_message(build_message)
+
+      if should_try_with_phone_number?(response)
+        return client.send_voice_message(build_message(:phone_number))
+      end
+
+      response
+    end
+
+    def valid?
+      options = @voice_message_options || {}
+
+      schema = {
+        message: Compel.string.required.max_length(140),
+        to: Compel.string.required,
+        lang: Compel.string
+      }
+
+      object = {
+        message: @voice_message_text,
+        to: @voice_message_to,
+        lang: options[:lang]
+      }
+
+      result = Compel.hash.keys(schema).validate(object)
+
+      @errors = result.errors
+
+      result.valid?
+    end
+
+    private
+
+    def build_message(from = :sender_id)
+      {
+        text: @voice_message_text,
+        from: get_sender(from),
+        to:   @voice_message_to
+      }.merge!(@voice_message_options || {})
+    end
+
+    def get_sender(from)
+      if client.sender_id && from == :sender_id
+        client.sender_id
+      else
+        return client.phone_number if client.phone_number.start_with?('+')
+
+        "+#{client.phone_number}"
+      end
+    end
+
+    def should_try_with_phone_number?(response)
+      response.is_a?(Client::Response::Error) &&
+        response.invalid_sender_id? &&
+        client.sender_id
+    end
+  end
+end

data/spec/sms_broker/nexmo_voice_spec.rb

@@ -0,0 +1,79 @@
+require 'pry'
+
+describe SmsBroker do
+  context 'Nexmo', :focus do
+    context '#send_message' do
+      let(:voice_message) { 'Hello World' }
+      let(:from_phone) { '+447476543210' }
+      let(:sender_id) { 'SenderID' }
+      let(:lang) { 'en-GB' }
+      let(:to_phone) { '+447491234567' }
+      let(:api_secret) { 'api_secret' }
+      let(:api_key) { 'api_key' }
+
+      before(:each) do
+        SmsBroker.clear_setup
+      end
+
+      context 'valid', :focus do
+        it 'should send voice message with success' do
+          SmsBroker.setup do |config|
+            config.nexmo_setup \
+              phone_number: from_phone,
+              sender_id: sender_id,
+              secret: api_secret,
+              key: api_key
+          end
+
+          stub_nexmo_create_voice_message_success(sender_id, to_phone, voice_message, lang)
+
+          response = SmsBroker
+            .voice_message(voice_message)
+            .to(to_phone)
+            .with(lang: lang)
+            .deliver
+
+          expect(response.service).to eq(:nexmo)
+          expect(response.success?).to eq(true)
+          expect(response.call_id).not_to eq(nil)
+        end
+      end
+
+      context 'invalid' do
+        it 'should return error for invalid credentials' do
+          SmsBroker.setup do |config|
+            config.nexmo_setup \
+              phone_number: from_phone,
+              secret: 'invalid',
+              key: 'invalid'
+          end
+
+          stub_nexmo_create_voice_message_invalid_credentials \
+            from_phone, to_phone, voice_message
+
+          response = SmsBroker.voice_message(voice_message).to(to_phone).deliver
+
+          expect(response.success?).to eq(false)
+          expect(response.serialized.length).to be > 0
+        end
+
+        it 'should return error an unknown error' do
+          SmsBroker.setup do |config|
+            config.nexmo_setup \
+              phone_number: from_phone,
+              secret: api_secret,
+              key: api_key
+          end
+
+          stub_nexmo_create_voice_message_unknown_error \
+            from_phone, to_phone, voice_message
+
+          response = SmsBroker.voice_message(voice_message).to(to_phone).deliver
+
+          expect(response.success?).to eq(false)
+          expect(response.serialized.length).to be > 0
+        end
+      end
+    end
+  end
+end

data/spec/sms_broker/real_call_spec.rb

@@ -1,6 +1,7 @@
 describe SmsBroker do
   context 'SmsBroker' do
     let(:text_message) { 'Hello World' }
+    let(:voice_text_message) { 'This is a voice message test, please ignore' }
 
     context 'Valid real calls' do
       before(:all) do
@@ -47,6 +48,18 @@ describe SmsBroker do
         end
       end
 
+      context 'Nexmo voice call', :real_deal do
+        it 'should successfuly send the voice message' do
+          voice_message = \
+            SmsBroker
+              .service(:nexmo)
+              .voice_message(voice_text_message)
+              .to(ENV['REAL_PHONE_NUMBER'])
+
+          expect(voice_message.deliver.success?).to eq true
+        end
+      end
+
       context 'Twillio' do
         it 'should successfuly send message' do
           message = \

data/spec/support/nexmo_helpers.rb

@@ -13,6 +13,18 @@ module NexmoHelpers
       )
   end
 
+  def stub_nexmo_create_voice_message(request_body, response_body)
+    stub_request(:post, 'https://api.nexmo.com/tts/json')
+      .with(body: request_body)
+      .to_return(
+        status: 200,
+        body: response_body.to_json,
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      )
+  end
+
   def build_request_body(from, to, message)
     {
       to: to,
@@ -23,6 +35,16 @@ module NexmoHelpers
     }
   end
 
+  def build_voice_request_body(from, to, message, lang = nil)
+    {
+      to: to,
+      from: from,
+      text: message,
+      api_key: 'api_key',
+      api_secret: 'api_secret'
+    }.merge(lg: lang)
+  end
+
   def stub_nexmo_create_message_invalid_sender_id_request(sender_id, to, message)
     request_body = build_request_body(sender_id, to, message)
 
@@ -94,4 +116,46 @@ module NexmoHelpers
 
     stub_nexmo_create_message(request_body, response_body)
   end
+
+  def stub_nexmo_create_voice_message_success(from, to, message, lang)
+    request_body = build_voice_request_body(from, to, message, lang)
+
+    response_body = {
+      'call_id': '1',
+      'to': to,
+      'status': '0',
+      'error_text': ''
+    }
+
+    stub_nexmo_create_voice_message(request_body, response_body)
+  end
+
+  def stub_nexmo_create_voice_message_invalid_credentials(from, to, message)
+    request_body = build_voice_request_body(from, to, message)
+    request_body.merge! \
+      api_key: 'invalid',
+      api_secret: 'invalid'
+
+    response_body = {
+      'call_id': '1',
+      'to': to,
+      'status': '4',
+      'error_text': 'Invalid credentials'
+    }
+
+    stub_nexmo_create_voice_message(request_body, response_body)
+  end
+
+  def stub_nexmo_create_voice_message_unknown_error(from, to, message)
+    request_body = build_voice_request_body(from, to, message)
+
+    response_body = {
+      'call_id': '1',
+      'to': to,
+      'status': '5',
+      'error_text': 'An error has occurred in the Nexmo platform while processing this request'
+    }
+
+    stub_nexmo_create_voice_message(request_body, response_body)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_broker
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Streetbees Dev Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexmo
@@ -128,19 +128,25 @@ files:
 - lib/sms_broker/client/response/error.rb
 - lib/sms_broker/client/response/nexmo_error.rb
 - lib/sms_broker/client/response/nexmo_success.rb
+- lib/sms_broker/client/response/nexmo_voice_error.rb
+- lib/sms_broker/client/response/nexmo_voice_success.rb
 - lib/sms_broker/client/response/success.rb
 - lib/sms_broker/client/response/twilio_error.rb
 - lib/sms_broker/client/response/twilio_success.rb
+- lib/sms_broker/client/response/voice_success.rb
 - lib/sms_broker/client/twilio.rb
 - lib/sms_broker/configuration.rb
 - lib/sms_broker/exceptions/invalid_service.rb
 - lib/sms_broker/exceptions/invalid_setup.rb
+- lib/sms_broker/exceptions/not_implemented.rb
 - lib/sms_broker/message_sender.rb
 - lib/sms_broker/service.rb
 - lib/sms_broker/setup.rb
 - lib/sms_broker/version.rb
+- lib/sms_broker/voice_message_sender.rb
 - sms_broker.gemspec
 - spec/sms_broker/nexmo_spec.rb
+- spec/sms_broker/nexmo_voice_spec.rb
 - spec/sms_broker/real_call_spec.rb
 - spec/sms_broker/setup_spec.rb
 - spec/sms_broker/sms_broker_spec.rb
@@ -174,6 +180,7 @@ specification_version: 4
 summary: Sms Broker
 test_files:
 - spec/sms_broker/nexmo_spec.rb
+- spec/sms_broker/nexmo_voice_spec.rb
 - spec/sms_broker/real_call_spec.rb
 - spec/sms_broker/setup_spec.rb
 - spec/sms_broker/sms_broker_spec.rb