adhearsion 2.4.0.beta2 → 2.4.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 954ba804ad541b402e9b92a8bc467cfe6d37bd5d
-  data.tar.gz: 220bcee6bb1362c837b7a1f652135aaf279d7ae9
+  metadata.gz: a21555092db2b8678e869cbf61fe9d365c6ba61f
+  data.tar.gz: 118c8bdbf5dedcf3c52287175ba13637b5b711c6
 SHA512:
-  metadata.gz: c21bfd97fb6181317bc98cf881b893b84d69ca2028fd20da89f1acf192390305a48b89677cacc40181f07bcdd0580c20de961abf446d7dd273d73b7fb6b20b59
-  data.tar.gz: 07321554930f529a73ea01aa6c8f79ebb45782272a8a023e3b6610957297cd202fbe333694071357ef72aabb25be0e8c8cecd7531b34c14169ffc5c23bc81d44
+  metadata.gz: d1b0b67df4b8b76a4f77e724dcc7b2523c719d37bb6eed73a7adaf3bbb90db792de9d69cbd09b0f860221605125092684756d84430c176c8aa5bff072ff476cd
+  data.tar.gz: e5c9deb98506f8ce27a1185b89ffe17eb474f79432dc697436566897d1c5b839007eaf0231fa08d8e243c514907b2572b42d6fa3f4f5079f8da4ae6ccdda67e2

data/CHANGELOG.md

@@ -1,22 +1,23 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
-# [2.4.0.beta2](https://github.com/adhearsion/adhearsion/compare/v2.3.5...v2.4.0.beta2) - [2013-08-23](https://rubygems.org/gems/adhearsion/versions/2.4.0.beta2)
+# [2.4.0.beta3](https://github.com/adhearsion/adhearsion/compare/v2.3.5...v2.4.0.beta3) - [2013-08-27](https://rubygems.org/gems/adhearsion/versions/2.4.0.beta3)
   * Deprecation: Ruby 1.9.2 support is deprecated and will be dropped in a future version of Adhearsion
+  * Deprecation: Some media options from Punchblock config are now overriden by other core config, and will eventually be removed.
+  * Deprecation: Core implementations of `CallController#ask` and `#menu` are deprecated, and will be replaced in future with those in [adhearsion-asr](http://github.com/adhearsion/adhearsion-asr). See http://adhearsion.com/docs/common_problems#toc_3 for details.
   * Feature: Update to Punchblock 2.0 for JRuby compatibility, better performance and Rayo spec compliance
-  * Feature: Add Call#wait_for_end, which blocks until the call ends and returns its end reason
-  * Feature: Add joined call attribute to dial status
+  * Feature: Add `Call#wait_for_end`, which blocks until the call ends and returns its end reason
   * Feature: Track call start/end time and duration
-  * Feature: Add per-call join duration and disposition to DialStatus
+  * Feature: Add per-call join duration and disposition to `DialStatus`
   * Feature: Add `CallController#dial_and_confirm` which allows parallel confirmation of outbound calls and apologies to losing parties
   * Feature: Add `CallController::Dial::Dial#split`, `#rejoin`, `#merge` and `#skip_cleanup` to support conferencing and transfer use cases
   * Feature: Add `#originate` method to console as alias for `Adhearsion::OutboundCall.originate`
   * Feature: Allow the console to be disabled using `--no-console`
-  * Feature: Add CLI options to generate hooks for a plugin to register on [ahnhub.com](http://www.ahnhub.com)
+  * Feature: Add CLI commands to generate hooks for a plugin to register on [ahnhub.com](http://www.ahnhub.com)
   * Bugfix: Removed unnecessary Mocha reference from generated plugin
   * Bugfix: Call loggers are deleted after a call finishes, fixing a memory leak
   * Bugfix: A menu definition's block context is now available
   * Bugfix: Ensure call's command registry is not leaked outside the actor
-  * Bugfix: An application's lib/ directory is now in the load path so dependencies may be reasolved more simply. You may now require 'foo.rb' instead of "#{Adhearsion.root}/lib/foo.rb"
+  * Bugfix: An application's `lib/` directory is now in the load path so dependencies may be reasolved more simply. You may now `require 'foo'` instead of `require "#{Adhearsion.root}/lib/foo.rb"`
   * Bugfix: Resolve hostname to some local name when experiencing network issues
   * Bugfix: Ensure smooth shutdown of console and XMPP connections
   * Bugfix: Warn when booting Adhearsion with an invalid environment name

data/lib/adhearsion/call_controller/input.rb

@@ -41,6 +41,8 @@ module Adhearsion
       # @see CallController#pass
       #
       def ask(*args, &block)
+        logger.warn "This implementation of #ask is deprecated due to issues with dropped DTMF. For a solution, see http://adhearsion.com/docs/common_problems#toc_3"
+
         options = args.last.kind_of?(Hash) ? args.pop : {}
         sound_files = args.flatten
 
@@ -129,6 +131,8 @@ module Adhearsion
       # @see CallController#pass
       #
       def menu(*args, &block)
+        logger.warn "This implementation of #menu is deprecated due to issues with dropped DTMF. For a solution, see http://adhearsion.com/docs/common_problems#toc_3"
+
         options = args.last.kind_of?(Hash) ? args.pop : {}
         sound_files = args.flatten
 

data/lib/adhearsion/call_controller/output/abstract_player.rb

@@ -21,9 +21,13 @@ module Adhearsion
 
         def new_output(options)
           defaults = {}
-          default_voice = Adhearsion.config.punchblock[:default_voice]
+
+          default_voice = Adhearsion.config.platform.media.default_voice || Adhearsion.config.punchblock[:default_voice]
           defaults[:voice] = default_voice if default_voice
 
+          renderer = Adhearsion.config.platform.media.default_renderer || Adhearsion.config.punchblock[:media_engine]
+          defaults[:renderer] = renderer if renderer
+
           Punchblock::Component::Output.new defaults.merge(options)
         end
       end

data/lib/adhearsion/configuration.rb

@@ -58,6 +58,12 @@ module Adhearsion
         after_hangup_lifetime 30, :transform => Proc.new { |v| v.to_i }, :desc => <<-__
           Lifetime of a call after it has hung up
         __
+
+        desc "Media configuration"
+        media {
+          default_voice nil, desc: 'The default voice used for all output. Set nil to use platform default.'
+          default_renderer nil, desc: 'The default renderer used for all output. Set nil to use platform default.'
+        }
       end
 
       Loquacious::Configuration.for :platform, &block if block_given?

data/lib/adhearsion/generators/app/templates/Gemfile.erb

@@ -1,6 +1,10 @@
 source 'https://rubygems.org'
 
-gem "adhearsion", "~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>"
+gem 'adhearsion', '~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>'
+
+# This is here by default due to deprecation of #ask and #menu.
+# See http://adhearsion.com/docs/common_problems#toc_3 for details
+gem 'adhearsion-asr'
 
 #
 # Here are some example plugins you might like to use. Simply

data/lib/adhearsion/process.rb

@@ -103,8 +103,6 @@ module Adhearsion
 
     def fqdn
       Socket.gethostbyname(Socket.gethostname).first
-    rescue SocketError
-      Socket.gethostname
     end
 
     def self.method_missing(method_name, *args, &block)

data/lib/adhearsion/punchblock_plugin.rb

@@ -23,8 +23,8 @@ module Adhearsion
       connection_timeout  60               , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "The amount of time to wait for a connection"
       reconnect_attempts  1.0/0.0          , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "The number of times to (re)attempt connection to the server"
       reconnect_timer     5                , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "Delay between connection attempts"
-      media_engine        nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The media engine to use. Defaults to platform default."
-      default_voice       nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The default TTS voice to use."
+      media_engine        nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The media engine to use. Defaults to platform default. This is deprecated, please see core media config options for forward compatability."
+      default_voice       nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The default TTS voice to use. This is deprecated, please see core media config options for forward compatability."
     end
 
     init :punchblock do

data/lib/adhearsion/punchblock_plugin/initializer.rb

@@ -27,9 +27,7 @@ module Adhearsion
             :host               => self.config.host,
             :port               => self.config.port,
             :certs              => self.config.certs_directory,
-            :root_domain        => self.config.root_domain,
-            :media_engine       => self.config.media_engine,
-            :default_voice      => self.config.default_voice
+            :root_domain        => self.config.root_domain
           }
 
           self.client = Punchblock.client_with_connection self.config.platform, connection_options
@@ -159,7 +157,13 @@ module Adhearsion
         end
 
         def resource
-          [Adhearsion::Process.fqdn, ::Process.pid].join '-'
+          [machine_identifier, ::Process.pid].join '-'
+        end
+
+        def machine_identifier
+          Adhearsion::Process.fqdn
+        rescue SocketError
+          Socket.gethostname
         end
 
         def connection

data/lib/adhearsion/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Adhearsion
-  VERSION = '2.4.0.beta2'
+  VERSION = '2.4.0.beta3'
 end

data/spec/adhearsion/call_controller/dial_spec.rb

@@ -478,9 +478,9 @@ module Adhearsion
 
                 sleep 0.5
 
-                other_mock_call << mock_end
-                second_root_call << mock_end
-                second_other_mock_call << mock_end
+                other_mock_call.async << mock_end
+                second_root_call.async << mock_end
+                second_other_mock_call.async << mock_end
 
                 latch.wait(1).should be_true
 
@@ -499,9 +499,9 @@ module Adhearsion
 
                 sleep 0.5
 
-                other_mock_call << mock_end
-                second_root_call << mock_end
-                second_other_mock_call << mock_end
+                other_mock_call.async << mock_end
+                second_root_call.async << mock_end
+                second_other_mock_call.async << mock_end
 
                 latch.wait(1).should be_true
 
@@ -580,9 +580,9 @@ module Adhearsion
 
                   sleep 0.5
 
-                  other_mock_call << mock_end
-                  second_root_call << mock_end
-                  second_other_mock_call << mock_end
+                  other_mock_call.async << mock_end
+                  second_root_call.async << mock_end
+                  second_other_mock_call.async << mock_end
 
                   latch.wait(1).should be_true
 
@@ -993,7 +993,9 @@ module Adhearsion
 
                 other_mock_call.should_receive(:dial).once.with(to, from: nil)
                 other_mock_call.should_receive(:join).once.with(call)
-                other_mock_call.should_receive(:hangup).once
+                other_mock_call.should_receive(:hangup).once.and_return do
+                  other_mock_call << mock_end
+                end
 
                 second_other_mock_call.should_receive(:dial).once.with(second_to, from: nil)
                 second_other_mock_call.should_receive(:join).never
@@ -1010,7 +1012,6 @@ module Adhearsion
                 confirmation_latch.wait(1).should be_true
 
                 other_mock_call << Punchblock::Event::Unjoined.new(call_uri: call.id)
-                other_mock_call << mock_end
 
                 latch.wait(2).should be_true
 
@@ -1476,9 +1477,9 @@ module Adhearsion
 
                 sleep 0.5
 
-                other_mock_call << mock_end
-                second_root_call << mock_end
-                second_other_mock_call << mock_end
+                other_mock_call.async << mock_end
+                second_root_call.async << mock_end
+                second_other_mock_call.async << mock_end
 
                 latch.wait(1).should be_true
 
@@ -1497,9 +1498,9 @@ module Adhearsion
 
                 sleep 0.5
 
-                other_mock_call << mock_end
-                second_root_call << mock_end
-                second_other_mock_call << mock_end
+                other_mock_call.async << mock_end
+                second_root_call.async << mock_end
+                second_other_mock_call.async << mock_end
 
                 latch.wait(1).should be_true
 
@@ -1578,9 +1579,9 @@ module Adhearsion
 
                   sleep 0.5
 
-                  other_mock_call << mock_end
-                  second_root_call << mock_end
-                  second_other_mock_call << mock_end
+                  other_mock_call.async << mock_end
+                  second_root_call.async << mock_end
+                  second_other_mock_call.async << mock_end
 
                   latch.wait(1).should be_true
 

data/spec/adhearsion/call_controller/input_spec.rb

@@ -166,6 +166,13 @@ module Adhearsion
           MenuDSL::Menu.should_receive(:new).and_return(menu_instance)
         end
 
+        it "logs a warning about dropped DTMF" do
+          menu_instance.should_receive(:continue).and_return(result_done)
+
+          call.logger.should_receive(:warn).with(/deprecated/)
+          subject.menu sound_files
+        end
+
         it "exits the function if MenuResultDone" do
           menu_instance.should_receive(:should_continue?).and_return(true)
           menu_instance.should_receive(:continue).and_return(result_done)
@@ -271,6 +278,13 @@ module Adhearsion
             MenuDSL::Menu.should_receive(:new).and_return(menu_instance)
           end
 
+          it "logs a warning about dropped DTMF" do
+            menu_instance.should_receive(:continue).and_return(result_done)
+
+            call.logger.should_receive(:warn).with(/deprecated/)
+            subject.ask sound_files
+          end
+
           it "exits the function if MenuResultDone" do
             menu_instance.should_receive(:continue).and_return(result_done)
             result = subject.ask sound_files

data/spec/adhearsion/call_controller/output_spec.rb

@@ -748,7 +748,7 @@ module Adhearsion
           end
         end
 
-        describe "with a default voice set" do
+        describe "with a default voice set in PB config" do
           before { Adhearsion.config.punchblock.default_voice = 'foo' }
 
           it 'sets the voice on the output component' do
@@ -761,6 +761,57 @@ module Adhearsion
           after { Adhearsion.config.punchblock.default_voice = nil }
         end
 
+        describe "with a default voice set in core and PB config" do
+          before do
+            Adhearsion.config.punchblock.default_voice = 'foo'
+            Adhearsion.config.platform.media.default_voice = 'bar'
+          end
+
+          it 'prefers core config to set the voice on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_ssml_output ssml, voice: 'bar'
+            subject.say(str)
+          end
+
+          after do
+            Adhearsion.config.punchblock.default_voice = nil
+            Adhearsion.config.platform.media.default_voice = nil
+          end
+        end
+
+        describe "with a default media engine set in PB config" do
+          before { Adhearsion.config.punchblock.media_engine = 'foo' }
+
+          it 'sets the renderer on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_ssml_output ssml, renderer: 'foo'
+            subject.say(str)
+          end
+
+          after { Adhearsion.config.punchblock.media_engine = nil }
+        end
+
+        describe "with a default renderer set in core and PB config" do
+          before do
+            Adhearsion.config.punchblock.media_engine = 'foo'
+            Adhearsion.config.platform.media.default_renderer = 'bar'
+          end
+
+          it 'prefers core config to set the renderer on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_ssml_output ssml, renderer: 'bar'
+            subject.say(str)
+          end
+
+          after do
+            Adhearsion.config.punchblock.media_engine = nil
+            Adhearsion.config.platform.media.default_renderer = nil
+          end
+        end
+
         describe "converts the argument to a string" do
           it 'calls output with a string' do
             argument = 123
@@ -795,7 +846,7 @@ module Adhearsion
           end
         end
 
-        describe "with a default voice set" do
+        describe "with a default voice set in PB config" do
           before { Adhearsion.config.punchblock.default_voice = 'foo' }
 
           it 'sets the voice on the output component' do
@@ -808,6 +859,57 @@ module Adhearsion
           after { Adhearsion.config.punchblock.default_voice = nil }
         end
 
+        describe "with a default voice set in core and PB config" do
+          before do
+            Adhearsion.config.punchblock.default_voice = 'foo'
+            Adhearsion.config.platform.media.default_voice = 'bar'
+          end
+
+          it 'prefers core config to set the voice on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_async_ssml_output ssml, voice: 'bar'
+            subject.say!(str)
+          end
+
+          after do
+            Adhearsion.config.punchblock.default_voice = nil
+            Adhearsion.config.platform.media.default_voice = nil
+          end
+        end
+
+        describe "with a default media engine set in PB config" do
+          before { Adhearsion.config.punchblock.media_engine = 'foo' }
+
+          it 'sets the renderer on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_async_ssml_output ssml, renderer: 'foo'
+            subject.say!(str)
+          end
+
+          after { Adhearsion.config.punchblock.media_engine = nil }
+        end
+
+        describe "with a default renderer set in core and PB config" do
+          before do
+            Adhearsion.config.punchblock.media_engine = 'foo'
+            Adhearsion.config.platform.media.default_renderer = 'bar'
+          end
+
+          it 'prefers core config to set the renderer on the output component' do
+            str = "Hello world"
+            ssml = RubySpeech::SSML.draw { string str }
+            expect_async_ssml_output ssml, renderer: 'bar'
+            subject.say!(str)
+          end
+
+          after do
+            Adhearsion.config.punchblock.media_engine = nil
+            Adhearsion.config.platform.media.default_renderer = nil
+          end
+        end
+
         describe "converts the argument to a string" do
           it 'calls output with a string' do
             argument = 123

data/spec/adhearsion/process_spec.rb

@@ -107,8 +107,8 @@ module Adhearsion
       context "when networking issues crop up" do
         before { Socket.stub(:gethostbyname).and_raise(SocketError) }
 
-        it "should still be a string" do
-          Adhearsion::Process.fqdn.should be_a String
+        it "should raise SocketError" do
+          expect { Adhearsion::Process.fqdn }.to raise_error(SocketError)
         end
       end
     end

data/spec/adhearsion/punchblock_plugin/initializer_spec.rb

@@ -18,8 +18,6 @@ module Adhearsion
           config.connection_timeout = 60
           config.reconnect_attempts = 1.0/0.0
           config.reconnect_timer    = 5
-          config.media_engine       = nil
-          config.default_voice      = nil
         end
       end
 
@@ -37,8 +35,6 @@ module Adhearsion
           config.connection_timeout = options[:connection_timeout] if options.has_key?(:connection_timeout)
           config.reconnect_attempts = options[:reconnect_attempts] if options.has_key?(:reconnect_attempts)
           config.reconnect_timer    = options[:reconnect_timer] if options.has_key?(:reconnect_timer)
-          config.media_engine       = options[:media_engine] if options.has_key?(:media_engine)
-          config.default_voice      = options[:default_voice] if options.has_key?(:default_voice)
         end
 
         Initializer.init
@@ -93,14 +89,6 @@ module Adhearsion
         it "should properly set the reconnect_timer value" do
           subject.reconnect_timer.should be == 5
         end
-
-        it "should properly set the media_engine value" do
-          subject.media_engine.should be == nil
-        end
-
-        it "should properly set the default_voice value" do
-          subject.default_voice.should be == nil
-        end
       end
 
       it "starts the client with the correct resource" do
@@ -110,9 +98,21 @@ module Adhearsion
         initialize_punchblock
       end
 
+      context "when the fqdn is not available" do
+        it "should use the local hostname instead" do
+          Adhearsion::Process.stub(:fqdn).and_raise SocketError
+          Socket.stub(:gethostname).and_return 'local_hostname'
+
+          username = "usera@127.0.0.1/local_hostname-1234"
+
+          Punchblock::Connection::XMPP.should_receive(:new).once.with(hash_including :username => username).and_return mock_client
+          initialize_punchblock
+        end
+      end
+
       it "starts the client with any overridden settings" do
-        Punchblock::Connection::XMPP.should_receive(:new).once.with(username: 'userb@127.0.0.1/foo', password: '123', host: 'foo.bar.com', port: 200, certs: '/foo/bar', connection_timeout: 20, root_domain: 'foo.com', media_engine: :swift, default_voice: :hal).and_return mock_client
-        initialize_punchblock username: 'userb@127.0.0.1/foo', password: '123', host: 'foo.bar.com', port: 200, certs_directory: '/foo/bar', connection_timeout: 20, root_domain: 'foo.com', media_engine: :swift, default_voice: :hal
+        Punchblock::Connection::XMPP.should_receive(:new).once.with(username: 'userb@127.0.0.1/foo', password: '123', host: 'foo.bar.com', port: 200, certs: '/foo/bar', connection_timeout: 20, root_domain: 'foo.com').and_return mock_client
+        initialize_punchblock username: 'userb@127.0.0.1/foo', password: '123', host: 'foo.bar.com', port: 200, certs_directory: '/foo/bar', connection_timeout: 20, root_domain: 'foo.com'
       end
 
       describe "#connect" do
@@ -172,7 +172,7 @@ module Adhearsion
       end
 
       describe 'using Asterisk' do
-        let(:overrides) { {:username => 'test', :password => '123', :host => 'foo.bar.com', :port => 200, :certs => nil, :connection_timeout => 20, :root_domain => 'foo.com', :media_engine => :swift, :default_voice => :hal} }
+        let(:overrides) { {:username => 'test', :password => '123', :host => 'foo.bar.com', :port => 200, :certs => nil, :connection_timeout => 20, :root_domain => 'foo.com'} }
 
         it 'should start an Asterisk PB connection' do
           Punchblock::Connection::Asterisk.should_receive(:new).once.with(overrides).and_return mock_client
@@ -181,7 +181,7 @@ module Adhearsion
       end
 
       describe 'using FreeSWITCH' do
-        let(:overrides) { {:username => 'test', :password => '123', :host => 'foo.bar.com', :port => 200, :certs => nil, :connection_timeout => 20, :root_domain => 'foo.com', :media_engine => :swift, :default_voice => :hal} }
+        let(:overrides) { {:username => 'test', :password => '123', :host => 'foo.bar.com', :port => 200, :certs => nil, :connection_timeout => 20, :root_domain => 'foo.com'} }
 
         it 'should start a FreeSWITCH PB connection' do
           Punchblock::Connection::Freeswitch.should_receive(:new).once.with(overrides).and_return mock_client

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion
 version: !ruby/object:Gem::Version
-  version: 2.4.0.beta2
+  version: 2.4.0.beta3
 platform: ruby
 authors:
 - Jay Phillips
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport