signalwire 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 325c0f2a81d0a8486fdb356dc91c78284228b30440129ee2a60c3332b1e725b5
-  data.tar.gz: 1f5f8d9227de1b684f05e88d6b1b53246de7f29479c0e11cef94cd792dc8171c
+  metadata.gz: 6165a9529b9376430f0d3d27ee60d19e0fef310ceb5bf9ec8ac602b4cf0d45f6
+  data.tar.gz: 56cd7d1ae685944c202bb82000d4549da11960bc278ddc977b5cc728a2019851
 SHA512:
-  metadata.gz: 6362ec6503c1a04505f72b13edfbb29c2bb7ca4002f7e13fd7926099dbac08142254d0a41447c96f2b44a54639fdfb367d12ab710c6a6e628c39143a823e9028
-  data.tar.gz: e8dce6ff15120bc77452aa97667a0aa468d923cd744e0e4ec15c74db0100424b321e9d86438710750d1cb4285f04db4aa3ab1f09f5e93352a2ebfa7c59874edd
+  metadata.gz: 96659014e4dd5da3a222f9690085b5be43c625d3f1ff767a30574c3c90edd1ddc2abf31b757bc5a0eb54f99d7d7f248b170c2067c087a6f75775a2aac49b3dba
+  data.tar.gz: '070834c4ac95d63981b45ec4b8684f4b2d5b385eb8c24e0bf9fcc7036a76144f9cdedf37a19d6e19d193dd3485ab0837b10d87ee6945f2d3797fa76eda2249da'

data/CHANGELOG.md

@@ -5,6 +5,15 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [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
 - `detect_answering_machine` method with its `amd` alias

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/play_action.rb

@@ -11,5 +11,17 @@ module Signalwire::Relay::Calling
     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

@@ -11,5 +11,9 @@ module Signalwire::Relay::Calling
     def stop
       @component.stop
     end
+
+    def volume(setting)
+      @component.volume setting
+    end
   end
 end

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

@@ -11,5 +11,9 @@ module Signalwire::Relay::Calling
     def stop
       @component.stop
     end
+
+    def url
+      @component.url
+    end
   end
 end

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

@@ -112,50 +112,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

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

@@ -1,11 +1,19 @@
 module Signalwire::Relay::Calling
   module CallConvenienceMethods
-    def play_audio(url)
-      play audio_payload(url)
+    def play_audio(url_p = nil, volume_p = nil, **args)
+      url = args.delete(:url)
+      volume = args.delete(:volume)
+      set_parameters(binding, %i{url volume}, %i{url})
+
+      play(play: audio_payload(url), volume: volume)
     end
 
-    def play_audio!(url)
-      play! audio_payload(url)
+    def play_audio!(url_p = nil, volume_p = nil, **args)
+      url = args.delete(:url)
+      volume = args.delete(:volume)
+      set_parameters(binding, %i{url volume}, %i{url})
+
+      play!(play: audio_payload(url), volume: volume)
     end
 
     def play_silence(duration)
@@ -16,33 +24,43 @@ module Signalwire::Relay::Calling
       play! silence_payload(duration)
     end
 
-    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})
+    def play_tts(text_p=nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, volume_p=nil, text: nil, language: Relay::DEFAULT_LANGUAGE, gender: Relay::DEFAULT_GENDER, volume: nil)
+      set_parameters(binding, %i{text language gender volume}, %i{text})
+
+      play play: tts_payload(text, language, gender), volume: volume
+    end
+
+    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, volume: nil)
+      set_parameters(binding, %i{text language gender volume}, %i{text})
+      play! tts_payload(text, language, gender), volume: volume
+    end
 
-      play tts_payload(text, language, gender)
+    def play_ringtone(name:, duration: nil)
+      play ringtone_payload(name, duration)
     end
 
-    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)
+    def play_ringtone!(name:, duration: nil)
+      play ringtone_payload(name, duration)
     end
 
-    def prompt_audio(collect_p = nil, url_p = nil, **args)
+    def prompt_audio(collect_p = nil, url_p = nil, volume_p=nil, **args)
       collect = args.delete(:collect)
       url = args.delete(:url)
+      volume = args.delete(:volume)
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
-      set_parameters(binding, %i{collect url}, %i{collect url})
+      set_parameters(binding, %i{collect url volume}, %i{collect url})
 
-      prompt(collect: collect, play: audio_payload(url))
+      prompt(collect: collect, play: audio_payload(url), volume: volume)
     end
 
-    def prompt_audio!(collect_p = nil, url_p = nil, **args)
+    def prompt_audio!(collect_p = nil, url_p = nil, volume_p=nil, **args)
       collect = args.delete(:collect)
       url = args.delete(:url)
+      volume = args.delete(:volume)
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
-      set_parameters(binding, %i{collect url}, %i{collect url})
+      set_parameters(binding, %i{collect url volume}, %i{collect url})
 
-      prompt!(collect: collect, play: audio_payload(url))
+      prompt!(collect: collect, play: audio_payload(url), volume: volume)
     end
 
     def prompt_silence(collect_p = nil, duration_p = nil, **args)
@@ -63,28 +81,40 @@ module Signalwire::Relay::Calling
       prompt!(collect: collect, play: silence_payload(duration))
     end
 
-    def prompt_tts(collect_p = nil, text_p = nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, **args)
+    def prompt_tts(collect_p = nil, text_p = nil, volume_p=nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, **args)
       collect = args.delete(:collect)
       text = args.delete(:text)
+      volume = args.delete(:volume)
       language = args.delete(:language) || Relay::DEFAULT_LANGUAGE
       gender = args.delete(:gender) || Relay::DEFAULT_GENDER
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
 
-      set_parameters(binding, %i{collect text language gender}, %i{collect text})
+      set_parameters(binding, %i{collect text language gender volume}, %i{collect text})
 
-      prompt(collect: collect, play: tts_payload(text, language, gender))
+      prompt(collect: collect, play: tts_payload(text, language, gender), volume: volume)
     end
 
-    def prompt_tts!(collect_p = nil, text_p = nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, **args)
+    def prompt_tts!(collect_p = nil, text_p = nil, volume_p=nil, language_p=Relay::DEFAULT_LANGUAGE, gender_p=Relay::DEFAULT_GENDER, **args)
       collect = args.delete(:collect)
       text = args.delete(:text)
+      volume = args.delete(:volume)
       language = args.delete(:language) || Relay::DEFAULT_LANGUAGE
       gender = args.delete(:gender) || Relay::DEFAULT_GENDER
       collect = compile_collect_arguments(args) if collect.nil? && collect_p.nil?
 
-      set_parameters(binding, %i{collect text language gender}, %i{collect text})
+      set_parameters(binding, %i{collect text language gender volume}, %i{collect text})
+
+      prompt!(collect: collect, play: tts_payload(text, language, gender), volume: volume)
+    end
 
-      prompt!(collect: collect, play: tts_payload(text, language, gender))
+    def prompt_ringtone(collect: nil, name:, duration: nil, **args)
+      collect = compile_collect_arguments(args) if collect.nil?
+      prompt(collect: collect, play: ringtone_payload(name, duration))
+    end
+
+    def prompt_ringtone!(collect: nil, name:, duration: nil, **args)
+      collect = compile_collect_arguments(args) if collect.nil?
+      prompt!(collect: collect, play: ringtone_payload(name, duration))
     end
 
     def wait_for_ringing
@@ -116,5 +146,11 @@ module Signalwire::Relay::Calling
     def tts_payload(text, language=Relay::DEFAULT_LANGUAGE, gender=Relay::DEFAULT_GENDER)
       [{ "type": 'tts', "params": { "text": text, "language": language, "gender": gender } }]
     end
+
+    def ringtone_payload(name, duration)
+      params = { name: name } 
+      params[:duration] = duration if duration && duration.to_i > 0
+      [{ type: "ringtone", params: params }]
+    end
   end
 end

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

@@ -30,11 +30,11 @@ module Signalwire::Relay::Calling
       raise NotImplementedError, 'Define this method on the child classes'
     end
 
-    def execute_params(method_suffix = nil)
+    def execute_params(method_suffix = nil, inner_params_merge = {})
       {
         protocol: @call.client.protocol,
         method: method + method_suffix.to_s,
-        params: inner_params
+        params: inner_params.merge(inner_params_merge)
       }
     end
 
@@ -62,9 +62,14 @@ module Signalwire::Relay::Calling
 
     def handle_execute_result(event, outcome)
       @execute_result = event
+      after_execute(event)
       terminate if outcome == :failure
     end
 
+    def after_execute(event)
+      # implemented in subclasses
+    end
+
     def terminate(event = nil)
       @completed = true
       @successful = false

data/lib/signalwire/relay/calling/component/connect.rb

@@ -2,9 +2,10 @@
 
 module Signalwire::Relay::Calling
   class Connect < Component
-    def initialize(call:, devices:)
+    def initialize(call:, devices:, ringback: nil)
       super(call: call)
       @devices = devices
+      @ringback = ringback
     end
 
     def method
@@ -16,11 +17,14 @@ module Signalwire::Relay::Calling
     end
 
     def inner_params
-      {
+      params = {
         node_id: @call.node_id,
         call_id: @call.id,
         devices: @devices
       }
+
+      params[:ringback] = @ringback unless @ringback.nil?
+      params
     end
 
     def notification_handler(event)

data/lib/signalwire/relay/calling/component/play.rb

@@ -2,9 +2,10 @@
 
 module Signalwire::Relay::Calling
   class Play < ControlComponent
-    def initialize(call:, play:)
+    def initialize(call:, play:, volume: nil)
       super(call: call)
       @play = play
+      @volume = volume
     end
 
     def method
@@ -16,12 +17,15 @@ module Signalwire::Relay::Calling
     end
 
     def inner_params
-      {
+      prm = {
         node_id: @call.node_id,
         call_id: @call.id,
         control_id: control_id,
         play: @play
       }
+
+      prm[:volume] = @volume unless @volume.nil?
+      prm
     end
 
     def notification_handler(event)
@@ -42,5 +46,17 @@ module Signalwire::Relay::Calling
       @call.broadcast "play_#{@state}".to_sym, event
       @call.broadcast :play_state_change, event
     end
+
+    def pause
+      execute_subcommand '.pause', Signalwire::Relay::Calling::PlayPauseResult
+    end
+
+    def resume
+      execute_subcommand '.resume', Signalwire::Relay::Calling::PlayResumeResult
+    end
+
+    def volume(setting)
+      execute_subcommand '.volume', Signalwire::Relay::Calling::PlayVolumeResult, { volume: setting }
+    end
   end
 end

data/lib/signalwire/relay/calling/component/prompt.rb

@@ -3,10 +3,11 @@
 module Signalwire::Relay::Calling
   class Prompt < ControlComponent
     attr_reader :type, :input, :terminator
-    def initialize(call:, collect:, play:)
+    def initialize(call:, collect:, play:, volume: nil)
       super(call: call)
       @play = play
       @collect = collect
+      @volume = volume
     end
 
     def method
@@ -18,13 +19,15 @@ module Signalwire::Relay::Calling
     end
 
     def inner_params
-      {
+      prm = {
         node_id: @call.node_id,
         call_id: @call.id,
         control_id: control_id,
         play: @play,
         collect: @collect
       }
+      prm[:volume] = @volume unless @volume.nil?
+      prm
     end
 
     def notification_handler(event)
@@ -45,6 +48,10 @@ module Signalwire::Relay::Calling
       check_for_waiting_events
     end
 
+    def volume(setting)
+      execute_subcommand '.volume', Signalwire::Relay::Calling::PromptVolumeResult, { volume: setting }
+    end
+
   private
 
     def digit_event(result)

data/lib/signalwire/relay/calling/component/record.rb

@@ -49,5 +49,9 @@ module Signalwire::Relay::Calling
       @call.broadcast "record_#{@state}".to_sym, event
       @call.broadcast :record_state_change, event
     end
+
+    def after_execute(execute_event)
+      @url = execute_event.call_params[:url]
+    end
   end
 end

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

@@ -24,11 +24,15 @@ module Signalwire::Relay::Calling
     end
 
     def stop
-      @call.relay_execute execute_params('.stop') do |event, outcome|
-        if outcome == :failure
-          terminate(event)
-          return event
-        end
+      execute_subcommand '.stop', Signalwire::Relay::Calling::StopResult
+    end
+
+    def execute_subcommand(suffix, result_klass, extra_params = {})
+      @call.relay_execute execute_params('.stop', extra_params) do |event, outcome|
+        succeeded = outcome == :success
+        terminate(event) unless succeeded
+
+        return result_klass.new(succeeded)
       end
     end
   end

data/lib/signalwire/relay/calling/result/base_action_result.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class BaseActionResult
+    attr_reader :successful
+    def initialize(result)
+      @successful = result
+    end
+  end
+end

data/lib/signalwire/relay/calling/result/play_pause_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class PlayPauseResult < BaseActionResult
+  end
+end

data/lib/signalwire/relay/calling/result/play_resume_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class PlayResumeResult < BaseActionResult
+  end
+end

data/lib/signalwire/relay/calling/result/play_volume_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class PlayVolumeResult < BaseActionResult
+  end
+end

data/lib/signalwire/relay/calling/result/prompt_volume_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class PromptVolumeResult < BaseActionResult
+  end
+end

data/lib/signalwire/relay/calling/result/stop_result.rb

@@ -0,0 +1,6 @@
+# This does not inherit from Result as it only represents a subcommand
+#
+module Signalwire::Relay::Calling
+  class StopResult < BaseActionResult
+  end
+end

data/lib/signalwire/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalwire
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - SignalWire Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -312,15 +312,21 @@ files:
 - lib/signalwire/relay/calling/control_component.rb
 - lib/signalwire/relay/calling/result.rb
 - lib/signalwire/relay/calling/result/answer_result.rb
+- lib/signalwire/relay/calling/result/base_action_result.rb
 - lib/signalwire/relay/calling/result/connect_result.rb
 - lib/signalwire/relay/calling/result/detect_result.rb
 - lib/signalwire/relay/calling/result/dial_result.rb
 - lib/signalwire/relay/calling/result/fax_result.rb
 - lib/signalwire/relay/calling/result/hangup_result.rb
+- lib/signalwire/relay/calling/result/play_pause_result.rb
 - lib/signalwire/relay/calling/result/play_result.rb
+- lib/signalwire/relay/calling/result/play_resume_result.rb
+- lib/signalwire/relay/calling/result/play_volume_result.rb
 - lib/signalwire/relay/calling/result/prompt_result.rb
+- lib/signalwire/relay/calling/result/prompt_volume_result.rb
 - lib/signalwire/relay/calling/result/record_result.rb
 - lib/signalwire/relay/calling/result/send_digits_result.rb
+- lib/signalwire/relay/calling/result/stop_result.rb
 - lib/signalwire/relay/calling/result/tap_result.rb
 - lib/signalwire/relay/client.rb
 - lib/signalwire/relay/constants.rb