adhearsion-asterisk 1.2.1 → 1.3.0

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # develop
 
+# v1.3.0
+  * Feature: Added explicit silence generation
+
 # v1.2.1
   * Feature: added play_tone for DTMF in-call generation
   * Bugfix: "code is an undefined method" errors on executing AMI methods directly (issue #6)

data/lib/adhearsion/asterisk/call_controller_methods.rb

@@ -391,6 +391,53 @@ module Adhearsion
         execute "Playback", argument
         get_variable('PLAYBACKSTATUS') == PLAYBACK_SUCCESS
       end
+
+      #
+      # Generates silence in the background, just once until some other sound is generated, or
+      # continuously for the duration of a given block. Silence is normally only generated under
+      # specific circumstances but this method will explicitly generate it, which can be useful
+      # in some scenarios.
+      #
+      # Note that the Playtones command must be available and the transmit_silence option must be
+      # enabled in asterisk.conf. Also note that the given block is executed using instance_eval
+      # and that imposes one important restriction. If the silence is interrupted outside the scope
+      # of the block (e.g. calling play in another method) then it won't be restarted until
+      # execution returns to the scope. However, it is safe to call generate_silence again when
+      # outside the scope. Instance variables may be used as they are copied and copied back but be
+      # careful handling immutable objects outside the scope. If you're unsure, don't use a block.
+      #
+      def generate_silence(&block)
+        component = Punchblock::Component::Asterisk::AGI::Command.new :name => "EXEC Playtones", :params => ["0"]
+        execute_component_and_await_completion component
+        GenerateSilenceProxy.proxy_for(self, &block) if block_given?
+      end
+
+      class GenerateSilenceProxy
+        def self.proxy_for(target, &block)
+          proxy = new(target)
+          ivs = target.instance_variables
+          ivs.each { |iv| proxy.instance_variable_set iv, target.instance_variable_get(iv) }
+
+          proxy.instance_eval(&block).tap do
+            ivs = proxy.instance_variables - [:@_target]
+            ivs.each { |iv| target.instance_variable_set iv, proxy.instance_variable_get(iv) }
+          end
+        end
+
+        def initialize(target)
+          @_target = target
+        end
+
+        def method_missing(*args)
+          @_target.send(*args).tap do
+            @_target.generate_silence
+          end
+        end
+
+        def respond_to_missing?(*args)
+          @_target.respond_to?(*args)
+        end
+      end
     end
   end
 end

data/lib/adhearsion/asterisk/version.rb

@@ -1,5 +1,5 @@
 module Adhearsion
   module Asterisk
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

data/spec/adhearsion/asterisk/call_controller_methods_spec.rb

@@ -493,6 +493,55 @@ module Adhearsion::Asterisk
           subject.play_soundfile(audiofile).should == false
         end
       end
+
+      describe '#generate_silence' do
+        context 'executes Playtones with 0 as an argument if it' do
+          before do
+            command = Punchblock::Component::Asterisk::AGI::Command.new :name => "EXEC Playtones", :params => ["0"]
+            @expect_command = subject.expects(:execute_component_and_await_completion).with(command)
+          end
+
+          it 'is not given a block' do
+            @expect_command.once
+            subject.generate_silence
+          end
+
+          it 'is given a block, which it then yields' do
+            @expect_command.times(3)
+            expect { |b| subject.generate_silence { b.to_proc.call; run; run } }.to yield_with_no_args
+          end
+
+          it 'is given a block, and copies any instance variables' do
+            @expect_command.once
+
+            iv = nil
+            subject.instance_variable_set(:@foo, "bar")
+
+            subject.generate_silence do
+              iv = @foo.dup
+              @foo << "baz"
+            end
+
+            iv.should eq("bar")
+            subject.instance_variable_get(:@foo).should eq("barbaz")
+          end
+
+          it 'is given a block, which proxies calls to #respond_to? via #respond_to_missing?' do
+            @expect_command.once
+
+            run_result = nil
+            foobar_result = nil
+
+            subject.generate_silence do
+              run_result = respond_to? :run
+              foobar_result = respond_to? :foobar
+            end
+
+            run_result.should be_true
+            foobar_result.should be_false
+          end
+        end
+      end
     end
   end#main describe
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-asterisk
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
@@ -298,7 +298,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -489585779242727687
+      hash: -2314850667478609314
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -307,10 +307,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -489585779242727687
+      hash: -2314850667478609314
 requirements: []
 rubyforge_project: adhearsion-asterisk
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Asterisk specific features for Adhearsion
@@ -328,4 +328,3 @@ test_files:
 - spec/has_agi_context.rb
 - spec/spec_helper.rb
 - spec/support/the_following_code.rb
-has_rdoc: