punchblock 0.11.0 → 0.12.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v0.12.0](https://github.com/adhearsion/punchblock/compare/v0.11.0...v0.12.0) - [2012-03-30](https://rubygems.org/gems/punchblock/versions/0.12.0)
+  * API Change: `#call_id` and `#mixer_name` attributes changed to `#target_call_id` and `#target_mixer_name`
+  * API Change: `#other_call_id` attributes changed to `#call_id` to better align with Rayo
+
 # [v0.11.0](https://github.com/adhearsion/punchblock/compare/v0.10.0...v0.11.0) - [2012-03-29](https://rubygems.org/gems/punchblock/versions/0.11.0)
   * Feature: Input & Output components on Asterisk now responds to a Stop command
   * Feature: started/stopped-speaking events are now handled

data/lib/punchblock/command/dial.rb

@@ -88,7 +88,7 @@ module Punchblock
       end
 
       def response=(other)
-        @call_id = other.id if other.is_a?(Ref)
+        @target_call_id = other.id if other.is_a?(Ref)
         super
       end
 

data/lib/punchblock/command/join.rb

@@ -9,7 +9,7 @@ module Punchblock
       # Create a join message
       #
       # @param [Hash] options
-      # @option options [String, Optional] :other_call_id the call ID to join
+      # @option options [String, Optional] :call_id the call ID 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
@@ -29,13 +29,13 @@ module Punchblock
 
       ##
       # @return [String] the call ID to join
-      def other_call_id
+      def call_id
         read_attr :'call-id'
       end
 
       ##
       # @param [String] other the call ID to join
-      def other_call_id=(other)
+      def call_id=(other)
         write_attr :'call-id', other
       end
 
@@ -76,7 +76,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_name, :direction, :media] + super
+        [:call_id, :mixer_name, :direction, :media] + super
       end
     end # Join
   end # Command

data/lib/punchblock/command/unjoin.rb

@@ -9,7 +9,7 @@ module Punchblock
       # Create an ujoin message
       #
       # @param [Hash] options
-      # @option options [String, Optional] :other_call_id the call ID to unjoin
+      # @option options [String, Optional] :call_id the call ID to unjoin
       # @option options [String, Optional] :mixer_name the mixer name to unjoin
       #
       # @return [Command::Unjoin] a formatted Rayo unjoin command
@@ -22,13 +22,13 @@ module Punchblock
 
       ##
       # @return [String] the call ID to unjoin
-      def other_call_id
+      def call_id
         read_attr :'call-id'
       end
 
       ##
       # @param [String] other the call ID to unjoin
-      def other_call_id=(other)
+      def call_id=(other)
         write_attr :'call-id', other
       end
 
@@ -45,7 +45,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_name] + super
+        [:call_id, :mixer_name] + super
       end
     end # Unjoin
   end # Command

data/lib/punchblock/command_node.rb

@@ -6,8 +6,8 @@ module Punchblock
   class CommandNode < RayoNode
     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.target_call_id = options[:target_call_id]
+        new_node.target_mixer_name = options[:target_mixer_name]
         new_node.component_id = options[:component_id]
       end
     end
@@ -45,5 +45,9 @@ module Punchblock
       @response.resource = other
       execute!
     end
+
+    def inspect_attributes
+      super + [:state_name]
+    end
   end # CommandNode
 end # Punchblock

data/lib/punchblock/component/component_node.rb

@@ -31,7 +31,7 @@ module Punchblock
       end
 
       def write_action(action)
-        client.execute_command action, :call_id => call_id, :component_id => component_id
+        client.execute_command action, :target_call_id => target_call_id, :component_id => component_id
         action
       end
 
@@ -59,7 +59,7 @@ module Punchblock
       # @return [Stop] an Rayo stop message
       #
       def stop_action
-        Stop.new :component_id => component_id, :call_id => call_id
+        Stop.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##

data/lib/punchblock/component/output.rb

@@ -145,7 +145,7 @@ module Punchblock
       #    returns:
       #      <pause xmlns="urn:xmpp:tropo:output:1"/>
       def pause_action
-        Pause.new :component_id => component_id, :call_id => call_id
+        Pause.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##
@@ -170,7 +170,7 @@ module Punchblock
       #    returns:
       #      <resume xmlns="urn:xmpp:tropo:output:1"/>
       def resume_action
-        Resume.new :component_id => component_id, :call_id => call_id
+        Resume.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##
@@ -203,7 +203,7 @@ module Punchblock
       #    returns:
       #      <seek xmlns="urn:xmpp:rayo:output:1"/>
       def seek_action(options = {})
-        Seek.new({ :component_id => component_id, :call_id => call_id }.merge(options)).tap do |s|
+        Seek.new({ :component_id => component_id, :target_call_id => target_call_id }.merge(options)).tap do |s|
           s.original_component = self
         end
       end
@@ -268,7 +268,7 @@ module Punchblock
       #    returns:
       #      <speed-up xmlns="urn:xmpp:rayo:output:1"/>
       def speed_up_action
-        SpeedUp.new(:component_id => component_id, :call_id => call_id).tap do |s|
+        SpeedUp.new(:component_id => component_id, :target_call_id => target_call_id).tap do |s|
           s.original_component = self
         end
       end
@@ -294,7 +294,7 @@ module Punchblock
       #    returns:
       #      <speed-down xmlns="urn:xmpp:rayo:output:1"/>
       def slow_down_action
-        SlowDown.new(:component_id => component_id, :call_id => call_id).tap do |s|
+        SlowDown.new(:component_id => component_id, :target_call_id => target_call_id).tap do |s|
           s.original_component = self
         end
       end
@@ -362,7 +362,7 @@ module Punchblock
       #    returns:
       #      <volume-up xmlns="urn:xmpp:rayo:output:1"/>
       def volume_up_action
-        VolumeUp.new(:component_id => component_id, :call_id => call_id).tap do |s|
+        VolumeUp.new(:component_id => component_id, :target_call_id => target_call_id).tap do |s|
           s.original_component = self
         end
       end
@@ -388,7 +388,7 @@ module Punchblock
       #    returns:
       #      <volume-down xmlns="urn:xmpp:rayo:output:1"/>
       def volume_down_action
-        VolumeDown.new(:component_id => component_id, :call_id => call_id).tap do |s|
+        VolumeDown.new(:component_id => component_id, :target_call_id => target_call_id).tap do |s|
           s.original_component = self
         end
       end

data/lib/punchblock/component/record.rb

@@ -149,7 +149,7 @@ module Punchblock
       #    returns:
       #      <pause xmlns="urn:xmpp:rayo:record:1"/>
       def pause_action
-        Pause.new :component_id => component_id, :call_id => call_id
+        Pause.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##
@@ -174,7 +174,7 @@ module Punchblock
       #    returns:
       #      <resume xmlns="urn:xmpp:rayo:record:1"/>
       def resume_action
-        Resume.new :component_id => component_id, :call_id => call_id
+        Resume.new :component_id => component_id, :target_call_id => target_call_id
       end
 
       ##

data/lib/punchblock/connection/xmpp.rb

@@ -34,6 +34,7 @@ module Punchblock
         @mixers_domain  = options[:mixers_domain] || "mixers.#{@root_domain}"
 
         @callmap = {} # This hash maps call IDs to their XMPP domain.
+        @joined_mixers = []
 
         @ping_period = options.has_key?(:ping_period) ? options[:ping_period] : 60
 
@@ -59,9 +60,12 @@ module Punchblock
 
       def prep_command_for_execution(command, options = {})
         command.connection    = self
-        command.call_id       ||= options[:call_id]
-        command.mixer_name    ||= options[:mixer_name]
-        command.component_id  ||= options[:component_id]
+        command.target_call_id    ||= options[:call_id]
+        command.target_mixer_name ||= options[:mixer_name]
+        command.component_id      ||= options[:component_id]
+        if command.is_a?(Command::Join) && command.mixer_name
+          @joined_mixers << command.mixer_name
+        end
         create_iq(jid_for_command(command)).tap do |iq|
           iq << command
         end
@@ -105,12 +109,12 @@ module Punchblock
       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
+        if command.target_call_id
+          node = command.target_call_id
+          domain = @callmap[command.target_call_id] || calls_domain
+        elsif command.target_mixer_name
+          node = command.target_mixer_name
+          domain = @callmap[command.target_mixer_name] || mixers_domain
         else
           domain = calls_domain
         end
@@ -130,6 +134,11 @@ module Punchblock
         event = p.event
         event.connection = self
         event.domain = p.from.domain
+        if @joined_mixers.include?(p.call_id)
+          event.target_mixer_name = p.call_id
+        else
+          event.target_call_id = p.call_id
+        end
         event_handler.call event
       end
 

data/lib/punchblock/core_ext/blather/stanza.rb

@@ -8,7 +8,7 @@ module Blather
     #
     def rayo_node
       first_child = children.first
-      Punchblock::RayoNode.import first_child, call_id, component_id if first_child
+      Punchblock::RayoNode.import first_child, nil, component_id if first_child
     end
 
     ##

data/lib/punchblock/event/active_speaker.rb

@@ -3,16 +3,16 @@
 module Punchblock
   class Event
     module ActiveSpeaker
-      def other_call_id
+      def call_id
         read_attr :'call-id'
       end
 
-      def other_call_id=(other)
+      def call_id=(other)
         write_attr :'call-id', other
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id] + super
+        [:call_id] + super
       end
     end
   end

data/lib/punchblock/event/complete.rb

@@ -13,7 +13,7 @@ module Punchblock
         element = find_first('*')
         if element
           RayoNode.import(element).tap do |reason|
-            reason.call_id = call_id
+            reason.target_call_id = target_call_id
             reason.component_id = component_id
           end
         end
@@ -28,7 +28,7 @@ module Punchblock
         element = find_first('//ns:recording', :ns => RAYO_NAMESPACES[:record_complete])
         if element
           RayoNode.import(element).tap do |recording|
-            recording.call_id = call_id
+            recording.target_call_id = target_call_id
             recording.component_id = component_id
           end
         end

data/lib/punchblock/event/joined.rb

@@ -7,13 +7,13 @@ module Punchblock
 
       ##
       # @return [String] the call ID that was joined
-      def other_call_id
+      def call_id
         read_attr :'call-id'
       end
 
       ##
       # @param [String] other the call ID that was joined
-      def other_call_id=(other)
+      def call_id=(other)
         write_attr :'call-id', other
       end
 
@@ -30,7 +30,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_name] + super
+        [:call_id, :mixer_name] + super
       end
     end # Joined
   end

data/lib/punchblock/event/offer.rb

@@ -28,7 +28,7 @@ module Punchblock
       end
 
       def inspect
-        "#<Punchblock::Event::Offer to=\"#{to}\", from=\"#{from}\", call_id=\"#{call_id}\""
+        "#<Punchblock::Event::Offer to=\"#{to}\", from=\"#{from}\", call_id=\"#{target_call_id}\""
       end
     end # Offer
   end

data/lib/punchblock/event/unjoined.rb

@@ -7,13 +7,13 @@ module Punchblock
 
       ##
       # @return [String] the call ID that was unjoined
-      def other_call_id
+      def call_id
         read_attr :'call-id'
       end
 
       ##
       # @param [String] other the call ID that was unjoined
-      def other_call_id=(other)
+      def call_id=(other)
         write_attr :'call-id', other
       end
 
@@ -30,7 +30,7 @@ module Punchblock
       end
 
       def inspect_attributes # :nodoc:
-        [:other_call_id, :mixer_name] + super
+        [:call_id, :mixer_name] + super
       end
     end # Unjoined
   end

data/lib/punchblock/rayo_node.rb

@@ -9,7 +9,7 @@ module Punchblock
 
     class_attribute :registered_ns, :registered_name
 
-    attr_accessor :call_id, :mixer_name, :component_id, :domain, :connection, :client, :original_component
+    attr_accessor :target_call_id, :target_mixer_name, :component_id, :domain, :connection, :client, :original_component
 
     # Register a new stanza class to a name and/or namespace
     #
@@ -48,7 +48,7 @@ module Punchblock
       else
         new.inherit node
       end.tap do |event|
-        event.call_id = call_id
+        event.target_call_id = call_id
         event.component_id = component_id
       end
     end
@@ -64,7 +64,7 @@ module Punchblock
     end
 
     def inspect_attributes # :nodoc:
-      [:call_id, :component_id]
+      [:target_call_id, :component_id, :target_mixer_name]
     end
 
     def inspect

data/lib/punchblock/translator/asterisk.rb

@@ -82,10 +82,10 @@ module Punchblock
         pb_logger.trace "Executing command #{command.inspect}"
         command.request!
 
-        command.call_id ||= options[:call_id]
+        command.target_call_id ||= options[:call_id]
         command.component_id ||= options[:component_id]
 
-        if command.call_id
+        if command.target_call_id
           execute_call_command command
         elsif command.component_id
           execute_component_command command
@@ -95,10 +95,10 @@ module Punchblock
       end
 
       def execute_call_command(command)
-        if call = call_with_id(command.call_id)
+        if call = call_with_id(command.target_call_id)
           call.execute_command! command
         else
-          command.response = ProtocolError.new.setup 'call-not-found', "Could not find a call with ID #{command.call_id}", command.call_id
+          command.response = ProtocolError.new.setup 'call-not-found', "Could not find a call with ID #{command.target_call_id}", command.target_call_id
         end
       end
 
@@ -106,7 +106,7 @@ module Punchblock
         if (component = component_with_id(command.component_id))
           component.execute_command! command
         else
-          command.response = ProtocolError.new.setup 'component-not-found', "Could not find a component with ID #{command.component_id}", command.call_id, command.component_id
+          command.response = ProtocolError.new.setup 'component-not-found', "Could not find a component with ID #{command.component_id}", command.target_call_id, command.component_id
         end
       end
 

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

@@ -98,7 +98,7 @@ module Punchblock
 
         def answer_if_not_answered
           return if answered? || outbound?
-          execute_command Command::Answer.new
+          execute_command Command::Answer.new.tap { |a| a.request! }
         end
 
         def channel=(other)
@@ -137,11 +137,11 @@ module Punchblock
               event = case ami_event['Bridgestate']
               when 'Link'
                 Event::Joined.new.tap do |e|
-                  e.other_call_id = other_call.id
+                  e.call_id = other_call.id
                 end
               when 'Unlink'
                 Event::Unjoined.new.tap do |e|
-                  e.other_call_id = other_call.id
+                  e.call_id = other_call.id
                 end
               end
               send_pb_event event
@@ -150,7 +150,7 @@ module Punchblock
             other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
             if other_call = translator.call_for_channel(other_call_channel)
               event = Event::Unjoined.new.tap do |e|
-                e.other_call_id = other_call.id
+                e.call_id = other_call.id
               end
               send_pb_event event
             end
@@ -187,11 +187,11 @@ module Punchblock
               command.response = true
             end
           when Command::Join
-            other_call = translator.call_with_id command.other_call_id
+            other_call = translator.call_with_id command.call_id
             pending_joins[other_call.channel] = command
             send_agi_action 'EXEC Bridge', other_call.channel
           when Command::Unjoin
-            other_call = translator.call_with_id command.other_call_id
+            other_call = translator.call_with_id command.call_id
             redirect_back other_call
           when Punchblock::Component::Asterisk::AGI::Command
             execute_component Component::Asterisk::AGICommand, command
@@ -206,7 +206,7 @@ module Punchblock
 
         def send_agi_action(command, *params, &block)
           pb_logger.trace "Sending AGI action #{command}"
-          @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :call_id => id
+          @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :target_call_id => id
           @current_agi_command.request!
           @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |e|
             pb_logger.trace "AGI action received complete event #{e.inspect}"
@@ -259,7 +259,7 @@ module Punchblock
         end
 
         def send_pb_event(event)
-          event.call_id = id
+          event.target_call_id = id
           pb_logger.trace "Sending Punchblock event: #{event.inspect}"
           translator.handle_pb_event! event
         end