signalwire 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d68736f7bf37f324c9f85a604165cd994d45974d73741c90cd9290e4ef63b4c
-  data.tar.gz: f47bcfe838a3ce0576d7f2ba199f415ab5a36f23d07feef554ad3c340c20d015
+  metadata.gz: 85b3509109fd09ce52f1f579294b3723c4bfc63337584dfc753c491645221868
+  data.tar.gz: 35cf3f667c586fc788136eec75930785c360315594246a3dd9b0800123f86ee1
 SHA512:
-  metadata.gz: 782c53f901d1bf44cb4bf9dd523a6268bf4bd6c165aa39223e054501f75092524e47a92ce97acb6b247cf2ad89f311fb44722bb27c5db82fbf6da7c9e88cd65e
-  data.tar.gz: 0ace788a9baf5c7c9aee04bcae89478777bdbbd7f107040da98687e5bb211d0ecccc8222fb11e6ce97037c8d773c61914538df43ab40eeb0360a1aab7358ccca
+  metadata.gz: 5d9261efe1e472198348e53f8f7805baa24f50c4c6282e510200b84860bb17919a7bc0b0059b73c6b9c8b078eb854592e4d88a1bd6424598a433afa44f00ab20
+  data.tar.gz: 18ce795d935a76bad953e7128d98932b5fc24353d8d842d639628ba10bb9f69f0ddcc91fadb3c4d2443809190ecc1a2851641e03f232b196652a7b818ad03016

data/CHANGELOG.md

@@ -3,6 +3,17 @@ 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).
 
+## [2.1.0] 2019-07-29
+### Added
+- Tap API for Relay
+- `:task` broadcast from client
+- `Relay::Task` and `on_task` handler for `Consumer`
+- Fax API for Relay
+- `Detect` API for Relay
+- Messaging API for Relay
+### Changed
+- Changed `SIGNALWIRE_ACCOUNT` environment variable to `SIGNALWIRE_PROJECT_KEY` to match UI
+
 ## [2.0.0] - 2019-07-16
 ### Added
 - Connection Retry upon disconnect.

data/examples/relay/fax/fax_receive.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class MyConsumer < Signalwire::Relay::Consumer
+  contexts ['incoming']
+
+  def on_incoming_call(call)
+    call.answer
+    fax_result = call.fax_receive
+    logger.debug "Received a fax: #{fax_result.document} that is #{fax_result.pages} pages long."
+    call.hangup
+  end
+end
+
+MyConsumer.new.run

data/examples/relay/fax/fax_send.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class OutboundConsumer < Signalwire::Relay::Consumer
+  def ready
+    call = client.calling.new_call(from: ENV['FAX_FROM_NUMBER'], to: ENV['FAX_TO_NUMBER'])
+    call.dial
+    call.fax_send(document: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf")
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/inbound_consumer.rb

@@ -7,7 +7,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 ].each { |f| require f }
 
 # Setup your ENV with:
-# SIGNALWIRE_ACCOUNT=YOUR_SIGNALWIRE_ACCOUNT_ID
+# SIGNALWIRE_PROJECT_KEY=YOUR_SIGNALWIRE_ACCOUNT_ID
 # SIGNALWIRE_TOKEN=YOUR_SIGNALWIRE_ACCOUNT_TOKEN
 #
 Signalwire::Logger.logger.level = ::Logger::DEBUG

data/examples/relay/inbound_dial.rb

@@ -7,7 +7,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 ].each { |f| require f }
 
 # Setup your ENV with:
-# SIGNALWIRE_ACCOUNT=YOUR_SIGNALWIRE_ACCOUNT_ID
+# SIGNALWIRE_PROJECT_KEY=YOUR_SIGNALWIRE_ACCOUNT_ID
 # SIGNALWIRE_TOKEN=YOUR_SIGNALWIRE_ACCOUNT_TOKEN
 #
 # Set logging to debug for testing

data/examples/relay/messaging/messaging_receive.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 MessageSendConsumer < Signalwire::Relay::Consumer
+  contexts ['incoming']
+
+  def on_incoming_message(message)
+    logger.info "Received message from #{message.from}: #{message.body}"
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+
+  def on_message_state_change(message)
+    logger.info "Received state change: #{message.id} #{message.state}"
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+MessageSendConsumer.new.run

data/examples/relay/messaging/messaging_send.rb

@@ -0,0 +1,23 @@
+# 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 MessageSendConsumer < Signalwire::Relay::Consumer
+  def ready
+    logger.debug "Sending an SMS to #{ENV['TO_NUMBER']}"
+    result = client.messaging.send(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER'], context: 'incoming', body: 'hello world!')
+    logger.debug "message id #{result.message_id} was successfully sent" if result.successful
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+MessageSendConsumer.new.run

data/examples/relay/outbound_detect.rb

@@ -0,0 +1,27 @@
+# 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.detect_digit(digits: "345", timeout: 10)
+
+    logger.debug "User pressed #{result.result}"
+    call.hangup
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/outbound_tap.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
+    
+    tap_arguments = { type: "audio", params: { direction: "listen" } }
+    device_arguments = { type: "rtp", params: { addr: "127.0.0.1", port: 1234 } }
+
+    call.tap_media(tap: tap_arguments, device: device_arguments)
+
+    call.hangup
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/tasking/tasking_receive.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Setup your ENV with:
+# SIGNALWIRE_PROJECT_KEY=YOUR_SIGNALWIRE_ACCOUNT_ID
+# SIGNALWIRE_TOKEN=YOUR_SIGNALWIRE_ACCOUNT_TOKEN
+#
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class MyConsumer < Signalwire::Relay::Consumer
+  contexts ['incoming']
+
+  def on_task(task)
+    logger.debug "Received #{task.message}"
+  end
+end
+
+MyConsumer.new.run

data/examples/relay/tasking/tasking_send.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire/relay/task
+].each { |f| require f }
+
+task = Signalwire::Relay::Task.new(
+  project: ENV['SIGNALWIRE_PROJECT_KEY'],
+  token: ENV['SIGNALWIRE_TOKEN'],
+  host: ENV['SIGNALWIRE_HOST']
+)
+
+task.deliver(context: 'incoming', message: { foo: 'bar' })

data/lib/signalwire/relay.rb

@@ -11,30 +11,48 @@ require 'signalwire/relay/consumer'
 
 require 'signalwire/relay/calling'
 require 'signalwire/relay/calling/call_convenience_methods'
+require 'signalwire/relay/calling/call_detect_methods'
 require 'signalwire/relay/calling/call'
 
+require 'signalwire/relay/task'
+
 require 'signalwire/relay/calling/action'
 require 'signalwire/relay/calling/action/connect_action'
+require 'signalwire/relay/calling/action/detect_action'
 require 'signalwire/relay/calling/action/play_action'
 require 'signalwire/relay/calling/action/prompt_action'
 require 'signalwire/relay/calling/action/record_action'
+require 'signalwire/relay/calling/action/fax_action'
+require 'signalwire/relay/calling/action/tap_action'
 
 require 'signalwire/relay/calling/result'
 require 'signalwire/relay/calling/result/answer_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/prompt_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/component'
 require 'signalwire/relay/calling/control_component'
 require 'signalwire/relay/calling/component/answer'
 require 'signalwire/relay/calling/component/connect'
+require 'signalwire/relay/calling/component/detect'
 require 'signalwire/relay/calling/component/dial'
 require 'signalwire/relay/calling/component/hangup'
 require 'signalwire/relay/calling/component/play'
 require 'signalwire/relay/calling/component/prompt'
 require 'signalwire/relay/calling/component/record'
 require 'signalwire/relay/calling/component/await'
+require 'signalwire/relay/calling/component/base_fax'
+require 'signalwire/relay/calling/component/fax_send'
+require 'signalwire/relay/calling/component/fax_receive'
+require 'signalwire/relay/calling/component/tap'
+
+require 'signalwire/relay/messaging'
+require 'signalwire/relay/messaging/message'
+require 'signalwire/relay/messaging/send_result.rb'

data/lib/signalwire/relay/calling.rb

@@ -21,7 +21,7 @@ module Signalwire::Relay
       end
 
       def contexts
-        @contexts ||= Concurrent::Array.new
+        @client.contexts
       end
 
       def receive(context:, &block)
@@ -32,17 +32,7 @@ module Signalwire::Relay
           block.call(call_obj) if block_given?
         end
 
-        receive_command = {
-          protocol: protocol,
-          method: 'call.receive',
-          params: {
-            context: context
-          }
-        }
-
-        relay_execute receive_command do
-          contexts << context
-        end
+        @client.setup_context(context)
       end
 
       def find_call_by_id(call_id)

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Signalwire::Relay::Calling
+  class DetectAction < Action
+    def result
+      DetectResult.new(@component)
+    end
+
+    def stop
+      @component.stop
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Signalwire::Relay::Calling
+  class FaxAction < Action
+    def result
+      FaxResult.new(@component)
+    end
+
+    def stop
+      @component.stop
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Signalwire::Relay::Calling
+  class TapAction < Action
+    def_delegators :@component, :source_device
+
+    def result
+      TapResult.new(@component)
+    end
+
+    def stop
+      @component.stop
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Signalwire::Relay::Calling
     include Signalwire::Common
     include Signalwire::Blade::EventHandler
     include Signalwire::Relay::Calling::CallConvenienceMethods
+    include Signalwire::Relay::Calling::CallDetectMethods
     extend Forwardable
 
     attr_reader :device, :type, :node_id, :context, :from, :to,
@@ -162,6 +163,42 @@ module Signalwire::Relay::Calling
       DialResult.new(component: dial_component)
     end
 
+    def fax_receive
+      component = Signalwire::Relay::Calling::FaxReceive.new(call: self)
+      component.wait_for(Relay::CallFaxState::ERROR, Relay::CallFaxState::FINISHED)
+      FaxResult.new(component: component)
+    end
+
+    def fax_receive!
+      component = Signalwire::Relay::Calling::FaxReceive.new(call: self)
+      component.execute
+      FaxAction.new(component: component)
+    end
+
+    def fax_send(document: , identity: nil, header: nil)
+      component = Signalwire::Relay::Calling::FaxSend.new(call: self, document: document, identity: identity, header: header)
+      component.wait_for(Relay::CallFaxState::ERROR, Relay::CallFaxState::FINISHED)
+      FaxResult.new(component: component)
+    end
+
+    def fax_send!(document: , identity: nil, header: nil)
+      component = Signalwire::Relay::Calling::FaxSend.new(call: self, document: document, identity: identity, header: header)
+      component.execute
+      FaxAction.new(component: component)
+    end
+
+    def tap_media(tap:, device:)
+      component = Signalwire::Relay::Calling::Tap.new(call: self, tap: tap, device: device)
+      component.wait_for(Relay::CallTapState::FINISHED)
+      TapResult.new(component: component)
+    end
+
+    def tap_media!(tap:, device:)
+      component = Signalwire::Relay::Calling::Tap.new(call: self, tap: tap, device: device)
+      component.execute
+      TapAction.new(component: component)
+    end
+
     def wait_for(*events)
       events = [Relay::CallState::ENDED] if events.empty?
       

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

@@ -0,0 +1,110 @@
+module Signalwire::Relay::Calling
+  module CallDetectMethods
+    def detect(detect:, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.wait_for(Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR)
+      DetectResult.new(component: component)
+    end
+
+    def detect!(detect:, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.execute
+      DetectAction.new(component: component)
+    end
+
+    def detect_human(params: {}, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::MACHINE,
+        params: params
+      }
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.wait_for(Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR, Relay::CallDetectState::HUMAN)
+      DetectResult.new(component: component)
+    end
+
+    def detect_human!(params: {}, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::MACHINE,
+        params: params
+      }
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.setup_waiting_events([Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR, Relay::CallDetectState::HUMAN])
+      component.execute
+      DetectAction.new(component: component)
+    end
+
+    def detect_machine(params: {}, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::MACHINE,
+        params: params
+      }
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.wait_for(Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR, 
+                         Relay::CallDetectState::MACHINE, Relay::CallDetectState::READY,
+                         Relay::CallDetectState::NOT_READY)
+      DetectResult.new(component: component)
+    end
+
+    def detect_machine!(params: {}, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::MACHINE,
+        params: params
+      }
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.setup_waiting_events([Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR, 
+                                      Relay::CallDetectState::MACHINE, Relay::CallDetectState::READY,
+                                      Relay::CallDetectState::NOT_READY])
+      component.execute
+      DetectAction.new(component: component)                                
+    end
+
+    def detect_fax(tone: nil, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect, events = prepare_fax_arguments(tone)
+
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.wait_for(*events)
+      DetectResult.new(component: component)
+    end
+
+    def detect_fax!(tone: nil, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect, events = prepare_fax_arguments(tone)
+      component = Signalwire::Relay::Calling::Detect.new(call: self, detect: detect, timeout: timeout)
+      component.setup_waiting_events(events)
+      component.execute
+      DetectAction.new(component: component)     
+    end
+
+    def detect_digit(digits: nil, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::DIGIT,
+        params: {}
+      }
+      detect[:params][:digits] = digits if digits
+      detect(detect: detect, timeout: timeout)
+    end
+
+    def detect_digit!(digits: nil, timeout: Relay::DEFAULT_CALL_TIMEOUT)
+      detect = {
+        type: Relay::CallDetectType::DIGIT,
+        params: {}
+      }
+      detect[:params][:digits] = digits if digits
+      detect!(detect: detect, timeout: timeout)
+    end
+
+    def prepare_fax_arguments(tone)
+      fax_events = [Relay::CallDetectState::CED, Relay::CallDetectState::CNG]
+      events = [Relay::CallDetectState::FINISHED, Relay::CallDetectState::ERROR]
+      detect = { type: Relay::CallDetectType::FAX, params: {} }
+
+      if fax_events.include?(tone)
+        detect[:params] = { tone: tone }
+        events << tone
+      else
+        events = events + fax_events
+      end
+
+      [detect, events]
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class BaseFax < ControlComponent
+    attr_reader :direction, :identity, :remote_identity, :document, :pages
+
+    def event_type
+      Relay::CallNotification::FAX
+    end
+
+    def notification_handler(event)
+      fax_state = event.call_params[:fax]
+      fax_params = fax_state[:params]
+      @state = fax_state[:type]
+
+      @completed = @state != Relay::CallFaxState::PAGE
+
+      if @completed
+        if fax_params[:success]
+          @successful = true
+          @direction = fax_params[:direction]
+          @identity = fax_params[:identity]
+          @remote_identity = fax_params[:remote_identity]
+          @document = fax_params[:document]
+          @pages = fax_params[:pages]
+        end
+
+        @event = event
+      end
+
+      broadcast_event(event)
+      check_for_waiting_events
+    end
+
+    def broadcast_event(event)
+      @call.broadcast "fax_#{@state}".to_sym, event
+      @call.broadcast :fax_state_change, event
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class Detect < ControlComponent
+    attr_reader :result, :type
+
+    def initialize(call:, detect:, timeout: 30)
+      super(call: call)
+      @detect = detect
+      @timeout = timeout
+      @received_events = Concurrent::Array.new
+    end
+
+    def method
+      Relay::ComponentMethod::DETECT
+    end
+
+    def event_type
+      Relay::CallNotification::DETECT
+    end
+
+    def inner_params
+      {
+        node_id: @call.node_id,
+        call_id: @call.id,
+        control_id: control_id,
+        detect: @detect,
+        timeout: @timeout
+      }
+    end
+
+    def notification_handler(event)
+      result = event.call_params[:detect]
+      @type = result[:type]
+      params = result[:params]
+      res_event = params[:event]
+      @state = res_event
+
+      if @state != Relay::CallDetectState::FINISHED && @state != Relay::CallDetectState::ERROR
+        @received_events << res_event
+      end
+
+      @completed = @events_waiting.include?(@state)
+
+      if @completed
+        @successful = @state != Relay::CallDetectState::ERROR
+        @result = @received_events.join(' ')
+        @event = event
+        unblock(event)
+      end
+
+      broadcast_event(event)
+      # This component has complex logic so we handle it separately
+      # check_for_waiting_events
+    end
+
+    def broadcast_event(event)
+      @call.broadcast "detect_#{@state}".to_sym, event
+      @call.broadcast :detect_state_change, event
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Signalwire::Relay::Calling
+  class FaxReceive < BaseFax
+    def method
+      Relay::ComponentMethod::RECEIVE_FAX
+    end
+
+    def inner_params
+      params = {
+        node_id: @call.node_id,
+        call_id: @call.id,
+        control_id: control_id
+      }
+    end 
+  end
+end

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

@@ -0,0 +1,28 @@
+module Signalwire::Relay::Calling
+  class FaxSend < BaseFax
+    def initialize(call:, document:, identity: nil, header: nil)
+      super(call: call)
+      @priv_document = document
+      @priv_identity = identity
+      @priv_header = header
+    end
+
+    def method
+      Relay::ComponentMethod::SEND_FAX
+    end
+
+    def inner_params
+      params = {
+        node_id: @call.node_id,
+        call_id: @call.id,
+        control_id: control_id,
+        document: @priv_document
+      }
+
+      params[:identity] = @priv_identity if @priv_identity
+      params[:header_info] = @priv_header if @priv_header
+
+      params
+    end 
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class Tap < ControlComponent
+    attr_accessor :device
+
+    def initialize(call:, tap:, device:)
+      super(call: call)
+      @tap = tap
+      @device = device
+    end
+
+    def method
+      Relay::ComponentMethod::TAP
+    end
+
+    def event_type
+      Relay::CallNotification::TAP
+    end
+
+    def source_device
+      return unless @execute_result
+
+      @execute_result.dig(:result, :result, :source_device)
+    end
+
+    def inner_params
+      {
+        node_id: @call.node_id,
+        call_id: @call.id,
+        control_id: control_id,
+        tap: @tap,
+        device: @device
+      }
+    end
+
+    def tap_media
+      @tap
+    end
+
+    def notification_handler(event)
+      @state = event.call_params[:state]
+      @device = event.call_params[:device]
+      @tap = event.call_params[:tap]
+
+      @completed = @state == Relay::CallTapState::FINISHED
+      if @completed
+        @successful = true
+        @event = event
+      end
+
+      broadcast_event(event)
+      check_for_waiting_events
+    end
+
+    def broadcast_event(event)
+      @call.broadcast "tap_#{@state}".to_sym, event
+      @call.broadcast :tap_state_change, event
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class DetectResult < Result
+    def_delegators :@component, :type, :result
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class FaxResult < Result
+    def_delegators :@component, :direction, :identity, :remote_identity, :document, :pages
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Calling
+  class TapResult < Result
+    def_delegators :@component, :tap_media, :source_device, :device
+  end
+end

data/lib/signalwire/relay/client.rb

@@ -31,7 +31,7 @@ module Signalwire::Relay
     # Starts the client connection
     #
     def connect!
-      logger.debug "Connecting to #{@space_url}"
+      logger.debug "Connecting to #{@url}"
       session.connect!
     end
 
@@ -80,9 +80,11 @@ module Signalwire::Relay
           logger.error "Relay command failed with code #{code} and message: #{message}" unless success
         else
           logger.error 'Unknown Relay command failure, result code not found'
+          block.call(event, :failure) if block_given?
         end
       else
         logger.error 'Unknown Relay command failure, command timed out'
+        block.call(event, :failure) if block_given?
       end
     end
 
@@ -90,6 +92,29 @@ module Signalwire::Relay
       @calling ||= Signalwire::Relay::Calling::Instance.new(self)
     end
 
+    def messaging
+      @messaging ||= Signalwire::Relay::Messaging::Instance.new(self)
+    end
+
+    def setup_context(context)
+      return if contexts.include?(context)
+      receive_command = {
+        protocol: @protocol,
+        method: 'call.receive',
+        params: {
+          context: context
+        }
+      }
+
+      relay_execute receive_command do
+        contexts << context
+      end
+    end
+
+    def contexts
+      @contexts ||= Concurrent::Array.new
+    end
+
   private
 
     def setup_handlers
@@ -141,6 +166,7 @@ module Signalwire::Relay
       @session.on :message, %i[\[\] method] => 'blade.broadcast' do |event|
         relay = Signalwire::Relay::Event.from_blade(event)
         broadcast :event, relay
+        broadcast :task, relay if relay.dig(:params, :event) == "queuing.relay.tasks"
       end
     end
   end

data/lib/signalwire/relay/constants.rb

@@ -60,6 +60,9 @@ module Signalwire::Relay
     RECORD = 'calling.call.record'
     PLAY = 'calling.call.play'
     COLLECT = 'calling.call.collect'
+    FAX = 'calling.call.fax'
+    TAP = 'calling.call.tap'
+    DETECT = 'calling.call.detect'
   end
 
   CALL_EVENT_STATE_FIELDS = {
@@ -91,6 +94,15 @@ module Signalwire::Relay
     FINISHED = 'finished'
   end
 
+  module MessageState
+    QUEUED = 'queued'
+    INITIATED = 'initiated'
+    SENT = 'sent'
+    DELIVERED = 'delivered'
+    UNDELIVERED = 'undelivered'
+    FAILED = 'failed'
+  end
+
   module ComponentMethod
     ANSWER = 'call.answer'
     CONNECT = 'call.connect'
@@ -99,11 +111,44 @@ module Signalwire::Relay
     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'
   end
 
   module CommonState
     SUCCESSFUL = 'successful'
   end
+
+  module CallFaxState
+    PAGE = 'page',
+    ERROR = 'error',
+    FINISHED = 'finished'
+  end
+
+  module CallTapState
+    TAPPING = 'tapping'
+    FINISHED = 'finished'
+  end
+  
+  module CallDetectState
+    ERROR = 'error'
+    FINISHED = 'finished'
+    CED = 'CED'
+    CNG = 'CNG'
+    MACHINE = 'MACHINE'
+    HUMAN = 'HUMAN'
+    UNKNOWN = 'UNKNOWN'
+    READY = 'READY'
+    NOT_READY = 'NOT_READY'
+  end
+
+  module CallDetectType
+    FAX = "fax"
+    MACHINE = "machine"
+    DIGIT = "digit"
+  end
 end
 
 Relay = Signalwire::Relay

data/lib/signalwire/relay/consumer.rb

@@ -18,7 +18,7 @@ module Signalwire::Relay
     # Creates a Consumer instance ready to be run
     #
     # The initialization parameters can also be supplied via ENV variables
-    # (SIGNALWIRE_ACCOUNT, SIGNALWIRE_TOKEN and SIGNALWIRE_HOST)
+    # (SIGNALWIRE_PROJECT_KEY, SIGNALWIRE_TOKEN and SIGNALWIRE_HOST)
     # Passed-in values override the environment ones.
     #
     # @param project [String] Your SignalWire project identifier
@@ -26,26 +26,22 @@ module Signalwire::Relay
     # @param SIGNALWIRE_HOST [String] Your SignalWire space URL (not needed for production usage)
 
     def initialize(project: nil, token: nil, host: nil)
-      @project = project   || ENV['SIGNALWIRE_ACCOUNT']
+      @project = project   || ENV['SIGNALWIRE_PROJECT_KEY']
       @token =   token     || ENV['SIGNALWIRE_TOKEN']
       @url =     host  || ENV['SIGNALWIRE_HOST'] || Signalwire::Relay::DEFAULT_URL
       @client = Signalwire::Relay::Client.new(project: @project,
         token: @token, host: @url)
     end
 
-    def setup
-      # do stuff here.
-    end
+    def setup; end
 
-    def ready
-      # do stuff here.
-    end
+    def ready; end
 
-    def teardown
-      # do stuff here.
-    end
+    def teardown; end
 
     def on_task(task); end
+    def on_incoming_message(message); end
+    def on_message_state_change(message); end
 
     def on_event(event)
       # all-events firespout
@@ -56,10 +52,11 @@ module Signalwire::Relay
     def run
       setup
       client.once :ready do
-        ready
         setup_receive_listeners
         setup_all_events_listener
-        # not sure if ordering matters
+        setup_task_listeners
+        setup_messaging_listeners
+        ready
       end
       client.connect!
     end
@@ -79,10 +76,21 @@ module Signalwire::Relay
       end
     end
 
+    def setup_task_listeners
+      client.on :task do |task|
+        on_task(task)
+      end
+    end
+
     def setup_all_events_listener
       client.on :event do |evt|
         on_event(evt)
       end
     end
+
+    def setup_messaging_listeners
+      client.messaging.on(:message_received) { |evt|on_incoming_message(evt) }
+      client.messaging.on(:message_state_change) { |evt| on_message_state_change(evt) }
+    end
   end
 end

data/lib/signalwire/relay/event.rb

@@ -34,6 +34,10 @@ module Signalwire::Relay
       {}
     end
 
+    def message
+      event_params[:message]
+    end
+
     def self.from_blade(blade_event)
       new(blade_event.payload)
     end

data/lib/signalwire/relay/messaging.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'concurrent-ruby'
+
+module Signalwire::Relay
+  module Messaging
+    class Instance
+      extend Forwardable
+      include Signalwire::Logger
+      include Signalwire::Common
+
+      alias_method :object_send, :send
+
+      def_delegators :@client, :relay_execute, :protocol, :on, :once, :broadcast
+
+      def initialize(client)
+        @client = client
+        setup_events
+      end
+
+      def send(from:, to:, context:, body: nil, media: nil, tags: nil, region: nil)
+        params = {
+          from_number: from_number,
+          to_number: to_number,
+          context: context
+        }
+
+        params[:body] = body if body
+        params[:media] = media if media
+        params[:tags] = tags if tags
+        params[:region] = region if region
+
+        messaging_send = {
+          protocol: protocol,
+          method: 'messaging.send',
+          params: params
+        }
+
+        response = nil
+        relay_execute messaging_send do |event|
+          response = Signalwire::Relay::Messaging::SendResult.new(event)
+        end
+        response
+      end
+
+      def setup_events
+        @client.on :event, event_type: 'messaging.receive' do |event|
+          broadcast :message_received, Signalwire::Relay::Messaging::Message.new(event.payload)
+        end
+
+        @client.on :event, event_type: 'messaging.state' do |event|
+          broadcast :message_state_change, Signalwire::Relay::Messaging::Message.new(event.payload)
+        end
+      end
+    end
+  end
+end

data/lib/signalwire/relay/messaging/message.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Signalwire::Relay::Messaging
+  class Message < Signalwire::Relay::Event
+    alias_method :blade_id, :id
+
+    FIELDS =  %i{body message_id context tags 
+                from_number to_number media 
+                segments message_state}.freeze
+    def message_params
+      dig(:params, :params, :params)
+    rescue StandardError
+      {}
+    end
+
+    FIELDS.each do |meth|
+      defined_method = case meth
+      when :to_number
+        :to
+      when :from_number
+        :from
+      when :message_state
+        :state
+      when :message_id
+        :id
+      else
+        meth
+      end
+      define_method(defined_method) { message_params[meth] }
+    end
+  end
+end

data/lib/signalwire/relay/messaging/send_result.rb

@@ -0,0 +1,25 @@
+module Signalwire::Relay::Messaging
+  attr_accessor :event
+  class SendResult < Signalwire::Relay::Event
+    def initialize(event)
+      super(event.payload)
+      @event = event
+    end
+
+    def code
+      dig(:result, :result, :code)
+    end
+
+    def message_id
+      dig(:result, :result, :message_id)
+    end
+
+    def message
+      dig(:result, :result, :message)
+    end
+
+    def successful
+      code == "200"
+    end
+  end
+end

data/lib/signalwire/relay/task.rb

@@ -0,0 +1,45 @@
+require 'uri'
+require 'faraday'
+require 'json'
+
+module Signalwire::Relay
+  class Task
+    DEFAULT_HOST = "relay.signalwire.com"
+    attr_accessor :host
+
+    def initialize(project:, token:, host: nil )
+      @project = project
+      @token = token
+      @host = host || DEFAULT_HOST
+    end
+
+    def deliver(context:, message:)
+      message = JSON.generate({
+        context: context,
+        message: message
+      })
+      conn = Faraday.new(
+        url: normalize_host(@host),
+        headers: {'Content-Type' => 'application/json'}
+      )
+      conn.basic_auth(@project, @token)
+
+      resp = conn.post('/api/relay/rest/tasks') do |req|
+        req.body = message
+      end
+      return resp.status == 204
+    end
+
+    def normalize_host(passed_host)
+      uri = URI.parse(passed_host)
+      if uri.scheme.nil? && uri.host.nil?
+        unless uri.path.nil?
+          uri.scheme = 'https'
+          uri.host = uri.path
+          uri.path = ''
+        end
+      end
+      uri.to_s
+    end
+  end
+end

data/lib/signalwire/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalwire
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - SignalWire Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -255,11 +255,19 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- examples/relay/fax/fax_receive.rb
+- examples/relay/fax/fax_send.rb
 - examples/relay/inbound_consumer.rb
 - examples/relay/inbound_dial.rb
+- examples/relay/messaging/messaging_receive.rb
+- examples/relay/messaging/messaging_send.rb
 - examples/relay/outbound_collect.rb
 - examples/relay/outbound_consumer.rb
+- examples/relay/outbound_detect.rb
 - examples/relay/outbound_record.rb
+- examples/relay/outbound_tap.rb
+- examples/relay/tasking/tasking_receive.rb
+- examples/relay/tasking/tasking_send.rb
 - lib/signalwire.rb
 - lib/signalwire/blade.rb
 - lib/signalwire/blade/connection.rb
@@ -274,34 +282,50 @@ files:
 - lib/signalwire/relay/calling.rb
 - lib/signalwire/relay/calling/action.rb
 - lib/signalwire/relay/calling/action/connect_action.rb
+- lib/signalwire/relay/calling/action/detect_action.rb
+- lib/signalwire/relay/calling/action/fax_action.rb
 - lib/signalwire/relay/calling/action/play_action.rb
 - lib/signalwire/relay/calling/action/prompt_action.rb
 - lib/signalwire/relay/calling/action/record_action.rb
+- lib/signalwire/relay/calling/action/tap_action.rb
 - lib/signalwire/relay/calling/call.rb
 - lib/signalwire/relay/calling/call_convenience_methods.rb
+- lib/signalwire/relay/calling/call_detect_methods.rb
 - lib/signalwire/relay/calling/component.rb
 - lib/signalwire/relay/calling/component/answer.rb
 - lib/signalwire/relay/calling/component/await.rb
+- lib/signalwire/relay/calling/component/base_fax.rb
 - lib/signalwire/relay/calling/component/connect.rb
+- lib/signalwire/relay/calling/component/detect.rb
 - lib/signalwire/relay/calling/component/dial.rb
+- lib/signalwire/relay/calling/component/fax_receive.rb
+- lib/signalwire/relay/calling/component/fax_send.rb
 - lib/signalwire/relay/calling/component/hangup.rb
 - lib/signalwire/relay/calling/component/play.rb
 - lib/signalwire/relay/calling/component/prompt.rb
 - lib/signalwire/relay/calling/component/record.rb
+- lib/signalwire/relay/calling/component/tap.rb
 - 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/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_result.rb
 - lib/signalwire/relay/calling/result/prompt_result.rb
 - lib/signalwire/relay/calling/result/record_result.rb
+- lib/signalwire/relay/calling/result/tap_result.rb
 - lib/signalwire/relay/client.rb
 - lib/signalwire/relay/constants.rb
 - lib/signalwire/relay/consumer.rb
 - lib/signalwire/relay/event.rb
+- lib/signalwire/relay/messaging.rb
+- lib/signalwire/relay/messaging/message.rb
+- lib/signalwire/relay/messaging/send_result.rb
 - lib/signalwire/relay/request.rb
+- lib/signalwire/relay/task.rb
 - lib/signalwire/rest/client.rb
 - lib/signalwire/sdk.rb
 - lib/signalwire/sdk/configuration.rb