signalwire 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5ba44a20acd7bb12393399af0f7457543d60030
-  data.tar.gz: '069bc5cbbe6465918eab2e726d88b2120b5519a8'
+SHA256:
+  metadata.gz: b79e0a17481f2f0fcb5cdf7a1b5860f86565e60826808b3b0c4c671f6797d173
+  data.tar.gz: d798019a441d67cf6d6cdbba6093e13b43353a788465b7333bdf48bf9e0ab969
 SHA512:
-  metadata.gz: b93d4efd4ab92f26fba1934720c1a03b50e17ad5576ea743af02654584170ff702a793fc2b201bb614a9b44d3ae82cd4feffc49de3d5790cd82b6bd88fcc82eb
-  data.tar.gz: 27353d85dd32d496b747c78659badb0c56df081cfdb37d707a6e8acb400d0e17399aecca433237b3a8c3efc633d96b29dd4cce346f8ef52b3b159fda58a1d535
+  metadata.gz: fcadfef6643451bea578ce6a8fd8355307f53704545c6078e0265ed109c03b7c24b196d25c8703416db25a93ca2aa3158bb49818197294493fa01f43922c054d
+  data.tar.gz: 4cf8ec00e2eb43921000836f1f48012f82e05506c44070960c9b2736d8ffefeb32d5331c8ad5dabe7f537f56bd6a949ef3ab9a70668a3ab8532789dfd4323075

data/CHANGELOG.md

@@ -3,6 +3,18 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [2.1.3] - 2019-08-20
+### Fixed
+- Restore the correct parameter for the REST client space URL
+- Correctly handle reconnect on a server-side disconnect
+- Fix REST pagination URL
+### Changed
+- SDK now uses `signalwire.receive` to set up contexts
+- The `call.*` actions are now `calling.*`
+- Support positional parameters in older methods
+
 ## [2.1.2] - 2019-08-01
 ### Fixed
 - Fix CPU usage

data/examples/relay/inbound_consumer.rb

@@ -17,7 +17,7 @@ class MyConsumer < Signalwire::Relay::Consumer
 
   def on_incoming_call(call)
     call.answer
-    call.play_tts 'the quick brown fox jumps over the lazy dog'
+    call.play_tts text: 'the quick brown fox jumps over the lazy dog'
 
     call.hangup
   end

data/examples/relay/inbound_dial.rb

@@ -18,7 +18,7 @@ class MyConsumer < Signalwire::Relay::Consumer
 
   def on_incoming_call(call)
     call.answer
-    call.play_tts 'connecting you to the clock service'
+    call.play_tts text: 'connecting you to the clock service'
     call.connect [[{ type: 'phone', params: { to_number: '+12027621401', from_number: ENV['FROM_NUMBER'], timeout: 30 } }]]
     sleep 20
     call.hangup

data/examples/relay/outbound_collect.rb

@@ -13,9 +13,9 @@ class OutboundConsumer < Signalwire::Relay::Consumer
   def ready
     dial_result = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER']).dial
     collect_params = { "initial_timeout": 10.0, "digits": { "max": 1, "digit_timeout": 5.0 } }
-    result = dial_result.call.prompt_tts( collect_params, 'how many hamburgers would you like to order?')
+    result = dial_result.call.prompt_tts collect: collect_params, text: 'how many hamburgers would you like to order?')
 
-    dial_result.call.play_tts "You ordered #{result.result} hamburgers. Thank you!"
+    dial_result.call.play_tts text: "You ordered #{result.result} hamburgers. Thank you!"
     dial_result.call.hangup
   # this makes it so the errors don't stop the process
   rescue StandardError => e

data/examples/relay/outbound_consumer.rb

@@ -14,7 +14,7 @@ class OutboundConsumer < Signalwire::Relay::Consumer
     logger.info 'Dialing out'
     call = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER'])
     call.dial
-    call.play_tts 'the quick brown fox jumps over the lazy dog', 'en-US', 'male'
+    call.play_tts text: 'the quick brown fox jumps over the lazy dog', language: 'en-US', gender: 'male'
     call.hangup
   end
 end

data/examples/relay/outbound_record.rb

@@ -14,9 +14,9 @@ class OutboundConsumer < Signalwire::Relay::Consumer
     logger.info 'Dialing out'
     call = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER'])
     call.dial
-    call.play_tts 'please leave your message after the beep. Press pound when done.'
+    call.play_tts text: 'please leave your message after the beep. Press pound when done.'
     result = call.record({"audio": { "beep": "true", "terminators": "#"}})
-    call.play_tts 'you said:'
+    call.play_tts text: 'you said:'
     call.play_audio result.url
     call.hangup
   end

data/examples/relay/wait_for_ending.rb

@@ -12,14 +12,14 @@ class MyConsumer < Signalwire::Relay::Consumer
   contexts ['incoming']
   def on_incoming_call(call)
     call.answer
-    call.play_tts 'Welcome to Relay'
+    call.play_tts text: 'Welcome to Relay'
     dial = call.connect [[{ type: 'phone', params: { to_number: MY_NUMBER, from_number: call.from, timeout: 30 } }]]
     pp "Connected"
     pp dial.successful
-    dial.call.play_tts "Hello!" if dial.successful
+    dial.call.play_tts(text: "Hello!") if dial.successful
     pp "Waiting on Ending"
     dial.call.wait_for_ending
-    call.play_tts 'finished. hanging up.'
+    call.play_tts text: 'finished. hanging up.'
     call.hangup
   rescue StandardError => e
     logger.error e.inspect

data/lib/signalwire/blade/connection.rb

@@ -37,9 +37,9 @@ module Signalwire::Blade
     end
 
     def reconnect!
+      @connected = false
       return if @shutdown
       sleep Signalwire::Blade::RECONNECT_PERIOD
-      @connected = false
       logger.info "Attempting reconnection"
       main_loop!
     end
@@ -66,20 +66,22 @@ module Signalwire::Blade
 
     def setup_started_event
       on :started do |_event|
-        @connected = true
-        myreq = connect_request
-        start_periodic_timer
-
-        write_command(myreq) do |event|
-          @session_id = event.dig(:result, :sessionid) unless @session_id
-          @node_id = event.dig(:result, :nodeid) unless @node_d
-          logger.info "Blade Session connected with id: #{@session_id}"
-          broadcast :connected, event
+        begin
+          @connected = true
+          myreq = connect_request
+          start_periodic_timer
+
+          write_command(myreq) do |event|
+            @session_id = event.dig(:result, :sessionid) unless @session_id
+            @node_id = event.dig(:result, :nodeid) unless @node_d
+            logger.info "Blade Session connected with id: #{@session_id}"
+            broadcast :connected, event
+          end
+
+        rescue StandardError => e
+          logger.error e.inspect
+          logger.error e.backtrace
         end
-
-      rescue StandardError => e
-        logger.error e.inspect
-        logger.error e.backtrace
       end
     end
 
@@ -107,10 +109,20 @@ module Signalwire::Blade
     end
 
     def write_command(command, &block)
-      once(:message, id: command.id, &block) if block_given?
+      if block_given?
+        once :message, id: command.id do |event|
+          handle_execute_response(event, &block)
+        end
+      end
+
       transmit(command.build_request.to_json)
     end
 
+    def handle_execute_response(event, &block)
+      logger.error("Blade error occurred, code #{event.error_code}: #{event.error_message}") if event.error?
+      block.call(event)
+    end
+
     def execute(params, &block)
       block_given? ? write_command(Execute.new(params), &block) : write_command(Execute.new(params))
     end
@@ -163,11 +175,13 @@ module Signalwire::Blade
           # reconnect logic goes here
           logger.error "We got disconnected!"
           pinger.cancel
-          reconnect!
+          reconnect! if connected?
         end
-    
-        @ws.ping 'detecting presence' do
-          timeouter.cancel
+        
+        if @connected
+          @ws.ping 'detecting presence' do
+            timeouter.cancel
+          end
         end
       end
     end

data/lib/signalwire/blade/message.rb

@@ -34,5 +34,17 @@ module Signalwire::Blade
     def to_s
       inspect
     end
+
+    def error?
+      @payload.has_key?(:error)
+    end
+
+    def error_code
+      @payload.dig(:error, :code)
+    end
+
+    def error_message
+      @payload.dig(:error, :message)
+    end
   end
 end

data/lib/signalwire/relay/calling/call.rb

@@ -117,16 +117,20 @@ module Signalwire::Relay::Calling
       PlayAction.new(component: play_component)
     end
 
-    def prompt(collect_object, play_object)
-      component = Prompt.new(call: self, collect: collect_object, play: play_object)
+    def prompt(collect_p = nil, play_p = nil, collect: nil, play: nil)
+      set_parameters(binding, %i{collect play}, %i{collect play})
+
+      component = Prompt.new(call: self, collect: collect, play: play)
       component.wait_for(Relay::CallPromptState::ERROR, Relay::CallPromptState::NO_INPUT, 
                          Relay::CallPromptState::NO_MATCH, Relay::CallPromptState::DIGIT,
                          Relay::CallPromptState::SPEECH)
       PromptResult.new(component: component)
     end
 
-    def prompt!(collect_object, play_object)
-      component = Prompt,new(call: self, collect: collect_object, play: play_object)
+    def prompt!(collect_p = nil, play_p = nil, collect: nil, play: nil)
+      set_parameters(binding, %i{collect play}, %i{collect play})
+
+      component = Prompt,new(call: self, collect: collect, play: play)
       component.execute
       PromptAction.new(component: component)
     end
@@ -247,5 +251,14 @@ module Signalwire::Relay::Calling
       @busy = false
       @failed = false
     end
+
+    def set_parameters(passed_binding, keys, mandatory_keys)
+      keys.each do |x| 
+        passed_binding.local_variable_set(x, passed_binding.local_variable_get(x) || passed_binding.local_variable_get("#{x}_p"))
+      end
+      mandatory_keys.each do |x|
+        raise ArgumentError if passed_binding.local_variable_get(x).nil?
+      end
+    end
   end
 end

data/lib/signalwire/relay/calling/call_convenience_methods.rb

@@ -16,36 +16,50 @@ module Signalwire::Relay::Calling
       play! silence_payload(duration)
     end
 
-    def play_tts(sentence, language='en-US', gender='female')
-      play tts_payload(sentence, language, gender)
+    def play_tts(text_p=nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, text: nil, language: Relay::DEFAULT_LANGUAGE, gender: Relay::DEFAULT_GENDER)
+      set_parameters(binding, %i{text language gender}, %i{text})
+
+      play tts_payload(text, language, gender)
     end
 
-    def play_tts!(sentence, language='en-US', gender='female')
-      play! tts_payload(sentence, language, gender)
+    def play_tts!(text_p=nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, text: nil, language: Relay::DEFAULT_LANGUAGE, gender: Relay::DEFAULT_GENDER)
+      set_parameters(binding, %i{text language gender}, %i{text})
+      play! tts_payload(text, language, gender)
     end
 
-    def prompt_audio(collect, url)
+    def prompt_audio(collect_p = nil, url_p = nil, collect: nil, url: nil)
+      set_parameters(binding, %i{collect url}, %i{collect url})
+
       prompt(collect, audio_payload(url))
     end
 
-    def prompt_audio!(collect, url)
+    def prompt_audio!(collect_p = nil, url_p = nil, collect: nil, url: nil)
+      set_parameters(binding, %i{collect url}, %i{collect url})
+
       prompt!(collect, audio_payload(url))
     end
 
-    def prompt_silence(collect, duration)
+    def prompt_silence(collect_p = nil, duration_p = nil, collect: nil, duration: nil)
+      set_parameters(binding, %i{collect duration}, %i{collect duration})
+
       prompt(collect, silence_payload(duration))
     end
 
-    def prompt_silence!(collect, url)
+    def prompt_silence!(collect_p = nil, duration_p = nil, collect: nil, duration: nil)
+      set_parameters(binding, %i{collect duration}, %i{collect duration})
+
       prompt!(collect, silence_payload(duration))
     end
 
-    def prompt_tts(collect, sentence, language='en-US', gender='female')
-      prompt(collect, tts_payload(sentence, language, gender))
+    def prompt_tts(collect_p = nil, text_p = nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, collect: nil, text: nil, language: Relay::DEFAULT_LANGUAGE, gender: Relay::DEFAULT_GENDER)
+      set_parameters(binding, %i{collect text language gender}, %i{collect text})
+      prompt(collect, tts_payload(text, language, gender))
     end
 
-    def prompt_tts!(collect, sentence, language='en-US', gender='female')
-      prompt!(collect, tts_payload(sentence, language, gender))
+    def prompt_tts!(collect_p = nil, text_p = nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, collect: nil, text: nil, language: Relay::DEFAULT_LANGUAGE, gender: Relay::DEFAULT_GENDER)
+      set_parameters(binding, %i{collect text language gender}, %i{collect text})
+
+      prompt!(collect, tts_payload(text, language, gender))
     end
 
     def wait_for_ringing
@@ -64,6 +78,8 @@ module Signalwire::Relay::Calling
       wait_for(Relay::CallState::ENDED)
     end
 
+    private 
+
     def audio_payload(url)
       [{ type: "audio", params: { url: url } }]
     end
@@ -72,8 +88,8 @@ module Signalwire::Relay::Calling
       [{ type: "silence", params: { duration: duration } }]
     end
 
-    def tts_payload(sentence, language='en-US', gender='male')
-      [{ "type": 'tts', "params": { "text": sentence, "language": language, "gender": gender } }]
+    def tts_payload(text, language=Relay::DEFAULT_LANGUAGE, gender=Relay::DEFAULT_GENDER)
+      [{ "type": 'tts', "params": { "text": text, "language": language, "gender": gender } }]
     end
   end
 end

data/lib/signalwire/relay/client.rb

@@ -79,7 +79,7 @@ module Signalwire::Relay
           block.call(event, success) if block_given?
           logger.error "Relay command failed with code #{code} and message: #{message}" unless success
         else
-          logger.error 'Unknown Relay command failure, result code not found'
+          logger.error("Relay error occurred, code #{event.error_code}: #{event.error_message}") if event.error?
           block.call(event, :failure) if block_given?
         end
       else
@@ -100,7 +100,7 @@ module Signalwire::Relay
       return if contexts.include?(context)
       receive_command = {
         protocol: @protocol,
-        method: 'call.receive',
+        method: 'signalwire.receive',
         params: {
           context: context
         }
@@ -121,7 +121,11 @@ module Signalwire::Relay
       @session.on :connected do |event|
         logger.debug 'Relay client connected'
         broadcast :connecting, event
-        protocol_setup
+        if event.error?
+          logger.error("Error setting up Blade connection")
+        else
+          protocol_setup
+        end
       end
     end
 
@@ -149,6 +153,7 @@ module Signalwire::Relay
         @session.subscribe(notification_request) do
           logger.debug "Subscribed to notifications for #{protocol}"
           @connected = true
+          @contexts = Concurrent::Array.new
           broadcast :ready, self
         end
       end

data/lib/signalwire/relay/constants.rb

@@ -5,6 +5,8 @@ module Signalwire::Relay
   COMMAND_TIMEOUT = 30
   DEFAULT_CALL_TIMEOUT = 30
   PING_TIMEOUT = 5
+  DEFAULT_LANGUAGE = 'en-US'
+  DEFAULT_GENDER = 'female'
 
   module CallState
     NONE = 'none'
@@ -104,17 +106,17 @@ module Signalwire::Relay
   end
 
   module ComponentMethod
-    ANSWER = 'call.answer'
-    CONNECT = 'call.connect'
-    DIAL = 'call.begin' # BEGIN is a reserved word
-    HANGUP = 'call.end' # END is a reserved word
-    PLAY = 'call.play'
-    PROMPT = 'call.play_and_collect'
-    RECORD = 'call.record'
-    SEND_FAX = 'call.send_fax'
-    RECEIVE_FAX = 'call.receive_fax'
-    TAP = 'call.tap'
-    DETECT = 'call.detect'
+    ANSWER = 'calling.answer'
+    CONNECT = 'calling.connect'
+    DIAL = 'calling.begin' # BEGIN is a reserved word
+    HANGUP = 'calling.end' # END is a reserved word
+    PLAY = 'calling.play'
+    PROMPT = 'calling.play_and_collect'
+    RECORD = 'calling.record'
+    SEND_FAX = 'calling.send_fax'
+    RECEIVE_FAX = 'calling.receive_fax'
+    TAP = 'calling.tap'
+    DETECT = 'calling.detect'
   end
 
   module CommonState

data/lib/signalwire/relay/consumer.rb

@@ -47,6 +47,11 @@ module Signalwire::Relay
     def run
       logger.info "Starting up #{self.class}"
       setup
+      
+      client.on :ready do
+        setup_contexts
+      end
+
       client.once :ready do
         setup_receive_listeners
         setup_all_events_listener
@@ -70,13 +75,19 @@ module Signalwire::Relay
   private
 
     def setup_receive_listeners
-      self.class.contexts.each do |cxt|
-        client.calling.receive context: cxt do |call|
+      self.class.contexts.each do |ctx|
+        client.calling.receive context: ctx do |call|
           on_incoming_call(call)
         end
       end
     end
 
+    def setup_contexts
+      self.class.contexts.each do |ctx|
+        @client.setup_context(ctx)
+      end
+    end
+
     def setup_task_listeners
       client.on :task do |task|
         on_task(task)

data/lib/signalwire/rest/client.rb

@@ -3,7 +3,7 @@
 module Signalwire::REST
   class Client < Twilio::REST::Client
     def initialize(username = nil, password = nil, account_sid = nil, region = nil, http_client = Twilio::HTTP::Client.new, **args)
-      host = args.delete(:SIGNALWIRE_HOST)
+      host = args.delete(:signalwire_space_url)
 
       unless host.nil?
         Signalwire::Sdk.configure do |config|

data/lib/signalwire/sdk/twilio_set_fax.rb

@@ -12,7 +12,7 @@ module Twilio
                       'SignalWire Space URL is not configured. Enter your SignalWire Space domain via the '\
                       'SIGNALWIRE_HOST environment variable, or hostname in the configuration.')
 
-        @base_url = "https://#{@host}/api/laml"
+        @base_url = "https://#{@host}"
         @port = 443
 
         # Versions

data/lib/signalwire/sdk/twilio_set_host.rb

@@ -14,7 +14,7 @@ module Twilio
                       'SIGNALWIRE_HOST or SIGNALWIRE_API_HOSTNAME environment variables, '\
                       'or hostname in the configuration.')
 
-        @base_url = "https://#{@host}/api/laml"
+        @base_url = "https://#{@host}"
         @port = 443
 
         # Versions

data/lib/signalwire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Signalwire
-  VERSION = '2.1.2'
+  VERSION = '2.1.3'
 end

data/signalwire.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'bundler-audit', '~> 0.6.1'
   spec.add_development_dependency 'guard-rspec', '~> 4.7.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalwire
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - SignalWire Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -350,15 +350,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for Signalwire