punchblock 0.9.1 → 0.9.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # develop
 
+# v0.9.2 - 2012-02-18
+  * Feature: Asterisk calls receiving media commands are implicitly answered
+  * Bugfix: Unrenderable output documents on Asterisk should return a sensible error
+  * Bugfix: Log the target of commands correctly
+  * Bugfix: Do not wrap exceptions in ProtocolError
+
 # v0.9.1 - 2012-01-30
   * Bugfix: Closing an disconnected XMPP connection is a no-op
 

data/lib/punchblock/connection/xmpp.rb

@@ -61,7 +61,7 @@ module Punchblock
         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}"
+          pb_logger.debug "Sending IQ ID #{iq.id} #{command.inspect} to #{iq.to}"
           iq << command
         end
       end
@@ -78,11 +78,6 @@ module Punchblock
           EM.run { client.run }
         rescue Blather::Stream::ConnectionFailed, Blather::Stream::ConnectionTimeout => e
           raise DisconnectedError.new(e.class.to_s, e.message)
-        rescue => e
-          # Preserve Punchblock native exceptions
-          raise e if e.class.to_s =~ /^Punchblock/
-          # Wrap everything else
-          raise ProtocolError.new(e.class.to_s, e.message)
         end
       end
 

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

@@ -22,6 +22,7 @@ module Punchblock
           @channel, @translator = channel, translator
           @agi_env = parse_environment agi_env
           @id, @components = UUIDTools::UUID.random_create.to_s, {}
+          @answered = false
           pb_logger.debug "Starting up call with channel #{channel}, id #{@id}"
         end
 
@@ -73,6 +74,15 @@ module Punchblock
           direction == :inbound
         end
 
+        def answered?
+          @answered
+        end
+
+        def answer_if_not_answered
+          return if answered? || outbound?
+          execute_command Command::Answer.new
+        end
+
         def channel=(other)
           pb_logger.info "Channel is changing from #{channel} to #{other}."
           @channel = other
@@ -98,6 +108,7 @@ module Punchblock
             when '5'
               send_pb_event Event::Ringing.new
             when '6'
+              @answered = true
               send_pb_event Event::Answered.new
             end
           end

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

@@ -12,6 +12,7 @@ module Punchblock
           end
 
           def execute
+            @call.answer_if_not_answered
             initial_timeout = @component_node.initial_timeout || -1
             @inter_digit_timeout = @component_node.inter_digit_timeout || -1
 

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

@@ -11,6 +11,8 @@ module Punchblock
           end
 
           def execute
+            @call.answer_if_not_answered
+
             return with_error 'option error', 'An SSML document is required.' unless @component_node.ssml
 
             return with_error 'option error', 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
@@ -27,6 +29,8 @@ module Punchblock
                 case node
                 when RubySpeech::SSML::Audio
                   lambda { current_actor.play_audio! node.src }
+                else
+                  return with_error 'unrenderable document error', 'The provided document could not be rendered.'
                 end
               end.compact
 

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

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

@@ -99,6 +99,49 @@ module Punchblock
           end
         end
 
+        describe '#answer_if_not_answered' do
+          let(:answer_command) { Command::Answer.new }
+
+          context "with a call that is already answered" do
+            it 'should not answer the call' do
+              subject.wrapped_object.expects(:'answered?').returns true
+              subject.wrapped_object.expects(:execute_command).never
+              subject.answer_if_not_answered
+            end
+          end
+
+          context "with an unanswered call" do
+            before do
+              subject.wrapped_object.expects(:'answered?').returns false
+            end
+
+            context "with a call that is outbound" do
+              let(:dial_command) { Command::Dial.new }
+
+              before do
+                dial_command.request!
+                subject.dial dial_command
+              end
+
+              it 'should not answer the call' do
+                subject.wrapped_object.expects(:execute_command).never
+                subject.answer_if_not_answered
+              end
+            end
+
+            context "with a call that is inbound" do
+              before do
+                subject.send_offer
+              end
+
+              it 'should answer a call that is inbound and not answered' do
+                subject.wrapped_object.expects(:execute_command).with(answer_command)
+                subject.answer_if_not_answered
+              end
+            end
+          end
+        end
+
         describe '#dial' do
           let(:dial_command_options) { {} }
 
@@ -354,6 +397,11 @@ module Punchblock
                 translator.expects(:handle_pb_event!).with expected_ringing
                 subject.process_ami_event ami_event
               end
+
+              it '#answered? should return false' do
+                subject.process_ami_event ami_event
+                subject.answered?.should be_false
+              end
             end
 
             context 'up' do
@@ -366,6 +414,11 @@ module Punchblock
                 translator.expects(:handle_pb_event!).with expected_answered
                 subject.process_ami_event ami_event
               end
+
+              it '#answered? should be true' do
+                subject.process_ami_event ami_event
+                subject.answered?.should be_true
+              end
             end
           end
 

data/spec/punchblock/translator/asterisk/component/input_spec.rb

@@ -40,6 +40,13 @@ module Punchblock
           describe '#execute' do
             before { command.request! }
 
+            it "calls answer_if_not_answered on the call" do
+              call.expects :answer_if_not_answered
+              subject.execute
+            end
+
+            before { call.stubs :answer_if_not_answered }
+
             context 'with a media engine of :unimrcp' do
               pending
               let(:media_engine) { :unimrcp }

data/spec/punchblock/translator/asterisk/component/output_spec.rb

@@ -33,6 +33,13 @@ module Punchblock
           describe '#execute' do
             before { command.request! }
 
+            it "calls answer_if_not_answered on the call" do
+              mock_call.expects :answer_if_not_answered
+              subject.execute
+            end
+
+            before { mock_call.stubs :answer_if_not_answered }
+
             context 'with a media engine of :unimrcp' do
               let(:media_engine) { :unimrcp }
 
@@ -247,7 +254,6 @@ module Punchblock
               let :ssml_doc do
                 RubySpeech::SSML.draw do
                   audio :src => audio_filename
-                  say_as(:interpret_as => :cardinal) { 'FOO' }
                 end
               end
 
@@ -332,6 +338,22 @@ module Punchblock
                     subject.execute
                   end
                 end
+
+                context "with an SSML document containing elements other than <audio/>" do
+                  let :command_options do
+                    {
+                      :ssml => RubySpeech::SSML.draw do
+                        string "FooBar"
+                      end
+                    }
+                  end
+
+                  it "should return an unrenderable document error" do
+                    subject.execute
+                    error = ProtocolError.new 'unrenderable document error', 'The provided document could not be rendered.'
+                    command.response(0.1).should == error
+                  end
+                end
               end
 
               describe 'start-offset' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000 Z
+date: 2012-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2156532180 !ruby/object:Gem::Requirement
+  requirement: &2160948720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2156532180
+  version_requirements: *2160948720
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2156531500 !ruby/object:Gem::Requirement
+  requirement: &2160948120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.12
   type: :runtime
   prerelease: false
-  version_requirements: *2156531500
+  version_requirements: *2160948120
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156530720 !ruby/object:Gem::Requirement
+  requirement: &2160942420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156530720
+  version_requirements: *2160942420
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2156527320 !ruby/object:Gem::Requirement
+  requirement: &2160941560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2156527320
+  version_requirements: *2160941560
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2156526620 !ruby/object:Gem::Requirement
+  requirement: &2160940660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156526620
+  version_requirements: *2160940660
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2156525820 !ruby/object:Gem::Requirement
+  requirement: &2160939900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156525820
+  version_requirements: *2160939900
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2156525140 !ruby/object:Gem::Requirement
+  requirement: &2160939080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156525140
+  version_requirements: *2160939080
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2156524300 !ruby/object:Gem::Requirement
+  requirement: &2160938500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2156524300
+  version_requirements: *2160938500
 - !ruby/object:Gem::Dependency
   name: ruby_speech
-  requirement: &2156523400 !ruby/object:Gem::Requirement
+  requirement: &2160937920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *2156523400
+  version_requirements: *2160937920
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156522860 !ruby/object:Gem::Requirement
+  requirement: &2160937220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156522860
+  version_requirements: *2160937220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156522160 !ruby/object:Gem::Requirement
+  requirement: &2160936620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -133,10 +133,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2156522160
+  version_requirements: *2160936620
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2156521620 !ruby/object:Gem::Requirement
+  requirement: &2160935800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2156521620
+  version_requirements: *2160935800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156520980 !ruby/object:Gem::Requirement
+  requirement: &2160935180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2156520980
+  version_requirements: *2160935180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156520420 !ruby/object:Gem::Requirement
+  requirement: &2160934640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156520420
+  version_requirements: *2160934640
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156519840 !ruby/object:Gem::Requirement
+  requirement: &2160934140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156519840
+  version_requirements: *2160934140
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2156516740 !ruby/object:Gem::Requirement
+  requirement: &2160933560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156516740
+  version_requirements: *2160933560
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2156515500 !ruby/object:Gem::Requirement
+  requirement: &2160933040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156515500
+  version_requirements: *2160933040
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156514720 !ruby/object:Gem::Requirement
+  requirement: &2160932600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,7 +210,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156514720
+  version_requirements: *2160932600
 description: Like Rack is to Rails and Sinatra, Punchblock provides a consistent API
   on top of several underlying third-party call control protocols.
 email: punchblock@adhearsion.com
@@ -351,7 +351,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4401159301210104639
+      hash: 326151845753571314
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: