punchblock 1.6.1 → 1.7.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.7.0](https://github.com/adhearsion/punchblock/compare/v1.6.1...v1.7.0) - [2012-12-13](https://rubygems.org/gems/punchblock/versions/1.7.0)
+  * Feature: Support for the renderer attribute added to the Output component.
+  * Feature: FreeSWITCH and Asterisk translators now use the :renderer attribute on Output
+  * Bugfix: Fixed scenario where executing the ANSWER application on FreeSWITCH on an already answered call caused FS to stop accepting commands.
+  * Bugfix: Plug a severe memory leak
+  * Bugfix: Raise an error immediately if trying to execute an invalid media engine on Asterisk
+  * Bugfix: Handle a wider variety of types when configuring media engines on Asterisk and FreeSWITCH, such as Strings instead of Symbols
+
 # [v1.6.1](https://github.com/adhearsion/punchblock/compare/v1.6.0...v1.6.1) - [2012-11-14](https://rubygems.org/gems/punchblock/versions/1.6.1)
   * Bugfix: Safer component attribute writer conversion
 

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :version => 2, :cli => '--format documentation' do
+guard 'rspec', :cli => '--format documentation' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec/" }

data/Rakefile

@@ -7,7 +7,7 @@ require 'ci/reporter/rake/rspec'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rspec_opts = '--color'
-  spec.ruby_opts = "-w -r./spec/capture_warnings"
+  # spec.ruby_opts = "-w -r./spec/capture_warnings"
 end
 
 task :default => :spec

data/lib/punchblock/client.rb

@@ -19,7 +19,6 @@ module Punchblock
       @event_queue = Queue.new
       @connection = options[:connection]
       @connection.event_handler = lambda { |event| self.handle_event event } if @connection
-      register_initial_handlers
       @component_registry = ComponentRegistry.new
       @write_timeout = options[:write_timeout] || 3
     end
@@ -29,7 +28,7 @@ module Punchblock
       if event.source
         event.source.add_event event
       else
-        trigger_handler :event, event
+        trigger_handler(:event, event) || event_queue.push(event)
       end
     end
 
@@ -37,12 +36,6 @@ module Punchblock
       register_handler :event, *guards, &block
     end
 
-    def register_initial_handlers
-      register_handler_with_priority :event, -10 do |event|
-        event_queue.push event
-      end
-    end
-
     def register_component(component)
       component_registry << component
     end
@@ -51,6 +44,10 @@ module Punchblock
       component_registry.find_by_id component_id
     end
 
+    def delete_component_registration(component)
+      component_registry.delete component
+    end
+
     def execute_command(command, options = {})
       async = options.has_key?(:async) ? options.delete(:async) : true
       command.client = self

data/lib/punchblock/client/component_registry.rb

@@ -7,7 +7,7 @@ module Punchblock
         @mutex = Mutex.new
         @components = Hash.new
       end
-      
+
       def <<(component)
         @mutex.synchronize do
           @components[component.component_id] = component
@@ -19,6 +19,13 @@ module Punchblock
           @components[component_id]
         end
       end
+
+      def delete(component)
+        @mutex.synchronize do
+          id = @components.key component
+          @components.delete id
+        end
+      end
     end
   end
 end

data/lib/punchblock/component/component_node.rb

@@ -49,6 +49,7 @@ module Punchblock
 
       def complete_event=(other)
         return if @complete_event_resource.set_yet?
+        client.delete_component_registration self if client
         @complete_event_resource.resource = other
         complete!
       end

data/lib/punchblock/component/output.rb

@@ -157,8 +157,22 @@ module Punchblock
         write_attr :'max-time', other, :to_i
       end
 
+      ##
+      # @return [String] the rendering engine requested by the component
+      #
+      def renderer
+        read_attr :renderer
+      end
+
+      ##
+      # @param [String] the rendering engine to use with this component
+      #
+      def renderer=(renderer)
+        write_attr :renderer, renderer
+      end
+
       def inspect_attributes
-        super + [:voice, :ssml, :interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time]
+        super + [:voice, :ssml, :interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time, :renderer]
       end
 
       state_machine :state do

data/lib/punchblock/translator/asterisk.rb

@@ -58,7 +58,7 @@ module Punchblock
 
       def shutdown
         @calls.values.each(&:shutdown!)
-        current_actor.terminate!
+        terminate
       end
 
       def handle_ami_event(event)

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

@@ -45,7 +45,7 @@ module Punchblock
         end
 
         def shutdown
-          current_actor.terminate!
+          terminate
         end
 
         def to_s

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

@@ -27,7 +27,9 @@ module Punchblock
 
             output_component = current_actor
 
-            case @media_engine
+            rendering_engine = @component_node.renderer ? @component_node.renderer : @media_engine
+
+            case rendering_engine.to_sym
             when :asterisk, nil
               raise OptionError, "A voice value is unsupported on Asterisk." if @component_node.voice
               raise OptionError, 'Interrupt digits are not allowed with early media.' if early && @component_node.interrupt_on
@@ -61,6 +63,8 @@ module Punchblock
               @call.send_agi_action! 'EXEC Swift', swift_doc do |complete_event|
                 output_component.send_complete_event! success_reason
               end
+            else
+              raise OptionError, 'The renderer foobar is unsupported.'
             end
           rescue UnrenderableDocError => e
             with_error 'unrenderable document error', e.message

data/lib/punchblock/translator/freeswitch.rb

@@ -8,6 +8,7 @@ module Punchblock
     class Freeswitch
       include Celluloid
       include HasGuardedHandlers
+      include DeadActorSafety
 
       extend ActiveSupport::Autoload
 
@@ -65,6 +66,7 @@ module Punchblock
         register_handler :es, [:has_key?, :other_leg_unique_id] => true do |event|
           call = call_with_id event[:other_leg_unique_id]
           call.handle_es_event! event if call
+          throw :pass
         end
 
         register_handler :es, lambda { |event| es_event_known_call? event } do |event|
@@ -78,7 +80,11 @@ module Punchblock
       end
 
       def finalize
-        @calls.values.each(&:terminate)
+        @calls.values.each do |call|
+          safe_from_dead_actors do
+            call.terminate
+          end
+        end
       end
 
       def handle_es_event(event)

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

@@ -68,6 +68,7 @@ module Punchblock
           register_handler :es, :event_name => 'CHANNEL_ANSWER' do
             @answered = true
             send_pb_event Event::Answered.new
+            throw :pass
           end
 
           register_handler :es, :event_name => 'CHANNEL_STATE', [:[], :channel_call_state] => 'RINGING' do
@@ -99,7 +100,6 @@ module Punchblock
             send_pb_event Event::Unjoined.new(:call_id => other_call_id)
           end
 
-
           register_handler :es, [:has_key?, :scope_variable_punchblock_component_id] => true do |event|
             if component = component_with_id(event[:scope_variable_punchblock_component_id])
               safe_from_dead_actors { component.handle_es_event event if component.alive? }
@@ -176,12 +176,15 @@ module Punchblock
             application 'respond', '180 Ringing'
             command.response = true
           when Command::Answer
-            command_id = Punchblock.new_uuid
-            register_tmp_handler :es, :event_name => 'CHANNEL_ANSWER', [:[], :scope_variable_punchblock_command_id] => command_id do
-              @answered = true
+            if answered?
               command.response = true
+            else
+              command_id = Punchblock.new_uuid
+              register_tmp_handler :es, :event_name => 'CHANNEL_ANSWER', [:[], :scope_variable_punchblock_command_id] => command_id do
+                command.response = true
+              end
+              application 'answer', "%[punchblock_command_id=#{command_id}]"
             end
-            application 'answer', "%[punchblock_command_id=#{command_id}]"
           when Command::Hangup
             hangup
             command.response = true
@@ -195,7 +198,8 @@ module Punchblock
             hangup REJECT_TO_HANGUP_REASON[command.reason]
             command.response = true
           when Punchblock::Component::Output
-            case media_engine
+            media_renderer = command.renderer ? command.renderer : media_engine
+            case media_renderer.to_sym
             when :freeswitch, :native, nil
               execute_component Component::Output, command
             when :flite

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

@@ -47,7 +47,7 @@ module Punchblock
               c << recording if recording
             end
             send_event event
-            current_actor.terminate!
+            terminate
           end
 
           def send_event(event)

data/lib/punchblock/version.rb

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

data/punchblock.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<activesupport>, ["~> 3.0"]
   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.3"]
+  s.add_runtime_dependency %q<has-guarded-handlers>, ["~> 1.5"]
   s.add_runtime_dependency %q<celluloid>, ["~> 0.12", ">= 0.12.3"]
   s.add_runtime_dependency %q<ruby_ami>, ["~> 1.2", ">= 1.2.1"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.0"]
@@ -38,7 +38,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<ci_reporter>, ["~> 1.6"]
   s.add_development_dependency %q<yard>, ["~> 0.6"]
   s.add_development_dependency %q<rake>, [">= 0"]
-  s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<i18n>, [">= 0"]
   s.add_development_dependency %q<countdownlatch>, [">= 0"]
   s.add_development_dependency %q<guard-rspec>

data/spec/punchblock/client/component_registry_spec.rb

@@ -12,6 +12,13 @@ module Punchblock
         subject << component
         subject.find_by_id(component_id).should be component
       end
+
+      it 'should allow deletion of components' do
+        subject << component
+        subject.find_by_id(component_id).should be component
+        subject.delete component
+        subject.find_by_id(component_id).should be_nil
+      end
     end
   end
 end

data/spec/punchblock/client_spec.rb

@@ -13,27 +13,27 @@ module Punchblock
     its(:component_registry)  { should be_a Client::ComponentRegistry }
 
     let(:call_id)         { 'abc123' }
-    let(:mock_event)      { stub_everything 'Event' }
+    let(:mock_event)      { stub('Event').as_null_object }
     let(:component_id)    { 'abc123' }
     let(:mock_component)  { stub 'Component', :component_id => component_id }
     let(:mock_command)    { stub 'Command' }
 
     describe '#run' do
       it 'should start up the connection' do
-        connection.expects(:run).once
+        connection.should_receive(:run).once
         subject.run
       end
     end
 
     describe '#stop' do
       it 'should stop the connection' do
-        connection.expects(:stop).once
+        connection.should_receive(:stop).once
         subject.stop
       end
     end
 
     it 'should handle connection events' do
-      subject.expects(:handle_event).with(mock_event).once
+      subject.should_receive(:handle_event).with(mock_event).once
       connection.event_handler.call mock_event
     end
 
@@ -46,8 +46,8 @@ module Punchblock
 
       context 'if the event can be associated with a source component' do
         before do
-          mock_event.stubs(:source).returns mock_component
-          mock_component.expects(:add_event).with mock_event
+          mock_event.stub :source => mock_component
+          mock_component.should_receive(:add_event).with mock_event
         end
 
         it 'should not queue up the event' do
@@ -57,23 +57,25 @@ module Punchblock
 
         it 'should not call event handlers' do
           handler = mock 'handler'
-          handler.expects(:call).never
+          handler.should_receive(:call).never
           subject.register_event_handler do |event|
             handler.call event
-            throw :halt
           end
           subject.handle_event mock_event
         end
       end
 
       context 'if the event cannot be associated with a source component' do
+        before do
+          mock_event.stub :source => nil
+        end
+
         context 'if event handlers have been set' do
           it 'should call the event handler and not queue up the event' do
             handler = mock 'handler'
-            handler.expects(:call).once.with mock_event
+            handler.should_receive(:call).once.with mock_event
             subject.register_event_handler do |event|
               handler.call event
-              throw :halt
             end
             subject.handle_event mock_event
             subject.event_queue.should be_empty
@@ -99,7 +101,7 @@ module Punchblock
       let(:event)     { Event::Complete.new }
 
       before do
-        connection.expects(:write).once.with component, :call_id => call_id
+        connection.should_receive(:write).once.with component, :call_id => call_id
       end
 
       let :execute_command do
@@ -116,7 +118,7 @@ module Punchblock
       end
 
       it "should handle a component's events" do
-        subject.expects(:trigger_handler).with(:event, event).once
+        subject.should_receive(:trigger_handler).with(:event, event).once
         execute_command
         component.request!
         component.execute!

data/spec/punchblock/command_node_spec.rb

@@ -70,12 +70,12 @@ module Punchblock
 
       describe "#response=" do
         it "should set the command to executing status" do
-          subject.expects(:execute!).once
+          subject.should_receive(:execute!).once
           subject.response = :foo
         end
 
         it "should be a no-op if the response has already been set" do
-          subject.expects(:execute!).once
+          subject.should_receive(:execute!).once
           subject.response = :foo
           lambda { subject.response = :bar }.should_not raise_error
         end

data/spec/punchblock/component/component_node_spec.rb

@@ -28,7 +28,7 @@ module Punchblock
           end
 
           it "should call #complete!" do
-            subject.expects(:complete!).once
+            subject.should_receive(:complete!).once
             add_event
           end
         end
@@ -55,7 +55,7 @@ module Punchblock
           let(:handler) { mock 'Response' }
 
           before do
-            handler.expects(:call).once.with(event)
+            handler.should_receive(:call).once.with(event)
             subject.register_event_handler { |event| handler.call event }
           end
 
@@ -89,7 +89,9 @@ module Punchblock
       describe "#complete_event=" do
         before do
           subject.request!
-          subject.execute!
+          subject.client = Client.new
+          subject.response = Ref.new id: 'abc'
+          subject.client.find_component_by_id('abc').should be subject
         end
 
         it "should set the command to executing status" do
@@ -102,6 +104,11 @@ module Punchblock
           lambda { subject.complete_event = :bar }.should_not raise_error
           subject.complete_event(0.5).should be == :foo
         end
+
+        it "should remove the component from the registry" do
+          subject.complete_event = :foo
+          subject.client.find_component_by_id('abc').should be_nil
+        end
       end
     end # ComponentNode
   end # Component

data/spec/punchblock/component/input_spec.rb

@@ -163,7 +163,7 @@ module Punchblock
             end
 
             it "should send its command properly" do
-              mock_client.expects(:execute_command).with(command.stop_action, :target_call_id => '123abc', :component_id => 'abc123')
+              mock_client.should_receive(:execute_command).with(command.stop_action, :target_call_id => '123abc', :component_id => 'abc123')
               command.stop!
             end
           end