punchblock 0.7.1 → 0.7.2

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # develop
 
+# v0.7.2 - 2011-12-28
+  * Feature: Allow sending commands to mixers easily
+  * Feature: Allow configuration of Rayo XMPP domains (root, call and mixer)
+  * Feature: Log Blather messages to the trace log level
+  * Feature: Return an error when trying to execute an Output on Asterisk with unsupported options set
+  * Feature: Add basic support for media output via MRCPSynth on Asterisk
+  * API change: Rename mixer_id to mixer_name to align with change to Rayo
+  * Bugfix: Handle and expose RubySpeech GRXML documents on Input/Ask properly
+  * Bugfix: Compare ProtocolErrors correctly
+  * Bugfix: Asterisk media output should default to Asterisk native output (STREAM FILE)
+  * Bugfix: An Output node's default max_time value should be nil rather than zero
+
 # v0.7.1 - 2011-11-24
   * [FEATURE] Add `Connection#not_ready!`, to instruct the server not to send any more offers.
   * [BUGFIX] Translate all exceptions raised by the XMPP connection into a ProtocolError

data/lib/punchblock.rb

@@ -4,6 +4,7 @@
   active_support/core_ext/module/delegation
   future-resource
   has_guarded_handlers
+  ruby_speech
   punchblock/core_ext/ruby
 }.each { |l| require l }
 

data/lib/punchblock/command/join.rb

@@ -8,7 +8,7 @@ module Punchblock
       #
       # @param [Hash] options
       # @option options [String, Optional] :other_call_id the call ID to join
-      # @option options [String, Optional] :mixer_id the mixer name to join
+      # @option options [String, Optional] :mixer_name the mixer name to join
       # @option options [Symbol, Optional] :direction the direction in which media should flow
       # @option options [Symbol, Optional] :media the method by which to negotiate media
       #
@@ -39,14 +39,14 @@ module Punchblock
 
       ##
       # @return [String] the mixer name to join
-      def mixer_id
-        read_attr :'mixer-id'
+      def mixer_name
+        read_attr :'mixer-name'
       end
 
       ##
       # @param [String] other the mixer name to join
-      def mixer_id=(other)
-        write_attr :'mixer-id', other
+      def mixer_name=(other)
+        write_attr :'mixer-name', other
       end
 
       ##
@@ -74,7 +74,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_id, :direction, :media] + super
+        [:other_call_id, :mixer_name, :direction, :media] + super
       end
     end # Join
   end # Command

data/lib/punchblock/command/unjoin.rb

@@ -8,7 +8,7 @@ module Punchblock
       #
       # @param [Hash] options
       # @option options [String, Optional] :other_call_id the call ID to unjoin
-      # @option options [String, Optional] :mixer_id the mixer name to unjoin
+      # @option options [String, Optional] :mixer_name the mixer name to unjoin
       #
       # @return [Command::Unjoin] a formatted Rayo unjoin command
       #
@@ -32,18 +32,18 @@ module Punchblock
 
       ##
       # @return [String] the mixer name to unjoin
-      def mixer_id
-        read_attr :'mixer-id'
+      def mixer_name
+        read_attr :'mixer-name'
       end
 
       ##
       # @param [String] other the mixer name to unjoin
-      def mixer_id=(other)
-        write_attr :'mixer-id', other
+      def mixer_name=(other)
+        write_attr :'mixer-name', other
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_id] + super
+        [:other_call_id, :mixer_name] + super
       end
     end # Unjoin
   end # Command

data/lib/punchblock/command_node.rb

@@ -5,6 +5,7 @@ module Punchblock
     def self.new(options = {})
       super().tap do |new_node|
         new_node.call_id = options[:call_id]
+        new_node.mixer_name = options[:mixer_name]
         new_node.component_id = options[:component_id]
       end
     end

data/lib/punchblock/component/input.rb

@@ -208,7 +208,8 @@ module Punchblock
       # @return [Choices] the choices available
       #
       def grammar
-        Grammar.new find_first('ns:grammar', :ns => self.class.registered_ns)
+        node = find_first 'ns:grammar', :ns => self.class.registered_ns
+        Grammar.new node if node
       end
 
       ##
@@ -217,6 +218,7 @@ module Punchblock
       # @option choices [String] :value the choices available
       #
       def grammar=(other)
+        return unless other
         remove_children :grammar
         grammar = Grammar.new(other) unless other.is_a?(Grammar)
         self << grammar
@@ -252,21 +254,29 @@ module Punchblock
         end
 
         ##
-        # @param [String] content_type Defaults to the Voxeo Simple Grammar
+        # @param [String] content_type Defaults to GRXML
         #
         def content_type=(content_type)
-          write_attr 'content-type', content_type || 'application/grammar+grxml'
+          write_attr 'content-type', content_type || grxml_content_type
         end
 
         ##
         # @return [String] the choices available
         def value
-          content
+          if grxml?
+            RubySpeech::GRXML.import content
+          else
+            content
+          end
         end
 
         ##
         # @param [String] value the choices available
         def value=(value)
+          return unless value
+          if grxml? && !value.is_a?(RubySpeech::GRXML::Element)
+            value = RubySpeech::GRXML.import value
+          end
           Nokogiri::XML::Builder.with(self) do |xml|
             xml.cdata " #{value} "
           end
@@ -282,6 +292,16 @@ module Punchblock
         def inspect_attributes # :nodoc:
           [:content_type, :value] + super
         end
+
+        private
+
+        def grxml_content_type
+          'application/grammar+grxml'
+        end
+
+        def grxml?
+          content_type == grxml_content_type
+        end
       end # Choices
 
       class Complete

data/lib/punchblock/component/output.rb

@@ -109,7 +109,7 @@ module Punchblock
       # @return [String] the TTS voice to use
       #
       def max_time
-        read_attr(:'max-time').to_i
+        read_attr :'max-time', :to_i
       end
 
       ##
@@ -119,6 +119,10 @@ module Punchblock
         write_attr :'max-time', other
       end
 
+      def inspect_attributes
+        super + [:interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time]
+      end
+
       state_machine :state do
         event :paused do
           transition :executing => :paused

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

@@ -147,7 +147,8 @@ module Punchblock
         # @return [Choices] the choices available
         #
         def choices
-          Choices.new find_first('ns:choices', :ns => self.class.registered_ns)
+          node = find_first 'ns:choices', :ns => self.class.registered_ns
+          Choices.new node if node
         end
 
         ##
@@ -156,6 +157,7 @@ module Punchblock
         # @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

data/lib/punchblock/connection/xmpp.rb

@@ -9,7 +9,7 @@ module Punchblock
   module Connection
     class XMPP < GenericConnection
       include Blather::DSL
-      attr_accessor :event_handler
+      attr_accessor :event_handler, :root_domain, :calls_domain, :mixers_domain
 
       ##
       # Initialize the required connection attributes
@@ -27,7 +27,9 @@ module Punchblock
 
         setup *[:username, :password, :host, :port, :certs].map { |key| options.delete key }
 
-        @rayo_domain = options[:rayo_domain] || Blather::JID.new(@username).domain
+        @root_domain    = Blather::JID.new(options[:root_domain] || options[:rayo_domain] || @username).domain
+        @calls_domain   = options[:calls_domain]  || "calls.#{@root_domain}"
+        @mixers_domain  = options[:mixers_domain] || "mixers.#{@root_domain}"
 
         @callmap = {} # This hash maps call IDs to their XMPP domain.
 
@@ -37,6 +39,7 @@ module Punchblock
         @ping_period = options.has_key?(:ping_period) ? options[:ping_period] : 60
 
         Blather.logger = pb_logger
+        Blather.default_log_level = :trace if Blather.respond_to? :default_log_level
 
         super()
       end
@@ -54,12 +57,11 @@ module Punchblock
       end
 
       def prep_command_for_execution(command, options = {})
-        call_id, component_id = options.values_at :call_id, :component_id
-        command.connection = self
-        command.call_id = call_id
-        jid = command.is_a?(Command::Dial) ? @rayo_domain : "#{call_id}@#{@callmap[call_id]}"
-        jid << "/#{component_id}" if component_id
-        create_iq(jid).tap do |iq|
+        command.connection    = self
+        command.call_id       ||= options[:call_id]
+        command.mixer_name      ||= options[:mixer_name]
+        command.component_id  ||= options[:component_id]
+        create_iq(jid_for_command(command)).tap do |iq|
           pb_logger.debug "Sending IQ ID #{iq.id} #{command.inspect} to #{jid}"
           iq << command
         end
@@ -102,9 +104,25 @@ module Punchblock
 
       private
 
+      def jid_for_command(command)
+        return root_domain if command.is_a?(Command::Dial)
+
+        if command.call_id
+          node = command.call_id
+          domain = @callmap[command.call_id] || calls_domain
+        elsif command.mixer_name
+          node = command.mixer_name
+          domain = @callmap[command.mixer_name] || mixers_domain
+        else
+          domain = calls_domain
+        end
+
+        Blather::JID.new(node, domain, command.component_id).to_s
+      end
+
       def send_presence(presence)
         status = Blather::Stanza::Presence::Status.new presence
-        status.to = @rayo_domain
+        status.to = root_domain
         client.write status
       end
 
@@ -160,7 +178,7 @@ module Punchblock
       end
 
       def ping_rayo
-        client.write_with_handler Blather::Stanza::Iq::Ping.new(:set, @rayo_domain) do |response|
+        client.write_with_handler Blather::Stanza::Iq::Ping.new(:set, root_domain) do |response|
           begin
             handle_error response if response.is_a? Blather::BlatherError
           rescue ProtocolError => e

data/lib/punchblock/event/joined.rb

@@ -8,7 +8,7 @@ module Punchblock
       #
       # @param [Hash] options
       # @option options [String, Optional] :other_call_id the call ID that was joined
-      # @option options [String, Optional] :mixer_id the mixer name that was joined
+      # @option options [String, Optional] :mixer_name the mixer name that was joined
       #
       # @return [Event::Joined] a formatted Rayo joined event
       #
@@ -32,18 +32,18 @@ module Punchblock
 
       ##
       # @return [String] the mixer name that was joined
-      def mixer_id
-        read_attr :'mixer-id'
+      def mixer_name
+        read_attr :'mixer-name'
       end
 
       ##
       # @param [String] other the mixer name that was joined
-      def mixer_id=(other)
-        write_attr :'mixer-id', other
+      def mixer_name=(other)
+        write_attr :'mixer-name', other
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_id] + super
+        [:other_call_id, :mixer_name] + super
       end
     end # Joined
   end

data/lib/punchblock/event/unjoined.rb

@@ -8,7 +8,7 @@ module Punchblock
       #
       # @param [Hash] options
       # @option options [String, Optional] :other_call_id the call ID that was unjoined
-      # @option options [String, Optional] :mixer_id the mixer name that was unjoined
+      # @option options [String, Optional] :mixer_name the mixer name that was unjoined
       #
       # @return [Event::Unjoined] a formatted Rayo unjoined event
       #
@@ -32,18 +32,18 @@ module Punchblock
 
       ##
       # @return [String] the mixer name that was unjoined
-      def mixer_id
-        read_attr :'mixer-id'
+      def mixer_name
+        read_attr :'mixer-name'
       end
 
       ##
       # @param [String] other the mixer name that was unjoined
-      def mixer_id=(other)
-        write_attr :'mixer-id', other
+      def mixer_name=(other)
+        write_attr :'mixer-name', other
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_id] + super
+        [:other_call_id, :mixer_name] + super
       end
     end # Unjoined
   end

data/lib/punchblock/media_container.rb

@@ -18,18 +18,19 @@ module Punchblock
     # @return [String] the SSML document to render TTS
     #
     def ssml
-      children.to_xml
+      node = children.first
+      RubySpeech::SSML.import node if node
     end
 
     ##
     # @param [String] ssml the SSML document to render TTS
     #
     def ssml=(ssml)
-      if ssml.instance_of?(String)
-        self << RayoNode.new('').parse(ssml) do |config|
-          config.noblanks.strict
-        end
+      return unless ssml
+      unless ssml.is_a?(RubySpeech::SSML::Element)
+        ssml = RubySpeech::SSML.import ssml
       end
+      self << ssml
     end
 
     def inspect_attributes # :nodoc:

data/lib/punchblock/protocol_error.rb

@@ -12,5 +12,10 @@ module Punchblock
       "#<#{self.class}: name=#{name.inspect} text=#{text.inspect} call_id=#{call_id.inspect} component_id=#{component_id.inspect}>"
     end
     alias :inspect :to_s
+
+    def eql?(other)
+      other.is_a?(self.class) && [:name, :text, :call_id, :component_id].all? { |f| self.__send__(f) == other.__send__(f) }
+    end
+    alias :== :eql?
   end
 end

data/lib/punchblock/rayo_node.rb

@@ -7,7 +7,7 @@ module Punchblock
 
     class_attribute :registered_ns, :registered_name
 
-    attr_accessor :call_id, :component_id, :domain, :connection, :client, :original_component
+    attr_accessor :call_id, :mixer_name, :component_id, :domain, :connection, :client, :original_component
 
     # Register a new stanza class to a name and/or namespace
     #

data/lib/punchblock/translator/asterisk.rb

@@ -11,11 +11,11 @@ module Punchblock
       autoload :Call
       autoload :Component
 
-      attr_reader :ami_client, :connection, :calls
+      attr_reader :ami_client, :connection, :media_engine, :calls
 
-      def initialize(ami_client, connection)
+      def initialize(ami_client, connection, media_engine = nil)
         pb_logger.debug "Starting up..."
-        @ami_client, @connection = ami_client, connection
+        @ami_client, @connection, @media_engine = ami_client, connection, media_engine
         @calls, @components, @channel_to_call_id = {}, {}, {}
         @fully_booted_count = 0
       end

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

@@ -64,12 +64,14 @@ module Punchblock
             end
           when Punchblock::Component::Asterisk::AGI::Command
             execute_agi_command command
+          when Punchblock::Component::Output
+            execute_component Component::Asterisk::Output, command
           end
         end
 
-        def send_agi_action(command, &block)
+        def send_agi_action(command, *params, &block)
           pb_logger.debug "Sending AGI action #{command}"
-          @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :call_id => id
+          @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :call_id => id
           @current_agi_command.request!
           @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |e|
             pb_logger.debug "AGI action received complete event #{e.inspect}"
@@ -89,7 +91,11 @@ module Punchblock
         private
 
         def execute_agi_command(command)
-          Component::Asterisk::AGICommand.new(command, current_actor).tap do |component|
+          execute_component Component::Asterisk::AGICommand, command
+        end
+
+        def execute_component(type, command)
+          type.new(command, current_actor).tap do |component|
             register_component component
             component.execute!
           end