punchblock 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fd9d8e6a3b698f31b5807e789454fc7231ed468
-  data.tar.gz: 4128a656a2bbbba2a1dedf0cb9a8a7269a8f73be
+  metadata.gz: b8dddb3e5a8b1158136add6d851f6f40fbe94438
+  data.tar.gz: ff999c1ed2536e739167e74ab6d9ac96c188f0e9
 SHA512:
-  metadata.gz: a89def0af7a9299fe9278115c9495694c7092d34b54d6a20148e00761999b484a21682b9ed867dd3880e5720177a7e8341f5487677f0aa9d38df28d268d17f9d
-  data.tar.gz: 9a6a06392dc2c41a29f55443c2093d1505be65974f2796308ce9ea3b3b1e02b5b6b198ff634e7794d27d89319ceede8d73dcd1de157b4b2aeae01e3645b50bff
+  metadata.gz: 8817401f7029230cc46119a8fabe2a525b72c0af9375eb09127dfbbf8855617ac1a553b2fca2699accec6311df9d9bb378a6dff5322a9df0b26e6a994d2f66fb
+  data.tar.gz: 43668278a0c3943259fbbc75f4b0704e6cc617d41fb2f405b3b0fac1d6aa8093ea78bbf24a8c868b55b3ccced90da00648af8d3b5a18163cecb074dd1b845510

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v2.0.2](https://github.com/adhearsion/punchblock/compare/v2.0.1...v2.0.2) - [2013-10-17](https://rubygems.org/gems/punchblock/versions/2.0.2)
+  * Bugfix: Reject commands against components which have finished on Asterisk, and garbage collect them
+  * Bugfix: Register/lookup components by their full URI rather than component ID since the component ID may only be unique per call
+  * Bugfix: Hold back Virtus dependency to avoid API-breaking changes
+
 # [v2.0.1](https://github.com/adhearsion/punchblock/compare/v2.0.0...v2.0.1) - [2013-09-17](https://rubygems.org/gems/punchblock/versions/2.0.1)
   * Bugfix: Allow audio file URIs with file extensions on Asterisk
   * Bugfix: Input timers were being started before output finished on Asterisk composed prompts

data/Guardfile

@@ -4,6 +4,6 @@ guard 'rspec', :cli => '--format documentation' do
   watch('spec/spec_helper.rb')  { "spec/" }
 end
 
-guard 'rake', task: 'benchmark' do
+guard 'rake', task: 'benchmark', run_on_start: false do
   watch(/benchmarks\/*/)
 end

data/lib/punchblock/client.rb

@@ -38,8 +38,8 @@ module Punchblock
       component_registry << component
     end
 
-    def find_component_by_id(component_id)
-      component_registry.find_by_id component_id
+    def find_component_by_uri(uri)
+      component_registry.find_by_uri uri
     end
 
     def delete_component_registration(component)

data/lib/punchblock/client/component_registry.rb

@@ -10,20 +10,20 @@ module Punchblock
 
       def <<(component)
         @mutex.synchronize do
-          @components[component.component_id] = component
+          @components[component.source_uri] = component
         end
       end
 
-      def find_by_id(component_id)
+      def find_by_uri(uri)
         @mutex.synchronize do
-          @components[component_id]
+          @components[uri]
         end
       end
 
       def delete(component)
         @mutex.synchronize do
-          id = @components.key component
-          @components.delete id
+          uri = @components.key component
+          @components.delete uri
         end
       end
     end

data/lib/punchblock/component/component_node.rb

@@ -38,6 +38,7 @@ module Punchblock
       def response=(other)
         if other.is_a?(Ref)
           @component_id = other.component_id
+          @source_uri = other.uri.to_s
           client.register_component self if client
         end
         super

data/lib/punchblock/component/input.rb

@@ -28,10 +28,10 @@ module Punchblock
       # @return [Float] Indicates how sensitive the interpreter should be to loud versus quiet input. Higher values represent greater sensitivity.
       attribute :sensitivity, Float
 
-      # @return [Integer] Indicates the amount of time preceding input which may expire before a timeout is triggered.
+      # @return [Integer] Indicates the amount of time (in milliseconds) preceding input which may expire before a timeout is triggered.
       attribute :initial_timeout, Integer
 
-      # @return [Integer] Indicates (in the case of DTMF input) the amount of time between input digits which may expire before a timeout is triggered.
+      # @return [Integer] Indicates (in the case of DTMF input) the amount of time (in milliseconds) between input digits which may expire before a timeout is triggered.
       attribute :inter_digit_timeout, Integer
 
       attribute :grammars, Array, default: []

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

@@ -10,7 +10,7 @@ module Blather
     def rayo_node
       @rayo_node ||= begin
         first_child = at_xpath RAYO_NODE_PATH, Punchblock::RAYO_NAMESPACES
-        Punchblock::RayoNode.from_xml first_child, nil, component_id if first_child
+        Punchblock::RayoNode.from_xml first_child, nil, component_id, "xmpp:#{from}" if first_child
       end
     end
 

data/lib/punchblock/rayo_node.rb

@@ -14,6 +14,7 @@ module Punchblock
     attribute :target_call_id
     attribute :target_mixer_name
     attribute :component_id
+    attribute :source_uri
     attribute :domain
     attribute :transport
 
@@ -48,7 +49,7 @@ module Punchblock
     # elements of the XML::Node
     # @param [XML::Node] node the node to import
     # @return the appropriate object based on the node name and namespace
-    def self.from_xml(node, call_id = nil, component_id = nil)
+    def self.from_xml(node, call_id = nil, component_id = nil, uri = nil)
       ns = (node.namespace.href if node.namespace)
       klass = class_from_registration(node.name, ns)
       if klass && klass != self
@@ -58,6 +59,7 @@ module Punchblock
       end.tap do |event|
         event.target_call_id = call_id
         event.component_id = component_id
+        event.source_uri = uri
       end
     end
 
@@ -85,7 +87,7 @@ module Punchblock
     # @return [RayoNode] the original command issued that lead to this event
     #
     def source
-      @source ||= client.find_component_by_id component_id if client && component_id
+      @source ||= client.find_component_by_uri source_uri if client && source_uri
       @source ||= original_component
     end
 

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

@@ -291,10 +291,10 @@ module Punchblock
         end
 
         def actor_died(actor, reason)
-          return unless reason
           if id = @components.key(actor)
             @components.delete id
-            complete_event = Punchblock::Event::Complete.new :component_id => id, :reason => Punchblock::Event::Complete::Error.new
+            return unless reason
+            complete_event = Punchblock::Event::Complete.new :component_id => id, source_uri: id, :reason => Punchblock::Event::Complete::Error.new
             send_pb_event complete_event
           end
         end

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

@@ -48,6 +48,7 @@ module Punchblock
           def send_event(event)
             event.component_id    = id
             event.target_call_id  = call_id
+            event.source_uri      = id
             safe_from_dead_actors { translator.handle_pb_event event }
           end
 

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

@@ -236,7 +236,7 @@ module Punchblock
           pb_logger.error "A linked actor (#{actor.inspect}) died due to #{reason.inspect}"
           if id = @components.key(actor)
             @components.delete id
-            complete_event = Punchblock::Event::Complete.new :component_id => id, :reason => Punchblock::Event::Complete::Error.new
+            complete_event = Punchblock::Event::Complete.new :component_id => id, source_uri: id, :reason => Punchblock::Event::Complete::Error.new
             send_pb_event complete_event
           end
         end

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

@@ -53,6 +53,7 @@ module Punchblock
           def send_event(event)
             event.component_id    = id
             event.target_call_id  = call_id
+            event.source_uri      = id
             safe_from_dead_actors { translator.handle_pb_event event }
           end
 

data/lib/punchblock/version.rb

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

data/punchblock.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<ruby_ami>, ["~> 2.0"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.1"]
   s.add_runtime_dependency %q<ruby_speech>, ["~> 2.0"]
-  s.add_runtime_dependency %q<virtus>
+  s.add_runtime_dependency %q<virtus>, ["~> 0.5"]
   s.add_runtime_dependency %q<ruby_jid>, ["~> 1.0"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]

data/spec/punchblock/client/component_registry_spec.rb

@@ -5,19 +5,19 @@ require 'spec_helper'
 module Punchblock
   class Client
     describe ComponentRegistry do
-      let(:component_id)  { 'abc123' }
-      let(:component)     { double 'Component', :component_id => component_id }
+      let(:uri)       { 'abc123' }
+      let(:component) { double 'Component', source_uri: uri }
 
       it 'should store components and allow lookup by ID' do
         subject << component
-        subject.find_by_id(component_id).should be component
+        subject.find_by_uri(uri).should be component
       end
 
       it 'should allow deletion of components' do
         subject << component
-        subject.find_by_id(component_id).should be component
+        subject.find_by_uri(uri).should be component
         subject.delete component
-        subject.find_by_id(component_id).should be_nil
+        subject.find_by_uri(uri).should be_nil
       end
     end
   end

data/spec/punchblock/client_spec.rb

@@ -14,7 +14,8 @@ module Punchblock
     let(:call_id)         { 'abc123' }
     let(:mock_event)      { double('Event').as_null_object }
     let(:component_id)    { 'abc123' }
-    let(:mock_component)  { double 'Component', :component_id => component_id }
+    let(:component_uri)   { 'callid@server/abc123' }
+    let(:mock_component)  { double 'Component', source_uri: component_uri }
     let(:mock_command)    { double 'Command' }
 
     describe '#run' do
@@ -77,7 +78,7 @@ module Punchblock
 
     it 'should be able to register and retrieve components' do
       subject.register_component mock_component
-      subject.find_component_by_id(component_id).should be mock_component
+      subject.find_component_by_uri(component_uri).should be mock_component
     end
 
     describe '#execute_command' do

data/spec/punchblock/component/component_node_spec.rb

@@ -71,16 +71,17 @@ module Punchblock
           subject.client = Client.new
         end
 
-        let(:component_id) { 'abc123' }
+        let(:uri) { 'xmpp:callid@server/abc123' }
 
         let :ref do
-          Ref.new uri: component_id
+          Ref.new uri: uri
         end
 
         it "should set the component ID from the ref" do
           subject.response = ref
-          subject.component_id.should be == component_id
-          subject.client.find_component_by_id(component_id).should be subject
+          subject.component_id.should be == 'abc123'
+          subject.source_uri.should be == uri
+          subject.client.find_component_by_uri(uri).should be subject
         end
       end
 
@@ -89,7 +90,7 @@ module Punchblock
           subject.request!
           subject.client = Client.new
           subject.response = Ref.new uri: 'abc'
-          subject.client.find_component_by_id('abc').should be subject
+          subject.client.find_component_by_uri('abc').should be subject
         end
 
         it "should set the command to executing status" do
@@ -105,7 +106,7 @@ module Punchblock
 
         it "should remove the component from the registry" do
           subject.complete_event = :foo
-          subject.client.find_component_by_id('abc').should be_nil
+          subject.client.find_component_by_uri('abc').should be_nil
         end
       end
     end # ComponentNode

data/spec/punchblock/connection/xmpp_spec.rb

@@ -172,6 +172,7 @@ module Punchblock
               mock_event_handler.should_receive(:call).once.with do |event|
                 event.should be_instance_of Event::Offer
                 event.target_call_id.should be == '9f00061'
+                event.source_uri.should be == 'xmpp:9f00061@call.rayo.net'
                 event.domain.should be == 'call.rayo.net'
                 event.transport.should be == 'xmpp'
               end

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

@@ -312,7 +312,7 @@ module Punchblock
               comp_command.request!
               component = subject.execute_command comp_command
               comp_command.response(0.1).should be_a Ref
-              expected_complete_event = Punchblock::Event::Complete.new :target_call_id => subject.id, :component_id => component.id
+              expected_complete_event = Punchblock::Event::Complete.new :target_call_id => subject.id, :component_id => component.id, source_uri: component.id
               expected_complete_event.reason = Punchblock::Event::Complete::Hangup.new
               expected_end_event = Punchblock::Event::End.new :reason => :hangup, platform_code: cause, :target_call_id  => subject.id
 
@@ -1298,7 +1298,7 @@ module Punchblock
               end
             end
 
-            context "for a component which began executing but crashed" do
+            context "for a component which began executing but terminated" do
               let :component_command do
                 Punchblock::Component::Asterisk::AGI::Command.new :name => 'Wait'
               end
@@ -1310,6 +1310,7 @@ module Punchblock
               let :expected_event do
                 Punchblock::Event::Complete.new target_call_id: subject.id,
                   component_id: comp_id,
+                  source_uri: comp_id,
                   reason: Punchblock::Event::Complete::Error.new
               end
 
@@ -1318,35 +1319,52 @@ module Punchblock
                 subject.execute_command component_command
               end
 
-              it 'sends an error in response to the command' do
-                component = subject.component_with_id comp_id
-
-                component.wrapped_object.define_singleton_method(:oops) do
-                  raise 'Woops, I died'
-                end
-
-                translator.should_receive(:handle_pb_event).once.with expected_event
+              context "normally" do
+                it 'sends an error in response to the command' do
+                  component = subject.component_with_id comp_id
 
-                lambda { component.oops }.should raise_error(/Woops, I died/)
-                sleep 0.1
-                component.should_not be_alive
-                subject.component_with_id(comp_id).should be_nil
+                  component.terminate
+                  sleep 0.1
+                  component.should_not be_alive
+                  subject.component_with_id(comp_id).should be_nil
 
-                subsequent_command.request!
-                subject.execute_command subsequent_command
-                subsequent_command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{comp_id} for call #{subject.id}", subject.id, comp_id)
+                  subsequent_command.request!
+                  subject.execute_command subsequent_command
+                  subsequent_command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{comp_id} for call #{subject.id}", subject.id, comp_id)
+                end
               end
 
-              context "when we dispatch the command to it" do
+              context "by crashing" do
                 it 'sends an error in response to the command' do
                   component = subject.component_with_id comp_id
 
-                  component.should_receive(:execute_command).and_raise(Celluloid::DeadActorError)
+                  component.wrapped_object.define_singleton_method(:oops) do
+                    raise 'Woops, I died'
+                  end
+
+                  translator.should_receive(:handle_pb_event).once.with expected_event
+
+                  lambda { component.oops }.should raise_error(/Woops, I died/)
+                  sleep 0.1
+                  component.should_not be_alive
+                  subject.component_with_id(comp_id).should be_nil
 
                   subsequent_command.request!
                   subject.execute_command subsequent_command
                   subsequent_command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{comp_id} for call #{subject.id}", subject.id, comp_id)
                 end
+
+                context "when we dispatch the command to it" do
+                  it 'sends an error in response to the command' do
+                    component = subject.component_with_id comp_id
+
+                    component.should_receive(:execute_command).and_raise(Celluloid::DeadActorError)
+
+                    subsequent_command.request!
+                    subject.execute_command subsequent_command
+                    subsequent_command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{comp_id} for call #{subject.id}", subject.id, comp_id)
+                  end
+                end
               end
             end
 

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

@@ -90,7 +90,7 @@ module Punchblock
                 end
 
                 let :event_node do
-                  Punchblock::Event::Asterisk::AMI::Event.new name: 'CoreShowChannel', component_id: subject.id, headers: {
+                  Punchblock::Event::Asterisk::AMI::Event.new name: 'CoreShowChannel', component_id: subject.id, source_uri: subject.id, headers: {
                     'Channel'          => 'SIP/127.0.0.1-00000013',
                     'UniqueID'         => '1287686437.19',
                     'Context'          => 'adhearsion',

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

@@ -155,6 +155,7 @@ module Punchblock
                   let :expected_event do
                     Punchblock::Event::Complete.new reason: expected_reason,
                       component_id: subject.id,
+                      source_uri: subject.id,
                       target_call_id: call.id
                   end
 
@@ -215,6 +216,7 @@ module Punchblock
                 expected_reason = Punchblock::Event::Complete::Stop.new
                 expected_event = Punchblock::Event::Complete.new reason: expected_reason,
                   component_id: subject.id,
+                  source_uri: subject.id,
                   target_call_id: call.id
 
                 call.async.should_receive(:redirect_back)

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

@@ -30,7 +30,7 @@ module Punchblock
 
             let :expected_event do
               Punchblock::Event::Complete.new target_call_id: call.id,
-                component_id: subject.id
+                component_id: subject.id, source_uri: subject.id
             end
 
             it "should send the event to the connection" do

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

@@ -358,7 +358,7 @@ module Punchblock
               component = subject.execute_command comp_command
               comp_command.response(0.1).should be_a Ref
 
-              expected_complete_event = Punchblock::Event::Complete.new :target_call_id => subject.id, :component_id => component.id
+              expected_complete_event = Punchblock::Event::Complete.new :target_call_id => subject.id, :component_id => component.id, source_uri: component.id
               expected_complete_event.reason = Punchblock::Event::Complete::Hangup.new
               expected_end_event = Punchblock::Event::End.new :reason => :hangup, :target_call_id  => subject.id
 
@@ -886,6 +886,7 @@ module Punchblock
               let :expected_event do
                 Punchblock::Event::Complete.new target_call_id: subject.id,
                   component_id: comp_id,
+                  source_uri: comp_id,
                   reason: Punchblock::Event::Complete::Error.new
               end
 

data/spec/punchblock/translator/freeswitch/component_spec.rb

@@ -47,7 +47,7 @@ module Punchblock
 
             let :expected_event do
               Punchblock::Event::Complete.new target_call_id: call.id,
-                component_id: subject.id
+                component_id: subject.id, source_uri: subject.id
             end
 
             it "should send the event to the connection" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Jason Goecke
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -168,16 +168,16 @@ dependencies:
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: ruby_jid
   requirement: !ruby/object:Gem::Requirement