punchblock 1.4.1 → 1.5.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.5.0](https://github.com/adhearsion/punchblock/compare/v1.4.1...v1.5.0) - [2012-10-01](https://rubygems.org/gems/punchblock/versions/1.5.0)
+  * Feature: Input component now supports grammar URLs
+  * Bugfix: Hanging up Asterisk calls now correctly specifies normal clearing cause
+  * Doc: Fix a bunch of API documentation
+
 # [v1.4.1](https://github.com/adhearsion/punchblock/compare/v1.4.0...v1.4.1) - [2012-09-06](https://rubygems.org/gems/punchblock/versions/1.4.1)
   * Bugfix: Cleaning up DTMF handlers for input components with a dead call should not crash on FreeSWITCH
   * Bugfix: Reduced a race condition on FreeSWITCH when dispatching events from calls to dead components

data/README.markdown

@@ -1,7 +1,7 @@
 # Punchblock
 Punchblock is a middleware library for telephony applications. Like Rack is to Rails and Sinatra, Punchblock provides a consistent API on top of several underlying third-party call control protocols.
 
-In the same spirit that inspired Rack, the Punchblock library is envisioned to be the single library for call control wiring. Frameworks and applications may take advantage of Punchblock's single API to write powerful code for managing calls. Punchblock is not and will not be an application framework; rather it only surfaces the various protocols and presents a consistent interface to its consumers.
+In the same spirit that inspired Rack, the Punchblock library is envisioned to be the single library for call control wiring. Frameworks and applications may take advantage of Punchblock's single API to write powerful code for managing calls. Punchblock is not and will not be an application framework; rather it only surfaces the various protocols and presents a consistent interface to its consumers. NB: If you're looking to develop an application, you should take a look at the [Adhearsion](http://adhearsion.com) framework first. This library is much lower level.
 
 ## Installation
     gem install punchblock
@@ -14,6 +14,7 @@ The best available usage documentation available for Punchblock is by example, i
 
 * Rayo
 * Asterisk (AMI & AsyncAGI)
+* FreeSWITCH (Inbound Event Socket)
 
 ## Links:
 * [Source](https://github.com/adhearsion/punchblock)

data/lib/punchblock.rb

@@ -22,7 +22,6 @@ module Punchblock
   autoload :DisconnectedError
   autoload :HasHeaders
   autoload :Header
-  autoload :MediaContainer
   autoload :MediaNode
   autoload :ProtocolError
   autoload :RayoNode

data/lib/punchblock/command/accept.rb

@@ -8,7 +8,7 @@ module Punchblock
       include HasHeaders
 
       ##
-      # Create an Rayo accept command. This is equivalent to a SIP "180 Trying"
+      # Create a Rayo accept command. This is equivalent to a SIP "180 Trying"
       #
       # @param [Hash] options
       # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to

data/lib/punchblock/command/answer.rb

@@ -8,7 +8,7 @@ module Punchblock
       include HasHeaders
 
       ##
-      # Create an Rayo answer command. This is equivalent to a SIP "200 OK"
+      # Create a Rayo answer command. This is equivalent to a SIP "200 OK"
       #
       # @param [Hash] options
       # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to

data/lib/punchblock/command/dial.rb

@@ -8,7 +8,7 @@ module Punchblock
       include HasHeaders
 
       ##
-      # Create a dial message
+      # Create a dial command
       #
       # @param [Hash] options
       # @option options [String] :to destination to dial

data/lib/punchblock/command/hangup.rb

@@ -8,7 +8,7 @@ module Punchblock
       include HasHeaders
 
       ##
-      # Create an Rayo hangup message
+      # Create a Rayo hangup command
       #
       # @param [Hash] options
       # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to

data/lib/punchblock/command/join.rb

@@ -6,7 +6,7 @@ module Punchblock
       register :join, :core
 
       ##
-      # Create a join message
+      # Create a join command
       #
       # @param [Hash] options
       # @option options [String, Optional] :call_id the call ID to join

data/lib/punchblock/command/redirect.rb

@@ -8,7 +8,7 @@ module Punchblock
       include HasHeaders
 
       ##
-      # Create an Rayo redirect message
+      # Create a Rayo redirect command
       #
       # @param [Hash] options
       # @option options [String] :to redirect target

data/lib/punchblock/command/reject.rb

@@ -10,7 +10,7 @@ module Punchblock
       VALID_REASONS = [:busy, :decline, :error].freeze
 
       ##
-      # Create an Rayo reject message
+      # Create a Rayo reject command
       #
       # @param [Hash] options
       # @option options [Symbol] :reason for rejecting the call. Can be any one of VALID_REASONS. Defaults to :decline

data/lib/punchblock/command/unjoin.rb

@@ -6,7 +6,7 @@ module Punchblock
       register :unjoin, :core
 
       ##
-      # Create an ujoin message
+      # Create an ujoin command
       #
       # @param [Hash] options
       # @option options [String, Optional] :call_id the call ID to unjoin

data/lib/punchblock/component/component_node.rb

@@ -54,16 +54,16 @@ module Punchblock
       end
 
       ##
-      # Create an Rayo stop message
+      # Create a Rayo stop message
       #
-      # @return [Stop] an Rayo stop message
+      # @return [Stop] a Rayo stop message
       #
       def stop_action
         Stop.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##
-      # Sends an Rayo stop message for the current component
+      # Sends a Rayo stop message for the current component
       #
       def stop!(options = {})
         raise InvalidActionError, "Cannot stop a #{self.class.name.split("::").last} that is not executing" unless executing?

data/lib/punchblock/component/input.rb

@@ -6,30 +6,29 @@ module Punchblock
       register :input, :input
 
       ##
-      # Create an input message
+      # Create a input command
       #
-      # @param [Hash] options for inputing/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
+      # @param [Hash] options
+      # @option options [Grammar, Hash] :grammar the grammar to activate
+      # @option options [Integer, optional] :max_silence the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH
+      # @option options [Float, optional] :min_confidence with which to consider a response acceptable
+      # @option options [Symbol, optional] :mode by which to accept input. Can be :speech, :dtmf or :any
+      # @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] :sensitivity Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.
+      # @option options [Integer, optional] :initial_timeout Indicates the amount of time preceding input which may expire before a timeout is triggered.
+      # @option options [Integer, optional] :inter_digit_timeout Indicates (in the case of DTMF input) the amount of time between input digits which may expire before a timeout is triggered.
       #
       # @return [Command::Input] a formatted Rayo input command
       #
       # @example
-      #    input :prompt      => {:text => 'Please enter your postal code.', :voice => 'simon'},
-      #          :choices     => {:value => '[5 DIGITS]'},
-      #          :timeout     => 30,
+      #    input :grammar     => {:value => '[5 DIGITS]', :content_type => 'application/grammar+voxeo'},
+      #          :mode        => :speech,
       #          :recognizer  => 'es-es'
       #
       #    returns:
-      #      <input xmlns="urn:xmpp:tropo:input:1" timeout="30" recognizer="es-es">
-      #        <prompt voice='simon'>Please enter your postal code.</prompt>
-      #        <choices content-type="application/grammar+voxeo">[5 DIGITS]</choices>
+      #      <input xmlns="urn:xmpp:rayo:input:1" mode="speech" recognizer="es-es">
+      #        <grammar content-type="application/grammar+voxeo">[5 DIGITS]</choices>
       #      </input>
       #
       def self.new(options = {})
@@ -38,20 +37,6 @@ module Punchblock
         end
       end
 
-      ##
-      # @return [Boolean] wether or not to allow the caller to begin their response before the prompt finishes
-      #
-      def max_digits
-        read_attr :'max-digits', :to_i
-      end
-
-      ##
-      # @param [Boolean] bargein wether or not to allow the caller to begin their response before the prompt finishes
-      #
-      def max_digits=(other)
-        write_attr :'max-digits', other
-      end
-
       ##
       # @return [Integer] the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH
       #
@@ -123,91 +108,49 @@ module Punchblock
       end
 
       ##
-      # @return [Integer] timeout to wait for user input
+      # @return [Float] Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.
       #
       def sensitivity
         read_attr :sensitivity, :to_f
       end
 
       ##
-      # @param [Integer] timeout to wait for user input
+      # @param [Float] other Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.
       #
       def sensitivity=(other)
         write_attr :sensitivity, other
       end
 
       ##
-      # @return [Integer] timeout to wait for user input
+      # @return [Integer] Indicates the amount of time preceding input which may expire before a timeout is triggered.
       #
       def initial_timeout
         read_attr :'initial-timeout', :to_i
       end
 
       ##
-      # @param [Integer] timeout to wait for user input
+      # @param [Integer] timeout Indicates the amount of time preceding input which may expire before a timeout is triggered.
       #
       def initial_timeout=(other)
         write_attr :'initial-timeout', other
       end
 
       ##
-      # @return [Integer] timeout to wait for user input
+      # @return [Integer] Indicates (in the case of DTMF input) the amount of time between input digits which may expire before a timeout is triggered.
       #
       def inter_digit_timeout
         read_attr :'inter-digit-timeout', :to_i
       end
 
       ##
-      # @param [Integer] timeout to wait for user input
+      # @param [Integer] timeout Indicates (in the case of DTMF input) the amount of time between input digits which may expire before a timeout is triggered.
       #
       def inter_digit_timeout=(other)
         write_attr :'inter-digit-timeout', other
       end
 
       ##
-      # @return [Integer] timeout to wait for user input
-      #
-      def term_timeout
-        read_attr :'term-timeout', :to_i
-      end
-
-      ##
-      # @param [Integer] timeout to wait for user input
-      #
-      def term_timeout=(other)
-        write_attr :'term-timeout', other
-      end
-
-      ##
-      # @return [Integer] timeout to wait for user input
-      #
-      def complete_timeout
-        read_attr :'complete-timeout', :to_i
-      end
-
-      ##
-      # @param [Integer] timeout to wait for user input
-      #
-      def complete_timeout=(other)
-        write_attr :'complete-timeout', other
-      end
-
-      ##
-      # @return [Integer] timeout to wait for user input
-      #
-      def incomplete_timeout
-        read_attr :'incomplete-timeout', :to_i
-      end
-
-      ##
-      # @param [Integer] timeout to wait for user input
-      #
-      def incomplete_timeout=(other)
-        write_attr :'incomplete-timeout', other
-      end
-
-      ##
-      # @return [Choices] the choices available
+      # @return [Grammar] the grammar to activate
       #
       def grammar
         node = find_first 'ns:grammar', :ns => self.class.registered_ns
@@ -215,9 +158,10 @@ module Punchblock
       end
 
       ##
-      # @param [Hash] choices
-      # @option choices [String] :content_type
-      # @option choices [String] :value the choices available
+      # @param [Hash] other
+      # @option other [String] :content_type the document content type
+      # @option other [String] :value the grammar doucment
+      # @option other [String] :url the url from which to fetch the grammar
       #
       def grammar=(other)
         return unless other
@@ -227,14 +171,15 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:mode, :terminator, :max_digits, :recognizer, :initial_timeout, :inter_digit_timeout, :term_timeout, :complete_timeout, :incomplete_timeout, :sensitivity, :min_confidence, :grammar] + super
+        [:mode, :terminator, :recognizer, :initial_timeout, :inter_digit_timeout, :sensitivity, :min_confidence, :grammar] + super
       end
 
       class Grammar < RayoNode
         ##
         # @param [Hash] options
-        # @option options [String] :content_type
-        # @option options [String] :value the choices available
+        # @option options [String] :content_type the document content type
+        # @option options [String] :value the grammar document
+        # @option options [String] :url the url from which to fetch the grammar
         #
         def self.new(options = {})
           super(:grammar).tap do |new_node|
@@ -244,12 +189,13 @@ module Punchblock
             when Hash
               new_node.content_type = options[:content_type]
               new_node.value = options[:value]
+              new_node.url = options[:url]
             end
           end
         end
 
         ##
-        # @return [String] the choice content type
+        # @return [String] the document content type
         #
         def content_type
           read_attr 'content-type'
@@ -263,8 +209,9 @@ module Punchblock
         end
 
         ##
-        # @return [String] the choices available
+        # @return [String, RubySpeech::GRXML::Grammar] the grammar document
         def value
+          return nil unless content.present?
           if grxml?
             RubySpeech::GRXML.import content
           else
@@ -273,7 +220,7 @@ module Punchblock
         end
 
         ##
-        # @param [String] value the choices available
+        # @param [String, RubySpeech::GRXML::Grammar] value the grammar document
         def value=(value)
           return unless value
           if grxml? && !value.is_a?(RubySpeech::GRXML::Element)
@@ -284,15 +231,22 @@ module Punchblock
           end
         end
 
-        # Compare two Choices objects by content type, and value
-        # @param [Header] o the Choices object to compare against
-        # @return [true, false]
-        def eql?(o, *fields)
-          super o, *(fields + [:content_type, :value])
+        ##
+        # @return [String] the URL from which the fetch the grammar
+        #
+        def url
+          read_attr 'url'
+        end
+
+        ##
+        # @param [String] other the URL from which the fetch the grammar
+        #
+        def url=(other)
+          write_attr 'url', other
         end
 
         def inspect_attributes # :nodoc:
-          [:content_type, :value] + super
+          [:content_type, :value, :url] + super
         end
 
         private

data/lib/punchblock/component/output.rb

@@ -5,8 +5,6 @@ module Punchblock
     class Output < ComponentNode
       register :output, :output
 
-      include MediaContainer
-
       ##
       # Creates an Rayo Output command
       #
@@ -14,6 +12,12 @@ module Punchblock
       # @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
+      # @option options [Symbol] :interrupt_on input type on which to interrupt output. May be :speech, :dtmf or :any
+      # @option options [Integer] :start_offset Indicates some offset through which the output should be skipped before rendering begins.
+      # @option options [true, false] :start_paused Indicates wether or not the component should be started in a paused state to be resumed at a later time.
+      # @option options [Integer] :repeat_interval Indicates the duration of silence that should space repeats of the rendered document.
+      # @option options [Integer] :repeat_times Indicates the number of times the output should be played.
+      # @option options [Integer] :max_time Indicates the maximum amount of time for which the output should be allowed to run before being terminated. Includes repeats.
       #
       # @return [Command::Output] an Rayo "output" command
       #
@@ -21,13 +25,12 @@ module Punchblock
       #   output :text => 'Hello brown cow.'
       #
       #   returns:
-      #     <output xmlns="urn:xmpp:tropo:output:1">Hello brown cow.</output>
+      #     <output xmlns="urn:xmpp:rayo:output:1">Hello brown cow.</output>
       #
       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]
             options.each_pair { |k,v| new_node.send :"#{k}=", v }
@@ -40,89 +43,122 @@ module Punchblock
       ##
       # @return [String] the TTS voice to use
       #
+      def voice
+        read_attr :voice
+      end
+
+      ##
+      # @param [String] voice to use when rendering TTS
+      #
+      def voice=(voice)
+        write_attr :voice, voice
+      end
+
+      ##
+      # @return [String] the SSML document to render TTS
+      #
+      def ssml
+        node = children.first
+        RubySpeech::SSML.import node if node
+      end
+
+      ##
+      # @param [String] ssml the SSML document to render TTS
+      #
+      def ssml=(ssml)
+        return unless ssml
+        unless ssml.is_a?(RubySpeech::SSML::Element)
+          ssml = RubySpeech::SSML.import ssml
+        end
+        self << ssml
+      end
+
+      ##
+      # @return [Symbol] input type on which to interrupt output
+      #
       def interrupt_on
         read_attr :'interrupt-on', :to_sym
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [Symbol] other input type on which to interrupt output. May be :speech, :dtmf or :any
       #
       def interrupt_on=(other)
         write_attr :'interrupt-on', other
       end
 
       ##
-      # @return [String] the TTS voice to use
+      # @return [Integer] Indicates some offset through which the output should be skipped before rendering begins.
       #
       def start_offset
         read_attr :'start-offset', :to_i
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [Integer] other Indicates some offset through which the output should be skipped before rendering begins.
       #
       def start_offset=(other)
         write_attr :'start-offset', other
       end
 
       ##
-      # @return [String] the TTS voice to use
+      # @return [true, false] Indicates wether or not the component should be started in a paused state to be resumed at a later time.
       #
       def start_paused
         read_attr(:'start-paused') == 'true'
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [true, false] other Indicates wether or not the component should be started in a paused state to be resumed at a later time.
       #
       def start_paused=(other)
         write_attr :'start-paused', other.to_s
       end
 
       ##
-      # @return [String] the TTS voice to use
+      # @return [Integer] Indicates the duration of silence that should space repeats of the rendered document.
       #
       def repeat_interval
         read_attr :'repeat-interval', :to_i
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [Integer] other Indicates the duration of silence that should space repeats of the rendered document.
       #
       def repeat_interval=(other)
         write_attr :'repeat-interval', other
       end
 
       ##
-      # @return [String] the TTS voice to use
+      # @return [Integer] Indicates the number of times the output should be played.
       #
       def repeat_times
         read_attr :'repeat-times', :to_i
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [Integer] other Indicates the number of times the output should be played.
       #
       def repeat_times=(other)
         write_attr :'repeat-times', other
       end
 
       ##
-      # @return [String] the TTS voice to use
+      # @return [Integer] Indicates the maximum amount of time for which the output should be allowed to run before being terminated. Includes repeats.
       #
       def max_time
         read_attr :'max-time', :to_i
       end
 
       ##
-      # @param [String] voice to use when rendering TTS
+      # @param [Integer] other Indicates the maximum amount of time for which the output should be allowed to run before being terminated. Includes repeats.
       #
       def max_time=(other)
         write_attr :'max-time', other
       end
 
       def inspect_attributes
-        super + [:interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time]
+        super + [:voice, :ssml, :interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time]
       end
 
       state_machine :state do
@@ -143,7 +179,7 @@ module Punchblock
       #    output_obj.pause_action.to_xml
       #
       #    returns:
-      #      <pause xmlns="urn:xmpp:tropo:output:1"/>
+      #      <pause xmlns="urn:xmpp:rayo:output:1"/>
       def pause_action
         Pause.new :component_id => component_id, :target_call_id => target_call_id
       end
@@ -168,7 +204,7 @@ module Punchblock
       #    output_obj.resume_action.to_xml
       #
       #    returns:
-      #      <resume xmlns="urn:xmpp:tropo:output:1"/>
+      #      <resume xmlns="urn:xmpp:rayo:output:1"/>
       def resume_action
         Resume.new :component_id => component_id, :target_call_id => target_call_id
       end

data/lib/punchblock/component/record.rb

@@ -9,11 +9,14 @@ module Punchblock
       # Creates an Rayo Record 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
+      # @option options [String] :format to use for recording
+      # @option options [Integer] :initial_timeout Controls how long the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
+      # @option options [Integer] :final_timeout Controls the length of a period of silence after callers have spoken to conclude they finished.
+      # @option options [Integer] :max_duration Indicates the maximum duration for the recording.
+      # @option options [true, false] :start_beep Indicates whether subsequent record will be preceded with a beep.
+      # @option options [true, false] :start_paused Whether subsequent record will start in PAUSE mode.
       #
-      # @return [Command::Record] an Rayo "record" command
+      # @return [Command::Record] a Rayo "record" command
       #
       # @example
       #   record :text => 'Hello brown cow.'
@@ -28,14 +31,14 @@ module Punchblock
       end
 
       ##
-      # @return [String] the codec to use for recording
+      # @return [Integer] Controls the length of a period of silence after callers have spoken to conclude they finished.
       #
       def final_timeout
         read_attr :'final-timeout', :to_i
       end
 
       ##
-      # @param [String] codec to use for recording
+      # @param [Integer] timeout Controls the length of a period of silence after callers have spoken to conclude they finished.
       #
       def final_timeout=(timeout)
         write_attr :'final-timeout', timeout
@@ -56,77 +59,63 @@ module Punchblock
       end
 
       ##
-      # @return [String] the codec to use for recording
+      # @return [Integer] Controls how long the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
       #
       def initial_timeout
         read_attr :'initial-timeout', :to_i
       end
 
       ##
-      # @param [String] codec to use for recording
+      # @param [Integer] timeout Controls how long the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
       #
       def initial_timeout=(timeout)
         write_attr :'initial-timeout', timeout
       end
 
       ##
-      # @return [String] the codec to use for recording
+      # @return [Integer] Indicates the maximum duration for the recording.
       #
       def max_duration
         read_attr :'max-duration', :to_i
       end
 
       ##
-      # @param [String] codec to use for recording
+      # @param [Integer] other Indicates the maximum duration for the recording.
       #
       def max_duration=(other)
         write_attr :'max-duration', other
       end
 
       ##
-      # @return [String] the codec to use for recording
+      # @return [true, false] Indicates whether subsequent record will be preceded with a beep.
       #
       def start_beep
         read_attr(:'start-beep') == 'true'
       end
 
       ##
-      # @param [String] codec to use for recording
+      # @param [true, false] sb Indicates whether subsequent record will be preceded with a beep.
       #
       def start_beep=(sb)
         write_attr :'start-beep', sb
       end
 
       ##
-      # @return [String] the codec to use for recording
-      #
-      def stop_beep
-        read_attr(:'stop-beep') == 'true'
-      end
-
-      ##
-      # @param [String] codec to use for recording
-      #
-      def stop_beep=(sb)
-        write_attr :'stop-beep', sb
-      end
-
-      ##
-      # @return [String] the codec to use for recording
+      # @return [true, false] Whether subsequent record will start in PAUSE mode.
       #
       def start_paused
         read_attr(:'start-paused') == 'true'
       end
 
       ##
-      # @param [String] codec to use for recording
+      # @param [true, false] other Whether subsequent record will start in PAUSE mode.
       #
       def start_paused=(other)
         write_attr :'start-paused', other
       end
 
       def inspect_attributes # :nodoc:
-        [:final_timeout, :format, :initial_timeout, :max_duration, :start_beep, :start_paused, :stop_beep] + super
+        [:final_timeout, :format, :initial_timeout, :max_duration, :start_beep, :start_paused] + super
       end
 
       state_machine :state do
@@ -191,15 +180,15 @@ module Punchblock
       ##
       # Directly returns the recording for the component
       # @return [Punchblock::Component::Record::Recording] The recording object
-      # 
+      #
       def recording
         complete_event.recording
       end
-      
+
       ##
       # Directly returns the recording URI for the component
       # @return [String] The recording URI
-      # 
+      #
       def recording_uri
         recording.uri
       end

data/lib/punchblock/event/complete.rb

@@ -3,10 +3,6 @@
 module Punchblock
   class Event
     class Complete < Event
-      # TODO: Validate response and return response type.
-      # -----
-      # <complete xmlns="urn:xmpp:rayo:ext:1"/>
-
       register :complete, :ext
 
       def reason

data/lib/punchblock/translator/asterisk/call.rb

@@ -175,7 +175,7 @@ module Punchblock
               command.response = true
             end
           when Command::Hangup
-            send_ami_action 'Hangup', 'Channel' => channel do |response|
+            send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => 16 do |response|
               command.response = true
             end
           when Command::Join

data/lib/punchblock/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Punchblock
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/punchblock.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<state_machine>, ["~> 1.0"]
   s.add_runtime_dependency %q<future-resource>, ["~> 1.0"]
   s.add_runtime_dependency %q<has-guarded-handlers>, ["~> 1.3"]
-  s.add_runtime_dependency %q<celluloid>, [">= 0.11.1"]
+  s.add_runtime_dependency %q<celluloid>, ["~> 0.11.1"]
   s.add_runtime_dependency %q<ruby_ami>, ["~> 1.2", ">= 1.2.1", "< 1.2.2"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.0", "< 1.0.1"]
   s.add_runtime_dependency %q<ruby_speech>, ["~> 1.0"]

data/spec/punchblock/component/input_spec.rb

@@ -14,14 +14,10 @@ module Punchblock
           Input.new :grammar              => {:value => '[5 DIGITS]', :content_type => 'application/grammar+custom'},
                     :mode                 => :speech,
                     :terminator           => '#',
-                    :max_digits           => 10,
                     :max_silence          => 1000,
                     :recognizer           => 'en-US',
                     :initial_timeout      => 2000,
                     :inter_digit_timeout  => 2000,
-                    :term_timeout         => 2000,
-                    :complete_timeout     => 2000,
-                    :incomplete_timeout   => 2000,
                     :sensitivity          => 0.5,
                     :min_confidence       => 0.5
         end
@@ -29,14 +25,10 @@ module Punchblock
         its(:grammar)             { should be == Input::Grammar.new(:value => '[5 DIGITS]', :content_type => 'application/grammar+custom') }
         its(:mode)                { should be == :speech }
         its(:terminator)          { should be == '#' }
-        its(:max_digits)          { should be == 10 }
         its(:max_silence)         { should be == 1000 }
         its(:recognizer)          { should be == 'en-US' }
         its(:initial_timeout)     { should be == 2000 }
         its(:inter_digit_timeout) { should be == 2000 }
-        its(:term_timeout)        { should be == 2000 }
-        its(:complete_timeout)    { should be == 2000 }
-        its(:incomplete_timeout)  { should be == 2000 }
         its(:sensitivity)         { should be == 0.5 }
         its(:min_confidence)      { should be == 0.5 }
       end
@@ -47,14 +39,10 @@ module Punchblock
 <input xmlns="urn:xmpp:rayo:input:1"
        mode="speech"
        terminator="#"
-       max-digits="10"
        max-silence="1000"
        recognizer="en-US"
        initial-timeout="2000"
        inter-digit-timeout="2000"
-       term-timeout="2000"
-       complete-timeout="2000"
-       incomplete-timeout="2000"
        sensitivity="0.5"
        min-confidence="0.5">
   <grammar content-type="application/grammar+custom">
@@ -71,14 +59,10 @@ module Punchblock
         its(:grammar)             { should be == Input::Grammar.new(:value => '[5 DIGITS]', :content_type => 'application/grammar+custom') }
         its(:mode)                { should be == :speech }
         its(:terminator)          { should be == '#' }
-        its(:max_digits)          { should be == 10 }
         its(:max_silence)         { should be == 1000 }
         its(:recognizer)          { should be == 'en-US' }
         its(:initial_timeout)     { should be == 2000 }
         its(:inter_digit_timeout) { should be == 2000 }
-        its(:term_timeout)        { should be == 2000 }
-        its(:complete_timeout)    { should be == 2000 }
-        its(:incomplete_timeout)  { should be == 2000 }
         its(:sensitivity)         { should be == 0.5 }
         its(:min_confidence)      { should be == 0.5 }
       end
@@ -132,6 +116,24 @@ module Punchblock
             it { should_not be == grammar4 }
           end
         end
+
+        describe 'with a grammar reference by URL' do
+          let(:url) { 'http://foo.com/bar.grxml' }
+
+          subject { Input::Grammar.new :url => url }
+
+          its(:url) { should be == url }
+
+          describe "comparison" do
+            it "should be the same with the same url" do
+              Input::Grammar.new(:url => url).should be == Input::Grammar.new(:url => url)
+            end
+
+            it "should be different with a different url" do
+              Input::Grammar.new(:url => url).should_not be == Input::Grammar.new(:url => 'http://doo.com/dah')
+            end
+          end
+        end
       end
 
       describe "actions" do

data/spec/punchblock/component/record_spec.rb

@@ -14,7 +14,6 @@ module Punchblock
           Record.new :format          => 'WAV',
                      :start_beep      => true,
                      :start_paused    => false,
-                     :stop_beep       => true,
                      :max_duration    => 500000,
                      :initial_timeout => 10000,
                      :final_timeout   => 30000
@@ -23,7 +22,6 @@ module Punchblock
         its(:format)          { should be == 'WAV' }
         its(:start_beep)      { should be == true }
         its(:start_paused)    { should be == false }
-        its(:stop_beep)       { should be == true }
         its(:max_duration)    { should be == 500000 }
         its(:initial_timeout) { should be == 10000 }
         its(:final_timeout)   { should be == 30000 }
@@ -36,7 +34,6 @@ module Punchblock
         format="WAV"
         start-beep="true"
         start-paused="false"
-        stop-beep="true"
         max-duration="500000"
         initial-timeout="10000"
         final-timeout="30000"/>
@@ -50,7 +47,6 @@ module Punchblock
         its(:format)          { should be == 'WAV' }
         its(:start_beep)      { should be == true }
         its(:start_paused)    { should be == false }
-        its(:stop_beep)       { should be == true }
         its(:max_duration)    { should be == 500000 }
         its(:initial_timeout) { should be == 10000 }
         its(:final_timeout)   { should be == 30000 }

data/spec/punchblock/connection/xmpp_spec.rb

@@ -76,7 +76,7 @@ module Punchblock
         offer.call_id = '9f00061'
         offer.to = 'sip:whatever@127.0.0.1'
         output = <<-MSG
-<output xmlns='urn:xmpp:tropo:say:1'>
+<output xmlns='urn:xmpp:rayo:output:1'>
   <audio url='http://acme.com/greeting.mp3'>
   Thanks for calling ACME company
   </audio>

data/spec/punchblock/translator/asterisk/call_spec.rb

@@ -827,6 +827,7 @@ module Punchblock
               subject.execute_command command
               ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
               ami_action.name.should be == "hangup"
+              ami_action.headers['Cause'].should be == 16
               ami_action << RubyAMI::Response.new
               command.response(0.5).should be true
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
@@ -114,7 +114,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.1
   type: :runtime
@@ -122,7 +122,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.1
 - !ruby/object:Gem::Dependency
@@ -423,8 +423,6 @@ files:
 - lib/punchblock/has_headers.rb
 - lib/punchblock/header.rb
 - lib/punchblock/key_value_pair_node.rb
-- lib/punchblock/media_container.rb
-- lib/punchblock/media_node.rb
 - lib/punchblock/protocol_error.rb
 - lib/punchblock/rayo_node.rb
 - lib/punchblock/ref.rb
@@ -523,7 +521,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1778552231483051908
+      hash: -689196999409732364
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/punchblock/media_container.rb

@@ -1,42 +0,0 @@
-# encoding: utf-8
-
-module Punchblock
-  module MediaContainer
-    ##
-    # @return [String] the TTS voice to use
-    #
-    def voice
-      read_attr :voice
-    end
-
-    ##
-    # @param [String] voice to use when rendering TTS
-    #
-    def voice=(voice)
-      write_attr :voice, voice
-    end
-
-    ##
-    # @return [String] the SSML document to render TTS
-    #
-    def ssml
-      node = children.first
-      RubySpeech::SSML.import node if node
-    end
-
-    ##
-    # @param [String] ssml the SSML document to render TTS
-    #
-    def ssml=(ssml)
-      return unless ssml
-      unless ssml.is_a?(RubySpeech::SSML::Element)
-        ssml = RubySpeech::SSML.import ssml
-      end
-      self << ssml
-    end
-
-    def inspect_attributes # :nodoc:
-      [:voice, :ssml] + super
-    end
-  end
-end

data/lib/punchblock/media_node.rb

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-module Punchblock
-  class MediaNode < RayoNode
-    include MediaContainer
-
-    def self.new(options = {})
-      super().tap do |new_node|
-        case options
-        when Hash
-          new_node << options.delete(:text) if options[:text]
-          options.each_pair { |k,v| new_node.send :"#{k}=", v }
-        when Nokogiri::XML::Element
-          new_node.inherit options
-        end
-      end
-    end
-  end
-end