punchblock 1.7.1 → 1.8.0

data/.travis.yml

@@ -2,8 +2,12 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  # - jruby-19mode
-  # - rbx-19mode
-  # - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode
+    - rvm: jruby-19mode
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.8.0](https://github.com/adhearsion/punchblock/compare/v1.7.1...v1.8.0) - [2013-01-10](https://rubygems.org/gems/punchblock/versions/1.8.0)
+  * Feature: Join command now enforces a list of valid direction attribute values
+  * Feature: Added support for media direction to the Record component
+  * Feature: Record direction support on FS
+  * Bugfix: Fixed answering during early media on FS
+  * Bugfix: Doing multiple recordings on Asterisk during the lifetime of a call was crashing Punchblock
+
 # [v1.7.1](https://github.com/adhearsion/punchblock/compare/v1.7.0...v1.7.1) - [2012-12-17](https://rubygems.org/gems/punchblock/versions/1.7.1)
   * Bugfix: Deal with nil media engines on FS/* properly
 

data/lib/punchblock/command/join.rb

@@ -5,6 +5,8 @@ module Punchblock
     class Join < CommandNode
       register :join, :core
 
+      VALID_DIRECTIONS = [:duplex, :send, :recv].freeze
+
       ##
       # Create a join command
       #
@@ -59,8 +61,11 @@ module Punchblock
 
       ##
       # @param [String] other the direction in which media should flow. Can be :duplex, :recv or :send
-      def direction=(other)
-        write_attr :direction, other
+      def direction=(direction)
+        if direction && !VALID_DIRECTIONS.include?(direction.to_sym)
+          raise ArgumentError, "Invalid Direction (#{direction}), use: #{VALID_DIRECTIONS*' '}"
+        end
+        write_attr :direction, direction 
       end
 
       ##

data/lib/punchblock/component.rb

@@ -10,7 +10,6 @@ module Punchblock
     autoload :Output
     autoload :Record
     autoload :Stop
-    autoload :Tropo
 
     InvalidActionError = Class.new StandardError
   end # Component

data/lib/punchblock/component/record.rb

@@ -5,6 +5,8 @@ module Punchblock
     class Record < ComponentNode
       register :record, :record
 
+      VALID_DIRECTIONS = [:duplex, :send, :recv].freeze
+
       ##
       # Creates an Rayo Record command
       #
@@ -114,8 +116,23 @@ module Punchblock
         write_attr :'start-paused', other
       end
 
+      ##
+      # @return [Symbol] the direction of media to be recorded.
+      def direction
+        read_attr :direction, :to_sym
+      end
+
+      ##
+      # @param [#to_s] otherthe direction of media to be recorded. Can be :duplex, :recv or :send
+      def direction=(direction)
+        if direction && !VALID_DIRECTIONS.include?(direction.to_sym)
+          raise ArgumentError, "Invalid Direction (#{direction}), use: #{VALID_DIRECTIONS*' '}"
+        end
+        write_attr :direction, direction
+      end
+
       def inspect_attributes # :nodoc:
-        [:final_timeout, :format, :initial_timeout, :max_duration, :start_beep, :start_paused] + super
+        [:final_timeout, :format, :initial_timeout, :max_duration, :start_beep, :start_paused, :direction] + super
       end
 
       state_machine :state do

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

@@ -24,7 +24,7 @@ module Punchblock
 
 
             component = current_actor
-            call.register_handler :ami, :name => 'MonitorStop' do |event|
+            call.register_tmp_handler :ami, :name => 'MonitorStop' do |event|
               component.finished
             end
 

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

@@ -104,6 +104,7 @@ module Punchblock
             if component = component_with_id(event[:scope_variable_punchblock_component_id])
               safe_from_dead_actors { component.handle_es_event event if component.alive? }
             end
+            throw :pass
           end
         end
 

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

@@ -29,6 +29,14 @@ module Punchblock
 
             record_args = ['start', filename]
             record_args << max_duration/1000 unless max_duration == -1
+            case @component_node.direction
+            when :send
+              call.uuid_foo :setvar, "RECORD_WRITE_ONLY true"
+            when :recv
+              call.uuid_foo :setvar, "RECORD_READ_ONLY true"
+            else
+              call.uuid_foo :setvar, "RECORD_STEREO true"
+            end
             call.uuid_foo :record, record_args.join(' ')
 
             send_ref

data/lib/punchblock/version.rb

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

data/punchblock.gemspec

@@ -23,12 +23,13 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.7") if s.respond_to? :required_rubygems_version=
 
   s.add_runtime_dependency %q<niceogiri>, ["~> 1.1"]
+  s.add_runtime_dependency %q<nokogiri>, ["~> 1.5", ">= 1.5.6"]
   s.add_runtime_dependency %q<blather>, [">= 0.7.0"]
   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.5"]
-  s.add_runtime_dependency %q<celluloid>, ["~> 0.12", ">= 0.12.3"]
+  s.add_runtime_dependency %q<celluloid>, ["~> 0.12", ">= 0.12.4"]
   s.add_runtime_dependency %q<ruby_ami>, ["~> 1.2", ">= 1.2.1"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.0"]
   s.add_runtime_dependency %q<ruby_speech>, ["~> 1.0"]
@@ -41,5 +42,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<i18n>, [">= 0"]
   s.add_development_dependency %q<countdownlatch>, [">= 0"]
   s.add_development_dependency %q<guard-rspec>
-  s.add_development_dependency %q<ruby_gntp>
+  s.add_development_dependency %q<rb-fsevent>, ['~> 0.9']
 end

data/spec/punchblock/command/join_spec.rb

@@ -39,6 +39,28 @@ module Punchblock
         its(:direction)   { should be == :duplex }
         its(:media)       { should be == :bridge }
       end
+
+      describe "with a direction" do
+        [nil, :duplex, :send, :recv].each do |direction|
+          describe direction do
+            subject { Join.new :direction => direction }
+
+            its(:direction) { should be == direction }
+          end
+        end
+
+        describe "no direction" do
+          subject { Join.new }
+
+          its(:direction) { should be_nil }
+        end
+
+        describe "blahblahblah" do
+          it "should raise an error" do
+            expect { Join.new(:direction => :blahblahblah) }.to raise_error ArgumentError
+          end
+        end
+      end
     end
   end
 end # Punchblock

data/spec/punchblock/component/record_spec.rb

@@ -16,7 +16,8 @@ module Punchblock
                      :start_paused    => false,
                      :max_duration    => 500000,
                      :initial_timeout => 10000,
-                     :final_timeout   => 30000
+                     :final_timeout   => 30000,
+                     :direction       => :duplex
         end
 
         its(:format)          { should be == 'WAV' }
@@ -25,6 +26,7 @@ module Punchblock
         its(:max_duration)    { should be == 500000 }
         its(:initial_timeout) { should be == 10000 }
         its(:final_timeout)   { should be == 30000 }
+        its(:direction)       { should be == :duplex }
       end
 
       describe "from a stanza" do
@@ -36,6 +38,7 @@ module Punchblock
         start-paused="false"
         max-duration="500000"
         initial-timeout="10000"
+        direction="duplex"
         final-timeout="30000"/>
           MESSAGE
         end
@@ -50,6 +53,29 @@ module Punchblock
         its(:max_duration)    { should be == 500000 }
         its(:initial_timeout) { should be == 10000 }
         its(:final_timeout)   { should be == 30000 }
+        its(:direction)       { should be == :duplex }
+      end
+
+      describe "with a direction" do
+        [nil, :duplex, :send, :recv].each do |direction|
+          describe direction do
+            subject { Record.new :direction => direction }
+
+            its(:direction) { should be == direction }
+          end
+        end
+
+        describe "no direction" do
+          subject { Record.new }
+
+          its(:direction) { should be_nil }
+        end
+
+        describe "blahblahblah" do
+          it "should raise an error" do
+            expect { Record.new(:direction => :blahblahblah) }.to raise_error ArgumentError
+          end
+        end
       end
 
       describe "actions" do

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

@@ -65,6 +65,21 @@ module Punchblock
               original_command.should be_complete
             end
 
+            it "can be called multiple times on the same call" do 
+              mock_call.should_receive(:send_ami_action!).twice
+              subject.execute
+
+              monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
+                e['Channel'] = channel
+              end
+
+              mock_call.process_ami_event monitor_stop_event 
+
+              (Record.new original_command, mock_call).execute
+              (Punchblock::Component::Record.new command_options).request!
+              mock_call.process_ami_event monitor_stop_event
+            end
+
             describe 'start_paused' do
               context "set to nil" do
                 let(:command_options) { { :start_paused => nil } }

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

@@ -706,6 +706,19 @@ module Punchblock
               subject.should be_answered
               subject.execute_command command
             end
+
+            context "when a component has previously been executed" do
+              it "should set the answer command's response correctly" do
+                subject
+                Punchblock.should_receive(:new_uuid).once.and_return 'abc123'
+                subject.wrapped_object.should_receive(:application).once.with('answer', "%[punchblock_command_id=abc123]")
+                subject.should_not be_answered
+                subject.execute_command command
+                subject.handle_es_event RubyFS::Event.new(nil, :event_name => 'CHANNEL_ANSWER', :scope_variable_punchblock_command_id => 'abc123', :scope_variable_punchblock_component_id => 'dj182989j')
+                command.response(0.5).should be true
+                subject.should be_answered
+              end
+            end
           end
 
           def expect_hangup_with_reason(reason)

data/spec/punchblock/translator/freeswitch/component/record_spec.rb

@@ -22,7 +22,10 @@ module Punchblock
             {}
           end
 
-          before { mock_stream.as_null_object }
+          before do
+            mock_stream.as_null_object
+            mock_call.stub(:uuid_foo)
+          end
 
           subject { Record.new original_command, mock_call }
 
@@ -62,7 +65,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :start_paused => nil } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -71,7 +74,7 @@ module Punchblock
               context "set to false" do
                 let(:command_options) { { :start_paused => false } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -92,7 +95,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :initial_timeout => nil } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -101,7 +104,7 @@ module Punchblock
               context "set to -1" do
                 let(:command_options) { { :initial_timeout => -1 } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -122,7 +125,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :final_timeout => nil } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -131,7 +134,7 @@ module Punchblock
               context "set to -1" do
                 let(:command_options) { { :final_timeout => -1 } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -194,7 +197,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :start_beep => nil } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -203,7 +206,7 @@ module Punchblock
               context "set to false" do
                 let(:command_options) { { :start_beep => false } }
                 it "should execute normally" do
-                  mock_call.should_receive(:uuid_foo).once
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/)
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -262,6 +265,45 @@ module Punchblock
                 end
               end
             end
+
+            describe 'direction' do
+              context "with nil" do
+                let(:command_options) { { :direction => nil } }
+                it "should execute the setvar application with duplex options before recording" do
+                  mock_call.should_receive(:uuid_foo).once.with(:setvar, "RECORD_STEREO true").ordered
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/).ordered
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+              context "with :duplex" do
+                let(:command_options) { { :direction => :duplex } }
+                it "should execute the setvar application with duplex options before recording" do
+                  mock_call.should_receive(:uuid_foo).once.with(:setvar, "RECORD_STEREO true").ordered
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/).ordered
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+              context "with :send" do
+                let(:command_options) { { :direction => :send } }
+                it "should execute the setvar application with send options before recording" do
+                  mock_call.should_receive(:uuid_foo).once.with(:setvar, "RECORD_WRITE_ONLY true").ordered
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/).ordered
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+              context "with :recv" do
+                let(:command_options) { { :direction => :recv } }
+                it "should execute the setvar application with recv options before recording" do
+                  mock_call.should_receive(:uuid_foo).once.with(:setvar, "RECORD_READ_ONLY true").ordered
+                  mock_call.should_receive(:uuid_foo).once.with(:record, /.wav$/).ordered
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+            end
           end
 
           describe "#execute_command" do
@@ -282,7 +324,6 @@ module Punchblock
               let(:command) { Punchblock::Component::Stop.new }
 
               before do
-                mock_call.should_receive :uuid_foo
                 command.request!
                 original_command.request!
                 subject.execute

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
@@ -29,6 +29,28 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: blather
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +141,7 @@ dependencies:
         version: '0.12'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.12.3
+        version: 0.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -130,7 +152,7 @@ dependencies:
         version: '0.12'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.12.3
+        version: 0.12.4
 - !ruby/object:Gem::Dependency
   name: ruby_ami
   requirement: !ruby/object:Gem::Requirement
@@ -314,21 +336,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby_gntp
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 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
@@ -499,7 +521,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2704704399660670461
+      hash: 1644648502358388529
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: