punchblock 0.5.1 → 0.6.0

data/lib/punchblock/translator/asterisk.rb

@@ -0,0 +1,74 @@
+require 'celluloid'
+require 'punchblock/core_ext/celluloid'
+require 'ruby_ami'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      include Celluloid
+
+      extend ActiveSupport::Autoload
+
+      autoload :AMIAction
+      autoload :Call
+      autoload :Component
+
+      attr_reader :ami_client, :connection
+
+      def initialize(ami_client, connection)
+        @ami_client, @connection = ami_client, connection
+        @calls, @components = {}, {}
+      end
+
+      def register_call(call)
+        @calls[call.id] ||= call
+      end
+
+      def call_with_id(call_id)
+        @calls[call_id]
+      end
+
+      def register_component(component)
+        @components[component.id] ||= component
+      end
+
+      def component_with_id(component_id)
+        @components[component_id]
+      end
+
+      def handle_ami_event(event)
+        return unless event.is_a? RubyAMI::Event
+        connection.handle_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
+      end
+
+      def execute_command(command, options = {})
+        command.request!
+        if command.call_id || options[:call_id]
+          command.call_id ||= options[:call_id]
+          if command.component_id || options[:component_id]
+            command.component_id ||= options[:component_id]
+            execute_component_command command
+          else
+            execute_call_command command
+          end
+        else
+          execute_global_command command
+        end
+      end
+
+      def execute_call_command(command)
+        call_with_id(command.call_id).execute_command command
+      end
+
+      def execute_component_command(command)
+        call_with_id(command.call_id).execute_component_command command
+      end
+
+      def execute_global_command(command)
+        component = AMIAction.new command, ami_client
+        # register_component component
+        component.execute!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      class AMIAction < Component
+        attr_reader :action
+
+        def initialize(component_node, ami_client)
+          @component_node, @ami_client = component_node, ami_client
+          @action = create_action
+          @id = @action.action_id
+        end
+
+        def execute
+          send_action
+          send_ref
+        end
+
+        private
+
+        def create_action
+          headers = {}
+          @component_node.params_hash.each_pair do |key, value|
+            headers[key.to_s.capitalize] = value
+          end
+          RubyAMI::Action.new @component_node.name, headers do |response|
+            handle_response response
+          end
+        end
+
+        def send_action
+          @ami_client.send_action @action
+        end
+
+        def send_ref
+          @component_node.response = Ref.new :id => @action.action_id
+        end
+
+        def handle_response(response)
+          case response
+          when RubyAMI::Error
+            send_event error_event(response)
+          when RubyAMI::Response
+            send_events
+            send_event complete_event(response)
+          end
+        end
+
+        def error_event(response)
+          Punchblock::Event::Complete.new.tap do |c|
+            c.reason = Punchblock::Event::Complete::Error.new :details => response.message
+          end
+        end
+
+        def complete_event(response)
+          headers = response.headers
+          headers.merge! @extra_complete_attributes if @extra_complete_attributes
+          headers.delete 'ActionID'
+          Punchblock::Event::Complete.new.tap do |c|
+            c.reason = Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => headers.delete('Message'), :attributes => headers
+          end
+        end
+
+        def send_events
+          return unless @action.has_causal_events?
+          @action.events.each do |e|
+            if e.name.downcase == @action.causal_event_terminator_name
+              @extra_complete_attributes = e.headers
+            else
+              send_event pb_event_from_ami_event(e)
+            end
+          end
+        end
+
+        def pb_event_from_ami_event(ami_event)
+          headers = ami_event.headers
+          headers.delete 'ActionID'
+          Event::Asterisk::AMI::Event.new :name => ami_event.name, :attributes => headers
+        end
+
+        def send_event(event)
+          @component_node.add_event event
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      class Call
+        include Celluloid
+
+        def initialize
+          @components = {}
+        end
+
+        def register_component(component)
+          @components[component.id] ||= component
+        end
+
+        def component_with_id(component_id)
+          @components[component_id]
+        end
+
+        def execute_component_command(command)
+          component_with_id(command.component_id).execute_command command
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      class Component
+        include Celluloid
+
+        attr_reader :id
+      end
+    end
+  end
+end

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/punchblock.gemspec

@@ -29,9 +29,11 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<state_machine>, [">= 1.0.1"]
   s.add_runtime_dependency %q<future-resource>, [">= 0.0.2"]
   s.add_runtime_dependency %q<has-guarded-handlers>, [">= 0.1.0"]
+  s.add_runtime_dependency %q<celluloid>, [">= 0.5.0"]
+  s.add_runtime_dependency %q<ruby_ami>, [">= 0.1.2"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
-  s.add_development_dependency %q<rspec>, ["~> 2.3.0"]
+  s.add_development_dependency %q<rspec>, [">= 2.5.0"]
   s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
   s.add_development_dependency %q<yard>, ["~> 0.6.0"]
   s.add_development_dependency %q<rcov>, [">= 0"]

data/spec/punchblock/command/accept_spec.rb

@@ -8,6 +8,14 @@ module Punchblock
       end
 
       it_should_behave_like 'command_headers'
+
+      describe "from a stanza" do
+        let(:stanza) { '<accept xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Accept }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/command/answer_spec.rb

@@ -8,6 +8,14 @@ module Punchblock
       end
 
       it_should_behave_like 'command_headers'
+
+      describe "from a stanza" do
+        let(:stanza) { '<answer xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Answer }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/command/dial_spec.rb

@@ -14,9 +14,9 @@ module Punchblock
         RayoNode.class_from_registration(:dial, 'urn:xmpp:rayo:1').should == Dial
       end
 
-      describe "when setting options in initializer" do
-        let(:join_params) { {:other_call_id => 'abc123'} }
+      let(:join_params) { {:other_call_id => 'abc123'} }
 
+      describe "when setting options in initializer" do
         subject { Dial.new :to => 'tel:+14155551212', :from => 'tel:+13035551212', :headers => { :x_skill => 'agent', :x_customer_id => 8877 }, :join => join_params }
 
         it_should_behave_like 'command_headers'
@@ -26,6 +26,26 @@ module Punchblock
         its(:join)  { should == Join.new(join_params) }
       end
 
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<dial to='tel:+14155551212' from='tel:+13035551212' xmlns='urn:xmpp:rayo:1'>
+  <join call-id="abc123" />
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
+</dial>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Dial }
+
+        its(:to)    { should == 'tel:+14155551212' }
+        its(:from)  { should == 'tel:+13035551212' }
+        its(:join)  { should == Join.new(join_params) }
+      end
+
       describe "#response=" do
         before { subject.request! }
 

data/spec/punchblock/command/hangup_spec.rb

@@ -8,6 +8,14 @@ module Punchblock
       end
 
       it_should_behave_like 'command_headers'
+
+      describe "from a stanza" do
+        let(:stanza) { '<hangup xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Hangup }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/command/join_spec.rb

@@ -16,6 +16,27 @@ module Punchblock
         its(:direction)     { should == :duplex }
         its(:media)         { should == :bridge }
       end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<join xmlns="urn:xmpp:rayo:1"
+      call-id="abc123"
+      mixer-id="blah"
+      direction="duplex"
+      media="bridge" />
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Join }
+
+        its(:other_call_id) { should == 'abc123' }
+        its(:mixer_id)      { should == 'blah' }
+        its(:direction)     { should == :duplex }
+        its(:media)         { should == :bridge }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/command/mute_spec.rb

@@ -6,6 +6,14 @@ module Punchblock
       it 'registers itself' do
         RayoNode.class_from_registration(:mute, 'urn:xmpp:rayo:1').should == Mute
       end
+
+      describe "from a stanza" do
+        let(:stanza) { '<mute xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Mute }
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/command/redirect_spec.rb

@@ -14,6 +14,27 @@ module Punchblock
 
         its(:to) { should == 'tel:+14045551234' }
       end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<redirect xmlns='urn:xmpp:rayo:1'
+    to='tel:+14045551234'>
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
+</redirect>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Redirect }
+
+        it_should_behave_like 'command_headers'
+
+        its(:to) { should == 'tel:+14045551234' }
+      end
     end # Redirect
   end # Command
 end # Punchblock

data/spec/punchblock/command/reject_spec.rb

@@ -15,19 +15,30 @@ module Punchblock
         its(:reason) { should == :busy }
       end
 
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<reject xmlns='urn:xmpp:rayo:1'>
+  <busy />
+  <!-- Sample Headers (optional) -->
+  <header name="x-reason-internal" value="bad-skill" />
+</reject>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Reject }
+
+        its(:reason) { should == :busy }
+        its(:headers_hash) { should == { :x_reason_internal => 'bad-skill' } }
+      end
+
       describe "with the reason" do
         [:decline, :busy, :error].each do |reason|
           describe reason do
             subject { Reject.new :reason => reason }
 
-            let :expected_message do
-              <<-MESSAGE
-<reject xmlns="urn:xmpp:rayo:1">
-  <#{reason}/>
-</reject>
-              MESSAGE
-            end
-
             its(:reason) { should == reason }
           end
         end

data/spec/punchblock/command/unjoin_spec.rb

@@ -14,6 +14,23 @@ module Punchblock
         its(:other_call_id) { should == 'abc123' }
         its(:mixer_id)      { should == 'blah' }
       end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<unjoin xmlns="urn:xmpp:rayo:1"
+      call-id="abc123"
+      mixer-id="blah" />
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Unjoin }
+
+        its(:other_call_id) { should == 'abc123' }
+        its(:mixer_id)      { should == 'blah' }
+      end
     end
   end
 end # Punchblock