signalwire 2.2.0 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325c0f2a81d0a8486fdb356dc91c78284228b30440129ee2a60c3332b1e725b5
-  data.tar.gz: 1f5f8d9227de1b684f05e88d6b1b53246de7f29479c0e11cef94cd792dc8171c
+  metadata.gz: d31f18c614ab0890b0c3000c45f607b636c8c3a3b7ad51d1e9dffae4c3b30165
+  data.tar.gz: 6ef1eeb8106c935d12beb8edafb67004d14c012761c43c675a9ce4d430c794d6
 SHA512:
-  metadata.gz: 6362ec6503c1a04505f72b13edfbb29c2bb7ca4002f7e13fd7926099dbac08142254d0a41447c96f2b44a54639fdfb367d12ab710c6a6e628c39143a823e9028
-  data.tar.gz: e8dce6ff15120bc77452aa97667a0aa468d923cd744e0e4ec15c74db0100424b321e9d86438710750d1cb4285f04db4aa3ab1f09f5e93352a2ebfa7c59874edd
+  metadata.gz: 4535d5d33d7d8152ffd349d0fbeb4cb544fc71931fb72f93c2c866eda4957249ace7b5337472193ebd58f0f6a987f546a226edc97618fb8bef03652162b534db
+  data.tar.gz: 6887060feada342534a3b4a365eb058e93276aa50ecd8e88456d1b4495e6aee7aa47be22e26adc22dfb292e24a0291ffe3376e06b6359d27fa6d0aaffeaba457

data/.drone.yml

@@ -3,8 +3,9 @@ name: default
 
 steps:
 - name: test
-  image: ruby:2.5
+  image: ruby:2.6
   commands:
+  - gem install bundler
   - bundle install --jobs=3 --retry=3
   - bundle exec rspec
 

data/CHANGELOG.md

@@ -3,7 +3,37 @@ 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]
+ ## [Unreleased]
+
+## [2.3.4] - 2020-09-09
+### Fixed
+- Correctly ignore non-call events and clear handlers on call end
+- Async method arguments fixed
+- Fix ping race condition
+
+## [2.3.3] - 2020-03-09
+### Fixed
+- `record` correctly set up for terminators now.
+- Make AMD more usable and less complex.
+- AMD now returns immediately in `wait_for_beep` mode if it detects a human.
+-  Relax `gemspec` dependencies.
+
+## [2.3.2] - 2020-01-29
+### Fixed
+- Correctly return AMD result in Relay.
+
+## [2.3.1] - 2019-12-20
+### Changed
+- Keepalive now uses `blade.ping`.
+
+## [2.3.0] - 2019-10-22
+### Added
+- Add `pause` and `resume` on `PlayAction`.
+- Add `volume` optional parameter to `play` and `prompt` methods
+- Add `volume` method to `Play` and `Prompt` components
+- Add `play_ringtone` and `play_ringtone!` for ringback.
+- Add `prompt_ringtone` and `prompt_ringtone!` for ringback on a prompt.
+- Added `ringback` parameter to the `connect` and `connect!` methods.
 
 ## [2.2.0] - 2019-09-09
 ### Added

data/examples/relay/outbound_amd.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Set logging to debug for testing
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class OutboundConsumer < Signalwire::Relay::Consumer
+  def ready
+    logger.info 'Dialing out'
+    call = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER'])
+    call.dial
+    result = call.amd(timeout: 10, wait_for_beep: true)
+    pp "---------------------------------- Detect AM result was:"
+    pp result.type
+    pp result.result
+    pp result.successful
+
+    call.hangup
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/outbound_collect_speech.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Set logging to debug for testing
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class OutboundConsumer < Signalwire::Relay::Consumer
+  def ready
+    dial_result = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER']).dial
+    tts = [{ type: 'tts', params: { text: 'Say something funny!' } }]
+    result = dial_result.call.prompt collect: {speech: {language: 'en-US'}}, play: tts
+    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
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/outbound_record.rb

@@ -16,6 +16,7 @@ class OutboundConsumer < Signalwire::Relay::Consumer
     call.dial
     call.play_tts text: 'please leave your message after the beep. Press pound when done.'
     result = call.record(beep: true, terminators: "#")
+    sleep 1 # wait for recording to be uploaded
     call.play_tts text: 'you said:'
     call.play_audio result.url
     call.hangup

data/lib/signalwire.rb

@@ -3,6 +3,7 @@
 module Signalwire
 end
 
+require 'signalwire/version'
 require 'signalwire/sdk'
 require 'signalwire/logger'
 require 'signalwire/common'

data/lib/signalwire/blade.rb

@@ -9,4 +9,5 @@ require 'signalwire/blade/connection'
 require 'signalwire/blade/message'
 require 'signalwire/blade/message/connect'
 require 'signalwire/blade/message/execute'
+require 'signalwire/blade/message/ping'
 require 'signalwire/blade/message/subscribe'

data/lib/signalwire/blade/connection.rb

@@ -4,6 +4,7 @@ require 'has_guarded_handlers'
 require 'eventmachine'
 require 'faye/websocket'
 require 'json'
+require 'concurrent-ruby'
 
 module Signalwire::Blade
   class Connection
@@ -22,9 +23,15 @@ module Signalwire::Blade
       @log_traffic = options.fetch(:log_traffic, true)
       @authentication = options.fetch(:authentication, nil)
 
+      
+
       @inbound_queue = EM::Queue.new
       @outbound_queue = EM::Queue.new
 
+      @pong = Concurrent::AtomicBoolean.new
+      @keep_alive_timer = nil
+      @ping_is_sent = Concurrent::AtomicBoolean.new
+
       @shutdown_list = []
     end
 
@@ -37,7 +44,7 @@ module Signalwire::Blade
     end
 
     def reconnect!
-      @connected = false
+      clear_connections
       return if @shutdown
       sleep Signalwire::Blade::RECONNECT_PERIOD
       logger.info "Attempting reconnection"
@@ -46,6 +53,7 @@ module Signalwire::Blade
 
     def main_loop!
       EM.run do
+        logger.info "CREATING SOCKET"
         @ws = Faye::WebSocket::Client.new(@url)
 
         @ws.on(:open) { |event| broadcast :started, event }
@@ -69,13 +77,14 @@ module Signalwire::Blade
         begin
           @connected = true
           myreq = connect_request
-          start_periodic_timer
+          @pong.make_false
 
           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
+            keep_alive
           end
 
         rescue StandardError => e
@@ -127,18 +136,29 @@ module Signalwire::Blade
       block_given? ? write_command(Execute.new(params), &block) : write_command(Execute.new(params))
     end
 
+    def ping(&block)
+      ping_cmd = Ping.new
+      block_given? ? write_command(ping_cmd, &block) : write_command(ping_cmd)
+      ping_cmd
+    end
+
     def subscribe(params, &block)
       block_given? ? write_command(Subscribe.new(params), &block) : write_command(Subscribe.new(params))
     end
 
     def handle_close
+      logger.warn "WS Socket closed!"
       reconnect!
     end
 
-    def disconnect!
-      # logger.info 'Stopping Blade event loop'
+    def clear_connections
       @ws = nil
       @connected = false
+      @keep_alive_timer.cancel if @keep_alive_timer
+    end
+
+    def disconnect!
+      clear_connections
       EM.stop
     end
 
@@ -169,20 +189,22 @@ module Signalwire::Blade
       @connected == true
     end
 
-    def start_periodic_timer
-      pinger = EventMachine::PeriodicTimer.new(Signalwire::Relay::PING_TIMEOUT) do
-        timeouter = EventMachine::Timer.new(2) do
-          # reconnect logic goes here
-          logger.error "We got disconnected!"
-          pinger.cancel
-          reconnect! if connected?
+    def keep_alive
+      if @ping_is_sent.false?
+        ping do
+          @pong.make_true
         end
-        
-        if @connected
-          @ws.ping 'detecting presence' do
-            timeouter.cancel
-          end
+        @ping_is_sent.make_true
+      else
+        if @pong.false?
+          logger.error "KEEPALIVE: Ping failed"
+          reconnect! if connected?
         end
+        @ping_is_sent.make_false
+      end
+
+      @keep_alive_timer = EventMachine::Timer.new(Signalwire::Relay::PING_TIMEOUT) do
+        keep_alive
       end
     end
 

data/lib/signalwire/blade/message/connect.rb

@@ -10,7 +10,8 @@ module Signalwire::Blade
             major: 2,
             minor: 1,
             revision: 0
-          }
+          },
+          agent: "Ruby SDK/#{Signalwire::VERSION}"
         }
       }
     end

data/lib/signalwire/blade/message/ping.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Signalwire::Blade
+    class Ping < Message
+      # Creates a Ping message
+      #
+
+      def initialize
+        @payload = {
+          method: 'blade.ping',
+          params: {}
+        }
+      end
+    end
+  end
+  

data/lib/signalwire/relay.rb

@@ -28,17 +28,24 @@ require 'signalwire/relay/calling/action/send_digits_action'
 
 require 'signalwire/relay/calling/result'
 require 'signalwire/relay/calling/result/answer_result'
+require 'signalwire/relay/calling/result/base_action_result'
 require 'signalwire/relay/calling/result/connect_result'
 require 'signalwire/relay/calling/result/detect_result'
 require 'signalwire/relay/calling/result/dial_result'
 require 'signalwire/relay/calling/result/hangup_result'
 require 'signalwire/relay/calling/result/play_result'
+require 'signalwire/relay/calling/result/play_pause_result'
+require 'signalwire/relay/calling/result/play_resume_result'
+require 'signalwire/relay/calling/result/play_volume_result'
 require 'signalwire/relay/calling/result/prompt_result'
+require 'signalwire/relay/calling/result/prompt_volume_result'
 require 'signalwire/relay/calling/result/record_result'
 require 'signalwire/relay/calling/result/fax_result'
 require 'signalwire/relay/calling/result/tap_result'
 require 'signalwire/relay/calling/result/send_digits_result'
 
+require 'signalwire/relay/calling/result/stop_result'
+
 require 'signalwire/relay/calling/component'
 require 'signalwire/relay/calling/control_component'
 require 'signalwire/relay/calling/component/answer'

data/lib/signalwire/relay/calling/action/connect_action.rb

@@ -5,7 +5,7 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class ConnectAction < Action
     def result
-      ConnectResult.new(@component)
+      ConnectResult.new(component: @component)
     end
   end
 end

data/lib/signalwire/relay/calling/action/detect_action.rb

@@ -5,7 +5,7 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class DetectAction < Action
     def result
-      DetectResult.new(@component)
+      DetectResult.new(component: @component)
     end
 
     def stop

data/lib/signalwire/relay/calling/action/fax_action.rb

@@ -5,7 +5,7 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class FaxAction < Action
     def result
-      FaxResult.new(@component)
+      FaxResult.new(component: @component)
     end
 
     def stop

data/lib/signalwire/relay/calling/action/play_action.rb

@@ -5,11 +5,23 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class PlayAction < Action
     def result
-      PlayResult.new(@component)
+      PlayResult.new(component: @component)
     end
 
     def stop
       @component.stop
     end
+
+    def pause
+      @component.pause
+    end
+
+    def resume
+      @component.resume
+    end
+
+    def volume(setting)
+      @component.volume setting
+    end
   end
 end

data/lib/signalwire/relay/calling/action/prompt_action.rb

@@ -5,11 +5,15 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class PromptAction < Action
     def result
-      PromptResult.new(@component)
+      PromptResult.new(component: @component)
     end
 
     def stop
       @component.stop
     end
+
+    def volume(setting)
+      @component.volume setting
+    end
   end
 end

data/lib/signalwire/relay/calling/action/record_action.rb

@@ -5,11 +5,15 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class RecordAction < Action
     def result
-      RecordResult.new(@component)
+      RecordResult.new(component: @component)
     end
 
     def stop
       @component.stop
     end
+
+    def url
+      @component.url
+    end
   end
 end

data/lib/signalwire/relay/calling/action/send_digits_action.rb

@@ -5,7 +5,7 @@ require 'forwardable'
 module Signalwire::Relay::Calling
   class SendDigitsAction < Action
     def result
-      SendDigitsResult.new(@component)
+      SendDigitsResult.new(component: @component)
     end
   end
 end

data/lib/signalwire/relay/calling/action/tap_action.rb

@@ -7,7 +7,7 @@ module Signalwire::Relay::Calling
     def_delegators :@component, :source_device
 
     def result
-      TapResult.new(@component)
+      TapResult.new(component: @component)
     end
 
     def stop

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

@@ -45,7 +45,7 @@ module Signalwire::Relay::Calling
     end
 
     def setup_call_event_handlers
-      @client.on(:event, proc { |evt| call_match_event(evt) }) do |event|
+      @call_event_handler = @client.on(:event, proc { |evt| call_match_event(evt) }) do |event|
         case event.event_type
         when 'calling.call.connect'
           change_connect_state(event.call_params[:connect_state])
@@ -81,7 +81,8 @@ module Signalwire::Relay::Calling
     end
 
     def call_match_event(event)
-      event.event_type.match(/calling\.call/) &&
+      event.event_type &&
+        event.event_type.match(/calling\.call/) &&
         !event.event_type.match(/receive/) &&
         (event.call_id == id || event.call_params[:tag] == tag)
     end
@@ -112,50 +113,64 @@ module Signalwire::Relay::Calling
       AnswerResult.new(component: answer_component)
     end
 
-    def play(play_object)
-      play_component = Signalwire::Relay::Calling::Play.new(call: self, play: play_object)
+    def play(play_p = nil, volume_p = nil, **args)
+      play = args.delete(:play)
+      volume = args.delete(:volume)
+      set_parameters(binding, %i{play volume}, %i{play})
+
+      play_component = Signalwire::Relay::Calling::Play.new(call: self, play: play, volume: volume)
       play_component.wait_for(Relay::CallPlayState::FINISHED, Relay::CallPlayState::ERROR)
       PlayResult.new(component: play_component)
     end
 
-    def play!(play_object)
-      play_component = Signalwire::Relay::Calling::Play.new(call: self, play: play_object)
+    def play!(play_p = nil, volume_p = nil, **args)
+      play = args.delete(:play)
+      volume = args.delete(:volume)
+      set_parameters(binding, %i{play volume}, %i{play})
+
+      play_component = Signalwire::Relay::Calling::Play.new(call: self, play: play, volume: volume)
       play_component.execute
       PlayAction.new(component: play_component)
     end
 
-    def prompt(collect_p = nil, play_p = nil, **args)
-
+    def prompt(collect_p = nil, play_p = nil, volume_p = nil, **args)
       collect = args.delete(:collect)
       play = args.delete(:play)
+      volume = args.delete(:volume)
 
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
       set_parameters(binding, %i{collect play}, %i{collect play})
 
-      component = Prompt.new(call: self, collect: collect, play: play)
+      component = Prompt.new(call: self, collect: collect, play: play, volume: volume)
       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_p = nil, play_p = nil, **args)
+    def prompt!(collect_p = nil, play_p = nil, volume_p = nil, **args)
+      collect = args.delete(:collect)
+      play = args.delete(:play)
+      volume = args.delete(:volume)
+
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
       set_parameters(binding, %i{collect play}, %i{collect play})
 
-      component = Prompt,new(call: self, collect: collect, play: play)
+      component = Prompt.new(call: self, collect: collect, play: play, volume: volume)
       component.execute
       PromptAction.new(component: component)
     end
 
-    def connect(devices_object)
-      component = Connect.new(call: self, devices: devices_object)
+    def connect(devices_p = nil, ringback_p = nil, devices: nil, ringback: nil)
+      set_parameters(binding, %i{devices ringback}, %i{devices})
+      component = ringback.nil?  ? Connect.new(call: self, devices: devices) : Connect.new(call: self, devices: devices, ringback: ringback)
       component.wait_for(Relay::CallConnectState::CONNECTED, Relay::CallConnectState::FAILED)
       ConnectResult.new(component: component)
     end
 
-    def connect!(devices_object)
-      component = Connect.new(call: self, devices: devices_object)
+    def connect!(devices_p = nil, ringback_p = nil, devices: nil, ringback: nil)
+      set_parameters(binding, %i{devices ringback}, %i{devices})
+      component = ringback.nil?  ? Connect.new(call: self, devices: devices) : Connect.new(call: self, devices: devices, ringback: ringback)
       component.execute
       ConnectAction.new(component: component)
     end
@@ -302,6 +317,7 @@ module Signalwire::Relay::Calling
     end
 
     def finish_call(params)
+      @client.unregister_handler(:event, @call_event_handler)
       terminate_components(params)
       client.calling.end_call(id)
       @busy = true if params[:reason] == Relay::DisconnectReason::BUSY
@@ -375,7 +391,7 @@ module Signalwire::Relay::Calling
         speech_obj[:language] = args[:speech_language] if args[:speech_language]
         speech_obj[:hints] = args[:speech_hints] if args[:speech_hints]
         speech_obj[:end_silence_timeout] = args[:end_silence_timeout] if args[:end_silence_timeout]
-        collect[:digits] = digits_obj
+        collect[:speech] = speech_obj
       end
 
       collect