punchblock 0.10.0 → 0.11.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [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
+  * Bugfix: Asterisk output component considers an SSML doc w/ a string node w/o spaces to be a filename
+  * Bugfix: `ProtocolError` should behave like a normal exception, just with extra attributes
+
 # [v0.10.0](https://github.com/adhearsion/punchblock/compare/v0.9.2...v0.10.0) - [2012-03-19](https://rubygems.org/gems/punchblock/versions/0.10.0)
   * Feature: app_swift is now supported on Asterisk with a media_engine type of :swift
   * Feature: Asterisk calls now support the Join API

data/lib/punchblock/connection/xmpp.rb

@@ -141,7 +141,7 @@ module Punchblock
 
       def handle_error(iq, command = nil)
         e = Blather::StanzaError.import iq
-        protocol_error = ProtocolError.new e.name, e.text, iq.call_id, iq.component_id
+        protocol_error = ProtocolError.new.setup e.name, e.text, iq.call_id, iq.component_id
         command.response = protocol_error if command
       end
 
@@ -170,7 +170,7 @@ module Punchblock
           begin
             handle_error response if response.is_a? Blather::BlatherError
           rescue ProtocolError => e
-            raise e unless e.name == :feature_not_implemented
+            raise unless e.name == :feature_not_implemented
           end
         end
       end

data/lib/punchblock/event/active_speaker.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Punchblock
+  class Event
+    module ActiveSpeaker
+      def other_call_id
+        read_attr :'call-id'
+      end
+
+      def other_call_id=(other)
+        write_attr :'call-id', other
+      end
+
+      def inspect_attributes # :nodoc:
+        [:other_call_id] + super
+      end
+    end
+  end
+end

data/lib/punchblock/event/started_speaking.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'punchblock/event/active_speaker'
+
+module Punchblock
+  class Event
+    class StartedSpeaking < Event
+      register :'started-speaking', :core
+
+      include ActiveSpeaker
+    end
+  end
+end

data/lib/punchblock/event/stopped_speaking.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'punchblock/event/active_speaker'
+
+module Punchblock
+  class Event
+    class StoppedSpeaking < Event
+      register :'stopped-speaking', :core
+
+      include ActiveSpeaker
+    end
+  end
+end

data/lib/punchblock/event.rb

@@ -25,4 +25,6 @@ end
   offer
   ringing
   unjoined
+  started_speaking
+  stopped_speaking
 }.each { |e| require "punchblock/event/#{e}"}

data/lib/punchblock/protocol_error.rb

@@ -6,8 +6,9 @@ module Punchblock
   class ProtocolError < StandardError
     attr_accessor :name, :text, :call_id, :component_id
 
-    def initialize(name = nil, text = nil, call_id = nil, component_id = nil)
+    def setup(name = nil, text = nil, call_id = nil, component_id = nil)
       @name, @text, @call_id, @component_id = name, text, call_id, component_id
+      self
     end
 
     def to_s

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

@@ -64,6 +64,7 @@ module Punchblock
         def to_s
           "#<#{self.class}:#{id} Channel: #{channel.inspect}>"
         end
+        alias :inspect :to_s
 
         def dial(dial_command)
           @direction = :outbound
@@ -163,7 +164,7 @@ module Punchblock
             if component = component_with_id(command.component_id)
               component.execute_command! command
             else
-              command.response = ProtocolError.new 'component-not-found', "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
+              command.response = ProtocolError.new.setup 'component-not-found', "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
             end
           end
           case command
@@ -199,7 +200,7 @@ module Punchblock
           when Punchblock::Component::Input
             execute_component Component::Input, command
           else
-            command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command for call #{id}", id
+            command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for call #{id}", id
           end
         end
 
@@ -226,8 +227,6 @@ module Punchblock
           "#{self.class}: #{id}"
         end
 
-        private
-
         def redirect_back(other_call = nil)
           redirect_options = {
             'Channel'   => channel,
@@ -244,6 +243,8 @@ module Punchblock
           send_ami_action 'Redirect', redirect_options
         end
 
+        private
+
         def send_end_event(reason)
           send_pb_event Event::End.new(:reason => reason)
           after(5) { shutdown }

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

@@ -62,6 +62,16 @@ module Punchblock
             end
           end
 
+          def execute_command(command)
+            case command
+            when Punchblock::Component::Stop
+              command.response = true
+              complete Punchblock::Event::Complete::Stop.new
+            else
+              super
+            end
+          end
+
           private
 
           def begin_initial_timer(timeout)

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

@@ -7,6 +7,7 @@ module Punchblock
     class Asterisk
       module Component
         class Output < Component
+          include StopByRedirect
 
           def setup
             @media_engine = @call.translator.media_engine
@@ -31,8 +32,11 @@ module Punchblock
                 case node
                 when RubySpeech::SSML::Audio
                   lambda { current_actor.play_audio! node.src }
+                when String
+                  return unrenderable_doc_error if node.include?(' ')
+                  lambda { current_actor.play_audio! node }
                 else
-                  return with_error 'unrenderable document error', 'The provided document could not be rendered.'
+                  return unrenderable_doc_error
                 end
               end.compact
 
@@ -53,18 +57,20 @@ module Punchblock
               end
             when :unimrcp
               send_ref
+              output_component = current_actor
               @call.send_agi_action! 'EXEC MRCPSynth', escaped_doc, mrcpsynth_options do |complete_event|
                 pb_logger.debug "MRCPSynth completed with #{complete_event}."
-                send_complete_event success_reason
+                output_component.send_complete_event! success_reason
               end
             when :swift
               doc = escaped_doc
               doc << "|1|1" if [:any, :dtmf].include? @component_node.interrupt_on
               doc.insert 0, "#{@component_node.voice}^" if @component_node.voice
               send_ref
+              output_component = current_actor
               @call.send_agi_action! 'EXEC Swift', doc do |complete_event|
                 pb_logger.debug "Swift completed with #{complete_event}."
-                send_complete_event success_reason
+                output_component.send_complete_event! success_reason
               end
             end
           end
@@ -93,6 +99,10 @@ module Punchblock
 
           private
 
+          def unrenderable_doc_error
+            with_error 'unrenderable document error', 'The provided document could not be rendered.'
+          end
+
           def escaped_doc
             @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
           end

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

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'active_support/core_ext/string/filters'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module StopByRedirect
+          def execute_command(command)
+            return super unless command.is_a?(Punchblock::Component::Stop)
+
+            component_actor = current_actor
+            call.register_handler :ami, lambda { |e| e['SubEvent'] == 'Start' }, :name => 'AsyncAGI' do |event|
+              component_actor.send_complete_event! Punchblock::Event::Complete::Stop.new
+            end
+            command.response = true
+            call.redirect_back!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ module Punchblock
         autoload :Asterisk
         autoload :Input
         autoload :Output
+        autoload :StopByRedirect
 
         class Component
           include Celluloid
@@ -27,7 +28,7 @@ module Punchblock
           end
 
           def execute_command(command)
-            command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command for component #{id}", call_id, id
+            command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for component #{id}", call_id, id
           end
 
           def send_complete_event(reason)
@@ -73,7 +74,7 @@ module Punchblock
           end
 
           def with_error(name, text)
-            set_node_response ProtocolError.new(name, text)
+            set_node_response ProtocolError.new.setup(name, text)
           end
         end
       end

data/lib/punchblock/translator/asterisk.rb

@@ -98,7 +98,7 @@ module Punchblock
         if call = call_with_id(command.call_id)
           call.execute_command! command
         else
-          command.response = ProtocolError.new '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.call_id}", command.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 '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.call_id, command.component_id
         end
       end
 
@@ -121,7 +121,7 @@ module Punchblock
           register_call call
           call.dial! command
         else
-          command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command"
+          command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command"
         end
       end
 

data/lib/punchblock/version.rb

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

data/spec/punchblock/event/started_speaking_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe StartedSpeaking do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:'started-speaking', 'urn:xmpp:rayo:1').should be == StartedSpeaking
+      end
+
+      describe "from a stanza" do
+        let :stanza do
+          '<started-speaking xmlns="urn:xmpp:rayo:1" call-id="x0yz4ye-lx7-6ai9njwvw8nsb"/>'
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of StartedSpeaking }
+
+        it_should_behave_like 'event'
+
+        its(:other_call_id) { should be == "x0yz4ye-lx7-6ai9njwvw8nsb" }
+        its(:xmlns)         { should be == 'urn:xmpp:rayo:1' }
+      end
+
+      describe "when setting options in initializer" do
+        subject do
+          StartedSpeaking.new :other_call_id => 'abc123'
+        end
+
+        its(:other_call_id) { should be == 'abc123' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/stopped_speaking_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe StoppedSpeaking do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:'stopped-speaking', 'urn:xmpp:rayo:1').should be == StoppedSpeaking
+      end
+
+      describe "from a stanza" do
+        let :stanza do
+          '<stopped-speaking xmlns="urn:xmpp:rayo:1" call-id="x0yz4ye-lx7-6ai9njwvw8nsb"/>'
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of StoppedSpeaking }
+
+        it_should_behave_like 'event'
+
+        its(:other_call_id) { should be == "x0yz4ye-lx7-6ai9njwvw8nsb" }
+        its(:xmlns)         { should be == 'urn:xmpp:rayo:1' }
+      end
+
+      describe "when setting options in initializer" do
+        subject do
+          StoppedSpeaking.new :other_call_id => 'abc123'
+        end
+
+        its(:other_call_id) { should be == 'abc123' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/protocol_error_spec.rb

@@ -8,33 +8,81 @@ module Punchblock
     let(:text)          { 'Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]' }
     let(:call_id)       { 'f6d437f4-1e18-457b-99f8-b5d853f50347' }
     let(:component_id)  { 'abc123' }
-    subject { ProtocolError.new name, text, call_id, component_id }
+    subject { ProtocolError.new.setup name, text, call_id, component_id }
 
     its(:inspect) { should be == '#<Punchblock::ProtocolError: name=:item_not_found text="Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]" call_id="f6d437f4-1e18-457b-99f8-b5d853f50347" component_id="abc123">' }
 
+    describe ".exception" do
+      context "with no arguments" do
+        it "returns the original object" do
+          ProtocolError.exception.should be == ProtocolError.new
+        end
+      end
+
+      context "with self as the argument" do
+        it "returns the original object" do
+          ProtocolError.exception(subject).should be == ProtocolError.new(subject.to_s)
+        end
+      end
+
+      context "with other values" do
+        it "returns a new object with the appropriate values" do
+          e = ProtocolError.exception 'FooBar'
+          e.name.should == nil
+          e.text.should == nil
+          e.call_id.should == nil
+          e.component_id.should == nil
+        end
+      end
+    end
+
+    describe "#exception" do
+      context "with no arguments" do
+        it "returns the original object" do
+          subject.exception.should be subject
+        end
+      end
+
+      context "with self as the argument" do
+        it "returns the original object" do
+          subject.exception(subject).should be subject
+        end
+      end
+
+      context "with other values" do
+        it "returns a new object with the appropriate values" do
+          e = subject.exception("Boo")
+          e.name.should == name
+          e.text.should == text
+          e.call_id.should == call_id
+          e.component_id.should == component_id
+        end
+      end
+    end
+
     describe "comparison" do
       context "with the same name, text, call ID and component ID" do
-        let(:comparison) { ProtocolError.new name, text, call_id, component_id }
+        let(:comparison) { ProtocolError.new.setup name, text, call_id, component_id }
         it { should be == comparison }
       end
 
       context "with a different name" do
-        let(:comparison) { ProtocolError.new :foo, text, call_id, component_id }
+        let(:comparison) { ProtocolError.new.setup :foo, text, call_id, component_id }
         it { should_not be == comparison }
       end
 
       context "with a different text" do
-        let(:comparison) { ProtocolError.new name, 'foo', call_id, component_id }
+        let(:comparison) { ProtocolError.new.setup name, 'foo', call_id, component_id }
         it { should_not be == comparison }
       end
 
       context "with a different call ID" do
-        let(:comparison) { ProtocolError.new name, text, 'foo', component_id }
+        let(:comparison) { ProtocolError.new.setup name, text, 'foo', component_id }
         it { should_not be == comparison }
       end
 
       context "with a different component ID" do
-        let(:comparison) { ProtocolError.new name, text, call_id, 'foo' }
+        let(:comparison) { ProtocolError.new.setup name, text, call_id, 'foo' }
         it { should_not be == comparison }
       end
     end

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

@@ -745,7 +745,7 @@ module Punchblock
             context "for an unknown component ID" do
               it 'sends an error in response to the command' do
                 subject.execute_command command
-                command.response.should be == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id} for call #{subject.id}", subject.id, component_id)
+                command.response.should be == ProtocolError.new.setup('component-not-found', "Could not find a component with ID #{component_id} for call #{subject.id}", subject.id, component_id)
               end
             end
           end
@@ -757,7 +757,7 @@ module Punchblock
 
             it 'sends an error in response to the command' do
               subject.execute_command command
-              command.response.should be == ProtocolError.new('command-not-acceptable', "Did not understand command for call #{subject.id}", subject.id)
+              command.response.should be == ProtocolError.new.setup('command-not-acceptable', "Did not understand command for call #{subject.id}", subject.id)
             end
           end
 
@@ -848,6 +848,37 @@ module Punchblock
             subject.send_ami_action 'foo', :foo => :bar
           end
         end
+
+        describe '#redirect_back' do
+            let(:other_channel)         { 'SIP/bar' }
+            let :other_call do
+              Call.new other_channel, translator
+            end
+
+            it "executes the proper AMI action with only the subject call" do
+              subject.redirect_back
+              ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
+              ami_action.name.should be == "redirect"
+              ami_action.headers['Channel'].should be == channel
+              ami_action.headers['Exten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['Priority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['Context'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+            end
+            
+            it "executes the proper AMI action with another call specified" do
+              subject.redirect_back other_call
+              ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
+              ami_action.name.should be == "redirect"
+              ami_action.headers['Channel'].should be == channel
+              ami_action.headers['Exten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['Priority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['Context'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+              ami_action.headers['ExtraChannel'].should be == other_channel
+              ami_action.headers['ExtraExten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['ExtraPriority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['ExtraContext'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+            end
+        end
       end
     end
   end