punchblock 2.5.2 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb567322334ceb90d6813db4059f8daa82d68e2e
-  data.tar.gz: b9b41cf838b4a5507ff24c0bed04967d9b9e6f69
+  metadata.gz: 63ef1da0eed86d39e520b4e10984e068c8dc62e6
+  data.tar.gz: 6b48e400972ac2516337faae2a52f85089dab0cc
 SHA512:
-  metadata.gz: 0fa93d60594fe156ed0edb84f3b59cb82943fe79be860770f2fb5a047d5189fdc6114b859a899f8819189dc66a162c5beaf1c0fe8b701bf4c16b80607c997e33
-  data.tar.gz: 9d67e526bec8927736dfe9f5178655f7deb9957643c6171bbb97702010234b8e26eb59226899d690bcac247c0bb819662888ff16adeacfcb30a3a59f1bfd9dc3
+  metadata.gz: f8b33066c0816e1ac83c9911e3a8ba5b9ca717344d9bd970709a3555ba92e52f3170886ba3261d5b9b66ed95dd49e4edee63311723dc026f4f302d60c7e058d8
+  data.tar.gz: 6156cb56046135c814b3e11fe1844236d075a227e12972c2efa63a56ad5079314791a131b2e22136222a7626497af1f23beca04596f0200bb0732ec67b4448cd

data/.hound.yml

@@ -0,0 +1,2 @@
+LineLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v2.5.3](https://github.com/adhearsion/punchblock/compare/v2.5.2...v2.5.3) - [2014-09-22](https://rubygems.org/gems/punchblock/versions/2.5.3)
+  * Bugfix: Prevent Asterisk translator death due to dead DTMF recognizers ([#221](https://github.com/adhearsion/punchblock/pull/221), [adhearsion/adhearsion#479](https://github.com/adhearsion/adhearsion/issues/479))
+  * Bugfix: Be more intelligent about only stripping true file extensions off filenames for playback on Asterisk ([adhearsion/adhearsion#482](https://github.com/adhearsion/adhearsion/issues/482))
+  * Bugfix: Handle a corner case crash where a recognition request is interrupted directly after a successful recognition has completed
+  * Bugfix: Avoid cases where executing AGI commands (reported as sending SIP messages) might block indefinitely due to a race condition in fetching their response value
+
 # [v2.5.2](https://github.com/adhearsion/punchblock/compare/v2.5.1...v2.5.2) - [2014-04-03](https://rubygems.org/gems/punchblock/versions/2.5.2)
   * Bugfix: No longer confound start and stop beeps on record commands (#220)
 

data/README.markdown

@@ -3,6 +3,7 @@
 [![Dependency Status](https://gemnasium.com/adhearsion/punchblock.png?travis)](https://gemnasium.com/adhearsion/punchblock)
 [![Code Climate](https://codeclimate.com/github/adhearsion/punchblock.png)](https://codeclimate.com/github/adhearsion/punchblock)
 [![Coverage Status](https://coveralls.io/repos/adhearsion/punchblock/badge.png?branch=develop)](https://coveralls.io/r/adhearsion/punchblock)
+[![Inline docs](http://inch-ci.org/github/adhearsion/punchblock.png?branch=develop)](http://inch-ci.org/github/adhearsion/punchblock)
 
 # Punchblock
 Punchblock is a middleware library for telephony applications. Like Rack is to Rails and Sinatra, Punchblock provides a consistent API on top of several underlying third-party call control protocols.
@@ -38,4 +39,4 @@ The best available usage documentation available for Punchblock is by example, i
 
 ## Copyright
 
-Copyright (c) 2013 Adhearsion Foundation Inc. MIT licence (see LICENSE for details).
+Copyright (c) 2014 Adhearsion Foundation Inc. MIT licence (see LICENSE for details).

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

@@ -254,12 +254,12 @@ module Punchblock
         # @raises RubyAMI::Error, ChannelGoneError
         def execute_agi_command(command, *params)
           agi = AGICommand.new Punchblock.new_uuid, channel, command, *params
-          condition = Celluloid::Condition.new
+          response = Celluloid::Future.new
           register_tmp_handler :ami, name: 'AsyncAGI', [:[], 'SubEvent'] => 'Exec', [:[], 'CommandID'] => agi.id do |event|
-            condition.signal event
+            response.signal Celluloid::SuccessResponse.new(nil, event)
           end
           agi.execute @ami_client
-          event = condition.wait
+          event = response.value
           return unless event
           agi.parse_result event
         end

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

@@ -38,7 +38,6 @@ module Punchblock
 
           def execute_app(app, *args)
             UniMRCPApp.new(app, *args, unimrcp_app_options).execute @call
-            raise UniMRCPError if @call.channel_var('RECOG_STATUS') == 'ERROR'
           end
 
           def unimrcp_app_options
@@ -85,14 +84,21 @@ module Punchblock
           end
 
           def complete
-            send_complete_event case @call.channel_var('RECOG_COMPLETION_CAUSE')
-            when '000'
-              nlsml = RubySpeech.parse URI.decode(@call.channel_var('RECOG_RESULT'))
-              Punchblock::Component::Input::Complete::Match.new nlsml: nlsml
-            when '001'
-              Punchblock::Component::Input::Complete::NoMatch.new
-            when '002'
-              Punchblock::Component::Input::Complete::NoInput.new
+            case @call.channel_var('RECOG_STATUS') 
+            when 'INTERRUPTED'
+              send_complete_event Punchblock::Component::Input::Complete::NoMatch.new
+            when 'ERROR'
+              raise UniMRCPError
+            else 
+              send_complete_event case @call.channel_var('RECOG_COMPLETION_CAUSE')
+              when '000'
+                nlsml = RubySpeech.parse URI.decode(@call.channel_var('RECOG_RESULT'))
+                Punchblock::Component::Input::Complete::Match.new nlsml: nlsml
+              when '001'
+                Punchblock::Component::Input::Complete::NoMatch.new
+              when '002'
+                Punchblock::Component::Input::Complete::NoInput.new
+              end
             end
           end
         end

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

@@ -126,7 +126,14 @@ module Punchblock
           end
 
           def path_for_audio_node(node)
-            node.src.sub('file://', '').gsub(/\.[^\.]*$/, '')
+            path = node.src.sub('file://', '')
+            dir = File.dirname(path)
+            basename = File.basename(path, '.*')
+            if dir == '.'
+              basename
+            else
+              File.join(dir, basename)
+            end
           end
 
           def filenames(doc, check_audio_only_policy = -> {})

data/lib/punchblock/translator/input_component.rb

@@ -14,6 +14,8 @@ module Punchblock
 
       def process_dtmf(digit)
         @recognizer << digit
+      rescue Celluloid::DeadActorError
+        pb_logger.warn 'DTMF digit received into a dead recognizer. Dropping digit.'
       end
 
       def execute_command(command)

data/lib/punchblock/version.rb

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

data/punchblock.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<state_machine>, ["~> 1.0"]
   s.add_runtime_dependency %q<future-resource>, ["~> 1.0"]
   s.add_runtime_dependency %q<has-guarded-handlers>, ["~> 1.5"]
-  s.add_runtime_dependency %q<celluloid>, ["~> 0.14"]
+  s.add_runtime_dependency %q<celluloid>, ["~> 0.15.2"]
   s.add_runtime_dependency %q<ruby_ami>, ["~> 2.2"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.1"]
   s.add_runtime_dependency %q<ruby_speech>, ["~> 2.3"]

data/spec/punchblock/client/component_registry_spec.rb

@@ -10,14 +10,14 @@ module Punchblock
 
       it 'should store components and allow lookup by ID' do
         subject << component
-        subject.find_by_uri(uri).should be component
+        expect(subject.find_by_uri(uri)).to be component
       end
 
       it 'should allow deletion of components' do
         subject << component
-        subject.find_by_uri(uri).should be component
+        expect(subject.find_by_uri(uri)).to be component
         subject.delete component
-        subject.find_by_uri(uri).should be_nil
+        expect(subject.find_by_uri(uri)).to be_nil
       end
     end
   end

data/spec/punchblock/client_spec.rb

@@ -8,8 +8,15 @@ module Punchblock
 
     subject { Client.new :connection => connection }
 
-    its(:connection)          { should be connection }
-    its(:component_registry)  { should be_a Client::ComponentRegistry }
+    describe '#connection' do
+      subject { super().connection }
+      it { should be connection }
+    end
+
+    describe '#component_registry' do
+      subject { super().component_registry }
+      it { should be_a Client::ComponentRegistry }
+    end
 
     let(:call_id)         { 'abc123' }
     let(:mock_event)      { double('Event').as_null_object }
@@ -20,14 +27,14 @@ module Punchblock
 
     describe '#run' do
       it 'should start up the connection' do
-        connection.should_receive(:run).once
+        expect(connection).to receive(:run).once
         subject.run
       end
     end
 
     describe '#stop' do
       it 'should stop the connection' do
-        connection.should_receive(:stop).once
+        expect(connection).to receive(:stop).once
         subject.stop
       end
     end
@@ -35,7 +42,7 @@ module Punchblock
     describe '#send_message' do
       it 'should send a message' do
         args = [ "someone", "example.org", "Hello World!" ]
-        connection.should_receive(:send_message).with(*args).once
+        expect(connection).to receive(:send_message).with(*args).once
         subject.send_message *args
       end
     end
@@ -43,12 +50,12 @@ module Punchblock
     describe '#new_call_uri' do
       it 'should return the connection-specific fresh call ID' do
         stub_uuids 'foobar'
-        subject.new_call_uri.should == 'xmpp:foobar@call.rayo.net'
+        expect(subject.new_call_uri).to eq('xmpp:foobar@call.rayo.net')
       end
     end
 
     it 'should handle connection events' do
-      subject.should_receive(:handle_event).with(mock_event).once
+      expect(subject).to receive(:handle_event).with(mock_event).once
       connection.event_handler.call mock_event
     end
 
@@ -56,18 +63,18 @@ module Punchblock
       it "sets the event's client" do
         event = Event::Offer.new
         subject.handle_event event
-        event.client.should be subject
+        expect(event.client).to be subject
       end
 
       context 'if the event can be associated with a source component' do
         before do
           mock_event.stub :source => mock_component
-          mock_component.should_receive(:add_event).with mock_event
+          expect(mock_component).to receive(:add_event).with mock_event
         end
 
         it 'should not call event handlers' do
           handler = double 'handler'
-          handler.should_receive(:call).never
+          expect(handler).to receive(:call).never
           subject.register_event_handler do |event|
             handler.call event
           end
@@ -82,7 +89,7 @@ module Punchblock
 
         it 'should call registered event handlers' do
           handler = double 'handler'
-          handler.should_receive(:call).once.with mock_event
+          expect(handler).to receive(:call).once.with mock_event
           subject.register_event_handler do |event|
             handler.call event
           end
@@ -93,7 +100,7 @@ module Punchblock
 
     it 'should be able to register and retrieve components' do
       subject.register_component mock_component
-      subject.find_component_by_uri(component_uri).should be mock_component
+      expect(subject.find_component_by_uri(component_uri)).to be mock_component
     end
 
     describe '#execute_command' do
@@ -101,7 +108,7 @@ module Punchblock
       let(:event)     { Event::Complete.new }
 
       before do
-        connection.should_receive(:write).once.with component, :call_id => call_id
+        expect(connection).to receive(:write).once.with component, :call_id => call_id
       end
 
       let :execute_command do
@@ -114,11 +121,11 @@ module Punchblock
 
       it "should set the command's client" do
         execute_command
-        component.client.should be subject
+        expect(component.client).to be subject
       end
 
       it "should handle a component's events" do
-        subject.should_receive(:trigger_handler).with(:event, event).once
+        expect(subject).to receive(:trigger_handler).with(:event, event).once
         execute_command
         component.request!
         component.execute!

data/spec/punchblock/command/accept_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   module Command
     describe Accept do
       it 'registers itself' do
-        RayoNode.class_from_registration(:accept, 'urn:xmpp:rayo:1').should be == described_class
+        expect(RayoNode.class_from_registration(:accept, 'urn:xmpp:rayo:1')).to eq(described_class)
       end
 
       describe "from a stanza" do
@@ -22,25 +22,35 @@ module Punchblock
         subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
         it { should be_instance_of described_class }
-        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        describe '#headers' do
+          subject { super().headers }
+          it { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         context "with no headers provided" do
           let(:stanza) { '<accept xmlns="urn:xmpp:rayo:1"/>' }
 
-          its(:headers) { should == {} }
+          describe '#headers' do
+            subject { super().headers }
+            it { should == {} }
+          end
         end
       end
 
       describe "when setting options in initializer" do
         subject { described_class.new headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
-        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        describe '#headers' do
+          subject { super().headers }
+          it { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         describe "exporting to Rayo" do
           it "should export to XML that can be understood by its parser" do
             new_instance = RayoNode.from_xml subject.to_rayo
-            new_instance.should be_instance_of described_class
-            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+            expect(new_instance).to be_instance_of described_class
+            expect(new_instance.headers).to eq({ 'X-skill' => 'agent', 'X-customer-id' => '8877' })
           end
 
           it "should render to a parent node if supplied" do
@@ -48,7 +58,7 @@ module Punchblock
             parent = Nokogiri::XML::Node.new 'foo', doc
             doc.root = parent
             rayo_doc = subject.to_rayo(parent)
-            rayo_doc.should == parent
+            expect(rayo_doc).to eq(parent)
           end
         end
       end

data/spec/punchblock/command/answer_spec.rb

@@ -6,7 +6,7 @@ module Punchblock
   module Command
     describe Answer do
       it 'registers itself' do
-        RayoNode.class_from_registration(:answer, 'urn:xmpp:rayo:1').should be == described_class
+        expect(RayoNode.class_from_registration(:answer, 'urn:xmpp:rayo:1')).to eq(described_class)
       end
 
       describe "from a stanza" do
@@ -22,25 +22,35 @@ module Punchblock
         subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' }
 
         it { should be_instance_of described_class }
-        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+
+        describe '#headers' do
+          subject { super().headers }
+          it { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         context "with no headers provided" do
           let(:stanza) { '<answer xmlns="urn:xmpp:rayo:1"/>' }
 
-          its(:headers) { should == {} }
+          describe '#headers' do
+            subject { super().headers }
+            it { should == {} }
+          end
         end
       end
 
       describe "when setting options in initializer" do
         subject { described_class.new headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
 
-        its(:headers) { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        describe '#headers' do
+          subject { super().headers }
+          it { should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         describe "exporting to Rayo" do
           it "should export to XML that can be understood by its parser" do
             new_instance = RayoNode.from_xml subject.to_rayo
-            new_instance.should be_instance_of described_class
-            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+            expect(new_instance).to be_instance_of described_class
+            expect(new_instance.headers).to eq({ 'X-skill' => 'agent', 'X-customer-id' => '8877' })
           end
 
           it "should render to a parent node if supplied" do
@@ -48,7 +58,7 @@ module Punchblock
             parent = Nokogiri::XML::Node.new 'foo', doc
             doc.root = parent
             rayo_doc = subject.to_rayo(parent)
-            rayo_doc.should == parent
+            expect(rayo_doc).to eq(parent)
           end
 
           context "with multiple headers of the same name" do
@@ -56,8 +66,8 @@ module Punchblock
 
             it "should export to XML that can be understood by its parser" do
               new_instance = RayoNode.from_xml subject.to_rayo
-              new_instance.should be_instance_of described_class
-              new_instance.headers.should == { 'X-skill' => ['sales', 'complaints'] }
+              expect(new_instance).to be_instance_of described_class
+              expect(new_instance.headers).to eq({ 'X-skill' => ['sales', 'complaints'] })
             end
           end
         end

data/spec/punchblock/command/dial_spec.rb

@@ -7,7 +7,7 @@ module Punchblock
     describe Dial do
 
       it 'registers itself' do
-        RayoNode.class_from_registration(:dial, 'urn:xmpp:rayo:1').should be == described_class
+        expect(RayoNode.class_from_registration(:dial, 'urn:xmpp:rayo:1')).to eq(described_class)
       end
 
       let(:join_params) { {:call_uri => 'abc123'} }
@@ -15,23 +15,46 @@ module Punchblock
       describe "when setting options in initializer" do
         subject { described_class.new to: 'tel:+14155551212', from: 'tel:+13035551212', uri: 'xmpp:foo@bar.com', timeout: 30000, headers: { 'X-skill' => 'agent', 'X-customer-id' => '8877' }, join: join_params }
 
-        its(:to)      { should be == 'tel:+14155551212' }
-        its(:from)    { should be == 'tel:+13035551212' }
-        its(:uri)     { should be == 'xmpp:foo@bar.com' }
-        its(:timeout) { should be == 30000 }
-        its(:join)    { should be == Join.new(join_params) }
-        its(:headers) { should be == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        describe '#to' do
+          subject { super().to }
+          it { should be == 'tel:+14155551212' }
+        end
+
+        describe '#from' do
+          subject { super().from }
+          it { should be == 'tel:+13035551212' }
+        end
+
+        describe '#uri' do
+          subject { super().uri }
+          it { should be == 'xmpp:foo@bar.com' }
+        end
+
+        describe '#timeout' do
+          subject { super().timeout }
+          it { should be == 30000 }
+        end
+
+        describe '#join' do
+          subject { super().join }
+          it { should be == Join.new(join_params) }
+        end
+
+        describe '#headers' do
+          subject { super().headers }
+          it { should be == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         describe "exporting to Rayo" do
           it "should export to XML that can be understood by its parser" do
             new_instance = RayoNode.from_xml subject.to_rayo
-            new_instance.should be_instance_of described_class
-            new_instance.to.should == 'tel:+14155551212'
-            new_instance.from.should == 'tel:+13035551212'
-            new_instance.uri.should == 'xmpp:foo@bar.com'
-            new_instance.timeout.should == 30000
-            new_instance.join.should == Join.new(join_params)
-            new_instance.headers.should == { 'X-skill' => 'agent', 'X-customer-id' => '8877' }
+            expect(new_instance).to be_instance_of described_class
+            expect(new_instance.to).to eq('tel:+14155551212')
+            expect(new_instance.from).to eq('tel:+13035551212')
+            expect(new_instance.uri).to eq('xmpp:foo@bar.com')
+            expect(new_instance.timeout).to eq(30000)
+            expect(new_instance.join).to eq(Join.new(join_params))
+            expect(new_instance.headers).to eq({ 'X-skill' => 'agent', 'X-customer-id' => '8877' })
           end
 
           it "should render to a parent node if supplied" do
@@ -39,15 +62,15 @@ module Punchblock
             parent = Nokogiri::XML::Node.new 'foo', doc
             doc.root = parent
             rayo_doc = subject.to_rayo(parent)
-            rayo_doc.should == parent
+            expect(rayo_doc).to eq(parent)
           end
 
           context "when attributes are not set" do
             subject { described_class.new to: 'abc123' }
 
             it "should not include them in the XML representation" do
-              subject.to_rayo['to'].should == 'abc123'
-              subject.to_rayo['from'].should be_nil
+              expect(subject.to_rayo['to']).to eq('abc123')
+              expect(subject.to_rayo['from']).to be_nil
             end
           end
         end
@@ -68,17 +91,43 @@ module Punchblock
 
         it { should be_instance_of described_class }
 
-        its(:to)      { should be == 'tel:+14155551212' }
-        its(:from)    { should be == 'tel:+13035551212' }
-        its(:uri)     { should be == 'xmpp:foo@bar.com' }
-        its(:timeout) { should be == 30000 }
-        its(:join)    { should be == Join.new(join_params) }
-        its(:headers) { should be == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        describe '#to' do
+          subject { super().to }
+          it { should be == 'tel:+14155551212' }
+        end
+
+        describe '#from' do
+          subject { super().from }
+          it { should be == 'tel:+13035551212' }
+        end
+
+        describe '#uri' do
+          subject { super().uri }
+          it { should be == 'xmpp:foo@bar.com' }
+        end
+
+        describe '#timeout' do
+          subject { super().timeout }
+          it { should be == 30000 }
+        end
+
+        describe '#join' do
+          subject { super().join }
+          it { should be == Join.new(join_params) }
+        end
+
+        describe '#headers' do
+          subject { super().headers }
+          it { should be == { 'X-skill' => 'agent', 'X-customer-id' => '8877' } }
+        end
 
         context "with no headers provided" do
           let(:stanza) { '<dial xmlns="urn:xmpp:rayo:1"/>' }
 
-          its(:headers) { should == {} }
+          describe '#headers' do
+            subject { super().headers }
+            it { should == {} }
+          end
         end
       end
 
@@ -94,17 +143,17 @@ module Punchblock
 
         it "should set the transport from the ref" do
           subject.response = ref
-          subject.transport.should be == 'xmpp'
+          expect(subject.transport).to eq('xmpp')
         end
 
         it "should set the call ID from the ref" do
           subject.response = ref
-          subject.target_call_id.should be == call_id
+          expect(subject.target_call_id).to eq(call_id)
         end
 
         it "should set the domain from the ref" do
           subject.response = ref
-          subject.domain.should be == domain
+          expect(subject.domain).to eq(domain)
         end
       end
     end