punchblock 0.7.2 → 0.8.0

data/lib/punchblock/component/tropo/ask.rb

@@ -1,199 +0,0 @@
-module Punchblock
-  module Component
-    module Tropo
-      class Ask < ComponentNode
-        register :ask, :ask
-
-        ##
-        # Create an ask message
-        #
-        # @param [Hash] options for asking/prompting a specific call
-        # @option options [Choices, Hash] :choices to allow the user to input
-        # @option options [Prompt, Hash, Optional] :prompt to play/read to the caller as the question
-        # @option options [Symbol, Optional] :mode by which to accept input. Can be :speech, :dtmf or :any
-        # @option options [Integer, Optional] :timeout to wait for user input
-        # @option options [Boolean, Optional] :bargein wether or not to allow the caller to begin their response before the prompt finishes
-        # @option options [String, Optional] :recognizer to use for speech recognition
-        # @option options [String, Optional] :terminator by which to signal the end of input
-        # @option options [Float, Optional] :min_confidence with which to consider a response acceptable
-        #
-        # @return [Command::Ask] a formatted Rayo ask command
-        #
-        # @example
-        #    ask :prompt      => {:text => 'Please enter your postal code.', :voice => 'simon'},
-        #        :choices     => {:value => '[5 DIGITS]'},
-        #        :timeout     => 30,
-        #        :recognizer  => 'es-es'
-        #
-        #    returns:
-        #      <ask xmlns="urn:xmpp:tropo:ask:1" timeout="30" recognizer="es-es">
-        #        <prompt voice='simon'>Please enter your postal code.</prompt>
-        #        <choices content-type="application/grammar+voxeo">[5 DIGITS]</choices>
-        #      </ask>
-        #
-        def self.new(options = {})
-          super().tap do |new_node|
-            options.each_pair { |k,v| new_node.send :"#{k}=", v }
-          end
-        end
-
-        ##
-        # @return [Boolean] wether or not to allow the caller to begin their response before the prompt finishes
-        #
-        def bargein
-          read_attr(:bargein) == "true"
-        end
-
-        ##
-        # @param [Boolean] bargein wether or not to allow the caller to begin their response before the prompt finishes
-        #
-        def bargein=(bargein)
-          write_attr :bargein, bargein.to_s
-        end
-
-        ##
-        # @return [Float] Confidence with which to consider a response acceptable
-        #
-        def min_confidence
-          read_attr 'min-confidence', :to_f
-        end
-
-        ##
-        # @param [Float] min_confidence with which to consider a response acceptable
-        #
-        def min_confidence=(min_confidence)
-          write_attr 'min-confidence', min_confidence
-        end
-
-        ##
-        # @return [Symbol] mode by which to accept input. Can be :speech, :dtmf or :any
-        #
-        def mode
-          read_attr :mode, :to_sym
-        end
-
-        ##
-        # @param [Symbol] mode by which to accept input. Can be :speech, :dtmf or :any
-        #
-        def mode=(mode)
-          write_attr :mode, mode
-        end
-
-        ##
-        # @return [String] recognizer to use for speech recognition
-        #
-        def recognizer
-          read_attr :recognizer
-        end
-
-        ##
-        # @param [String] recognizer to use for speech recognition
-        #
-        def recognizer=(recognizer)
-          write_attr :recognizer, recognizer
-        end
-
-        ##
-        # @return [String] terminator by which to signal the end of input
-        #
-        def terminator
-          read_attr :terminator
-        end
-
-        ##
-        # @param [String] terminator by which to signal the end of input
-        #
-        def terminator=(terminator)
-          write_attr :terminator, terminator
-        end
-
-        ##
-        # @return [Integer] timeout to wait for user input
-        #
-        def timeout
-          read_attr :timeout, :to_i
-        end
-
-        ##
-        # @param [Integer] timeout to wait for user input
-        #
-        def timeout=(timeout)
-          write_attr :timeout, timeout
-        end
-
-        ##
-        # @return [Prompt] the prompt by which to introduce the question
-        #
-        def prompt
-          Prompt.new find_first('//ns:prompt', :ns => self.registered_ns)
-        end
-
-        ##
-        # @param [Hash] p
-        # @option p [String] :text to read the caller via TTS as the question
-        # @option p [String] :voice to use for speech synthesis
-        #
-        def prompt=(p)
-          remove_children :prompt
-          p = Prompt.new(p) unless p.is_a?(Prompt)
-          self << p
-        end
-
-        class Prompt < MediaNode
-          register :prompt, :ask
-        end
-
-        ##
-        # @return [Choices] the choices available
-        #
-        def choices
-          node = find_first 'ns:choices', :ns => self.class.registered_ns
-          Choices.new node if node
-        end
-
-        ##
-        # @param [Hash] choices
-        # @option choices [String] :content_type
-        # @option choices [String] :value the choices available
-        #
-        def choices=(choices)
-          return unless choices
-          remove_children :choices
-          choices = Choices.new(choices) unless choices.is_a?(Choices)
-          self << choices
-        end
-
-        def inspect_attributes # :nodoc:
-          [:bargein, :min_confidence, :mode, :recognizer, :terminator, :timeout, :prompt, :choices] + super
-        end
-
-        class Choices < Input::Grammar
-          ##
-          # @param [Hash] options
-          # @option options [String] :content_type
-          # @option options [String] :value the choices available
-          #
-          def self.new(options = {})
-            super(options).tap do |new_node|
-              new_node.name = 'choices'
-            end
-          end
-        end # Choices
-
-        class Complete
-          class Success < Input::Complete::Success
-            register :success, :ask_complete
-          end
-
-          class NoMatch < Input::Complete::NoMatch
-            register :nomatch, :ask_complete
-          end
-
-          class NoInput < Input::Complete::NoInput
-            register :noinput, :ask_complete
-          end
-        end # Complete
-      end # Ask
-    end # Tropo
-  end # Command
-end # Punchblock

data/lib/punchblock/component/tropo/say.rb

@@ -1,113 +0,0 @@
-module Punchblock
-  module Component
-    module Tropo
-      class Say < ComponentNode
-        register :say, :say
-
-        include MediaContainer
-
-        ##
-        # Creates an Rayo Say command
-        #
-        # @param [Hash] options
-        # @option options [String, Optional] :text to speak back
-        # @option options [String, Optional] :voice with which to render TTS
-        # @option options [String, Optional] :ssml document to render TTS
-        #
-        # @return [Command::Say] an Rayo "say" command
-        #
-        # @example
-        #   say :text => 'Hello brown cow.'
-        #
-        #   returns:
-        #     <say xmlns="urn:xmpp:tropo:say:1">Hello brown cow.</say>
-        #
-        def self.new(options = {})
-          super().tap do |new_node|
-            case options
-            when Hash
-              new_node.voice = options.delete(:voice) if options[:voice]
-              new_node.ssml = options.delete(:ssml) if options[:ssml]
-              new_node << options.delete(:text) if options[:text]
-            when Nokogiri::XML::Element
-              new_node.inherit options
-            end
-          end
-        end
-
-        state_machine :state do
-          event :paused do
-            transition :executing => :paused
-          end
-
-          event :resumed do
-            transition :paused => :executing
-          end
-        end
-
-        # Pauses a running Say
-        #
-        # @return [Command::Say::Pause] an Rayo pause message for the current Say
-        #
-        # @example
-        #    say_obj.pause_action.to_xml
-        #
-        #    returns:
-        #      <pause xmlns="urn:xmpp:tropo:say:1"/>
-        def pause_action
-          Pause.new :component_id => component_id, :call_id => call_id
-        end
-
-        ##
-        # Sends an Rayo pause message for the current Say
-        #
-        def pause!
-          raise InvalidActionError, "Cannot pause a Say that is not executing" unless executing?
-          pause_action.tap do |action|
-            result = write_action action
-            paused! if result
-          end
-        end
-
-        ##
-        # Create an Rayo resume message for the current Say
-        #
-        # @return [Command::Say::Resume] an Rayo resume message
-        #
-        # @example
-        #    say_obj.resume_action.to_xml
-        #
-        #    returns:
-        #      <resume xmlns="urn:xmpp:tropo:say:1"/>
-        def resume_action
-          Resume.new :component_id => component_id, :call_id => call_id
-        end
-
-        ##
-        # Sends an Rayo resume message for the current Say
-        #
-        def resume!
-          raise InvalidActionError, "Cannot resume a Say that is not paused." unless paused?
-          resume_action.tap do |action|
-            result = write_action action
-            resumed! if result
-          end
-        end
-
-        class Pause < CommandNode # :nodoc:
-          register :pause, :say
-        end
-
-        class Resume < CommandNode # :nodoc:
-          register :resume, :say
-        end
-
-        class Complete
-          class Success < Event::Complete::Reason
-            register :success, :say_complete
-          end
-        end
-      end # Say
-    end # Tropo
-  end # Command
-end # Punchblock

data/lib/punchblock/component/tropo/transfer.rb

@@ -1,178 +0,0 @@
-module Punchblock
-  module Component
-    module Tropo
-      class Transfer < ComponentNode
-        register :transfer, :transfer
-
-        include HasHeaders
-
-        ##
-        # Creates an Rayo transfer command
-        #
-        # @param [Hash] options for transferring a call
-        # @option options [String, Array[String]] :to The destination(s) for the call transfer (ie - tel:+14155551212 or sip:you@sip.tropo.com). Can be an array to hunt.
-        # @option options [String] :from The caller ID for the call transfer (ie - tel:+14155551212 or sip:you@sip.tropo.com)
-        # @option options [String, Optional] :terminator The string key press required to abort the transfer.
-        # @option options [Integer, Optional] :timeout How long to wait - in seconds - for an answer, busy signal, or other event to occur.
-        # @option options [Boolean, Optional] :answer_on_media If set to true, the call will be considered "answered" and audio will begin playing as soon as media is received from the far end (ringing / busy signal / etc)
-        # @option options [Symbol, Optional] :media Rules for handling media. Can be :direct, where parties negotiate media directly, or :bridge where the media server will bridge audio, allowing media features like recording and ASR.
-        # @option options [Ring, Hash, Optional] :ring to play to the caller untill connected
-        #
-        # @return [Message::Transfer] an Rayo "transfer" message
-        #
-        # @example
-        #   Transfer.new(:to => 'sip:you@yourdomain.com', :from => 'sip:myapp@mydomain.com', :terminator => '#').to_xml
-        #
-        #   returns:
-        #     <transfer xmlns="urn:xmpp:tropo:transfer:1" from="sip:myapp@mydomain.com" terminator="#">
-        #       <to>sip:you@yourdomain.com</to>
-        #     </transfer>
-        #
-        def self.new(options = {})
-          super().tap do |new_node|
-            options.each_pair { |k,v| new_node.send :"#{k}=", v }
-          end
-        end
-
-        ##
-        # @return [Array[String]] The destination(s) for the call transfer
-        #
-        def to
-          find('ns:to', :ns => self.class.registered_ns).map &:text
-        end
-
-        ##
-        # @param [String, Array[String]] :to The destination(s) for the call transfer (ie - tel:+14155551212 or sip:you@sip.tropo.com). Can be an array to hunt.
-        #
-        def to=(transfer_to)
-          find('//ns:to', :ns => self.class.registered_ns).each &:remove
-          if transfer_to
-            [transfer_to].flatten.each do |i|
-              to = RayoNode.new :to
-              to << i
-              self << to
-            end
-          end
-        end
-
-        ##
-        # @return [String] The caller ID for the call transfer
-        #
-        def from
-          read_attr :from
-        end
-
-        ##
-        # @param [String, Array[String]] :to The destination(s) for the call transfer (ie - tel:+14155551212 or sip:you@sip.tropo.com). Can be an array to hunt.
-        #
-        def from=(transfer_from)
-          write_attr :from, transfer_from
-        end
-
-        ##
-        # @return [String] The string key press required to abort the transfer.
-        #
-        def terminator
-          read_attr :terminator
-        end
-
-        ##
-        # @param [String] terminator The string key press required to abort the transfer.
-        #
-        def terminator=(terminator)
-          write_attr :terminator, terminator
-        end
-
-        ##
-        # @return [Integer] How long to wait - in seconds - for an answer, busy signal, or other event to occur.
-        #
-        def timeout
-          read_attr :timeout, :to_i
-        end
-
-        ##
-        # @param [Integer] timeout How long to wait - in seconds - for an answer, busy signal, or other event to occur.
-        #
-        def timeout=(timeout)
-          write_attr :timeout, timeout
-        end
-
-        ##
-        # @return [Boolean] If true, the call will be considered "answered" and audio will begin playing as soon as media is received from the far end (ringing / busy signal / etc)
-        #
-        def answer_on_media
-          read_attr('answer-on-media') == 'true'
-        end
-
-        ##
-        # @param [Boolean] aom If set to true, the call will be considered "answered" and audio will begin playing as soon as media is received from the far end (ringing / busy signal / etc)
-        #
-        def answer_on_media=(aom)
-          write_attr 'answer-on-media', aom.to_s
-        end
-
-        ##
-        # @return [Symbol] Rules for handling media. Can be :direct, where parties negotiate media directly, or :bridge where the media server will bridge audio, allowing media features like recording and ASR.
-        #
-        def media
-          read_attr 'media', :to_sym
-        end
-
-        ##
-        # @param [Symbol] media Rules for handling media. Can be :direct, where parties negotiate media directly, or :bridge where the media server will bridge audio, allowing media features like recording and ASR.
-        #
-        def media=(media)
-          write_attr 'media', media
-        end
-
-        ##
-        # @return [Ring] the ringer to play to the caller while transferring
-        #
-        def ring
-          node = find_first '//ns:ring', :ns => self.registered_ns
-          Ring.new node if node
-        end
-
-        ##
-        # @param [Hash] ring
-        # @option ring [String] :text Text to speak to the caller as an announcement
-        # @option ring [String] :url URL to play to the caller as an announcement
-        #
-        def ring=(ring)
-          ring = Ring.new(ring) unless ring.is_a?(Ring)
-          self << ring
-        end
-
-        class Ring < Say
-          register :ring, :transfer
-        end
-
-        def inspect_attributes # :nodoc:
-          [:to, :from, :terminator, :timeout, :answer_on_media] + super
-        end
-
-        class Complete
-          class Success < Event::Complete::Reason
-            register :success, :transfer_complete
-          end
-
-          class Timeout < Event::Complete::Reason
-            register :timeout, :transfer_complete
-          end
-
-          class Terminator < Event::Complete::Reason
-            register :terminator, :transfer_complete
-          end
-
-          class Busy < Event::Complete::Reason
-            register :busy, :transfer_complete
-          end
-
-          class Reject < Event::Complete::Reason
-            register :reject, :transfer_complete
-          end
-        end
-      end # Transfer
-    end # Tropo
-  end # Command
-end # Punchblock