adhearsion 1.2.1 → 1.2.3

data/.gitignore

@@ -11,3 +11,4 @@ Gemfile.lock
 coverage
 spec/reports
 doc
+/.rbx/

data/CHANGELOG

@@ -1,3 +1,12 @@
+1.2.3
+ - Changes from 1.2.2, without an accidental API change which slipped in
+
+1.2.2 - yanked
+ - Fixed a console bug related to recent versions of Pry passing extra arguments. Thanks to Alvaro Parres
+ - Introducing new :initial_timeout and :interdigit_timeout options to #input in order to control the wait delay for the 1st and subsequent digits, respectively. Maintains support for the existing :timeout option. (https://github.com/adhearsion/adhearsion/pull/41)
+ - Updated #input documentation for new features in Adhearsion 1.2.x
+ - Fix bug where setting log formatters when demonising would not work (https://github.com/adhearsion/adhearsion/issues/36)
+
 1.2.1
  - Removed the restful_rpc component since it is now in a gem.
  - Allow overriding the path to a component in the testing framework so as to support new style components (lib/)

data/lib/adhearsion/console.rb

@@ -9,8 +9,8 @@ module Adhearsion
       # Start the Adhearsion console
       #
       def run
-        Pry.prompt = [ proc {|obj, nest_level| "AHN#{'  ' * nest_level}> " },
-                       proc {|obj, nest_level| "AHN#{'  ' * nest_level}? " } ]
+        Pry.prompt = [ proc { |obj, nest_level, pry_instance = nil| "AHN#{'  ' * nest_level}> " },
+                       proc { |obj, nest_level, pry_instance = nil| "AHN#{'  ' * nest_level}? " } ]
         pry
       end
 

data/lib/adhearsion/initializer.rb

@@ -349,7 +349,7 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       file_logger = Log4r::FileOutputter.new("Main Adhearsion log file", :filename => log_file, :trunc => false)
 
       if should_daemonize?
-        Logging::AdhearsionLogger.outputters  = file_logger
+        Logging::AdhearsionLogger.outputters  = [file_logger]
       else
         Logging::AdhearsionLogger.outputters << file_logger
       end

data/lib/adhearsion/version.rb

@@ -2,7 +2,7 @@ module Adhearsion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1 unless defined? MAJOR
     MINOR = 2 unless defined? MINOR
-    TINY  = 1 unless defined? TINY
+    TINY  = 3 unless defined? TINY
 
     STRING = [MAJOR, MINOR, TINY].join('.') unless defined? STRING
   end

data/lib/adhearsion/voip/asterisk/commands.rb

@@ -663,11 +663,16 @@ module Adhearsion
         end
 
         # Used to receive keypad input from the user. Digits are collected
-        # via DTMF (keypad) input until one of three things happens:
+        # via DTMF (keypad) input until one of four things happens:
         #
-        #  1. The number of digits you specify as the first argument is collected
-        #  2. The timeout you specify with the :timeout option elapses.
-        #  3. The "#" key (or the key you specify with :accept_key) is pressed
+        # 1. The number of digits you specify as the first argument is collected
+        # 2. The timeout elapses.  You can specify the timeout by either:
+        #    * Providing the :timeout option which applies for each awaited
+        #      digit
+        #    * Providing the :initial_timeout for 1st digit and
+        #      :interdigit_timeout for subsequent digits.
+        # 3. The "#" key (or the key you specify with :accept_key) is pressed
+        # 4. You return true from a block you pass in (see "Currency Example" below)
         #
         # Usage examples
         #
@@ -675,7 +680,10 @@ module Adhearsion
         #   input 3 # Receives three digits. Can be 0-9, * or #
         #   input 5, :accept_key => "*"   # Receive at most 5 digits, stopping if '*' is pressed
         #   input 1, :timeout => 1.minute # Receive a single digit, returning an empty
-        #                                   string if the timeout is encountered
+        #                                 # string if the timeout is encountered
+        #   input 3, :initial_timeout => 10.seconds, :interdigit_timeout => 5.seconds # Accept up to 3 digits,
+        #                                                                             # waiting 10 seconds for the 1st digit
+        #                                                                             # and 5 seconds for each subsequent digit.
         #   input 9, :timeout => 7, :accept_key => "0" # Receives nine digits, returning
         #                                              # when the timeout is encountered
         #                                              # or when the "0" key is pressed.
@@ -683,9 +691,22 @@ module Adhearsion
         #   input :play => ["if-this-is-correct-press", 1, "otherwise-press", 2]
         #   input :interruptible => false, :play => ["you-cannot-interrupt-this-message"] # Disallow DTMF (keypad) interruption
         #                                                                                 # until after all files are played.
+        #   input 3, :speak => {:text => 'How much wood could a woodchuck chuck?'} # Say an interruptible TTS phrase
+        #                                                                          # before waiting for input
+        #   input 5, :play => 'this-sound-file-might-not-exist', :speak => {:text => "Here's the TTS I say in case I can't find the sound file"}
+        #
+        # Currency Example
+        #   # Use a block to describe what kind of data will satisfy our input.  Your block will be invoked each time a new digit is
+        #   # received. When your block returns true, it signals #input not to wait for digits anymore.  In the example below, we are
+        #   # expecting a "currency" value, like 10*99.  If the data ends with 2 decimal places, we immediately stop waiting for input.
+        #   input 7, :speak => {:text => "How much is that doggie in the window?"} { |value| value =~ /\*\d\d/ }
         #
         # When specifying files to play, the playback of the sequence of files will stop
-        # immediately when the user presses the first digit.
+        # immediately when the user presses the first digit unless you set :interruptible
+        # to false.
+        #
+        # The :speak option takes a Hash.  The Hash should include a :text key with a
+        # TTS phrase to say. All other keys accepted by {#speak} are also supported.
         #
         # The :timeout option works like a digit timeout, therefore each digit pressed
         # causes the timer to reset. This is a much more user-friendly approach than an
@@ -698,6 +719,8 @@ module Adhearsion
         # @return [String] The keypad input received. An empty string is returned in the
         #                  absense of input. If the :accept_key argument was pressed, it
         #                  will not appear in the output.
+        #
+        # @see http://mojolingo.com/blog/2011/getting_ready_for_adhearsion_1_2/ More information on :speak, and &block parameters
         def input(*args, &block)
           begin
             input! *args, &block
@@ -730,8 +753,10 @@ module Adhearsion
             options[:speak][:interruptible] = options[:interruptible]
           end
 
-          timeout         = options[:timeout]
-          terminating_key = options[:accept_key]
+          timeout             = options[:timeout] || -1
+          initial_timeout     = options[:initial_timeout] || timeout
+          interdigit_timeout  = options[:interdigit_timeout] || timeout
+          terminating_key     = options[:accept_key]
           terminating_key = if terminating_key
             terminating_key.to_s
           elsif number_of_digits.nil? && !terminating_key.equal?(false)
@@ -762,8 +787,10 @@ module Adhearsion
           elsif options[:speak]
             key = speak(options[:speak].delete(:text), options[:speak]) || ''
           else
-            key = wait_for_digit timeout || -1
+            key = ''
           end
+          initial_timeout = nil if key.present?
+
           loop do
             return buffer if key.nil?
             if terminating_key
@@ -778,7 +805,8 @@ module Adhearsion
               return buffer if number_of_digits && number_of_digits == buffer.length
             end
             return buffer if block_given? && yield(buffer)
-            key = wait_for_digit(timeout || -1)
+            key = wait_for_digit(initial_timeout || interdigit_timeout)
+            initial_timeout = nil
           end
         end
 

data/spec/adhearsion/initializer/loading_spec.rb

@@ -16,6 +16,10 @@ module DatabaseInitializationTestHelper
     Adhearsion::Initializer::DatabaseInitializer.start
   end
 
+  def expect_establish_connection
+    flexmock(ActiveRecord::Base).should_receive :establish_connection
+  end
+
   def tempfile_with_contents(contents)
     Tempfile.new("bogus_model").tap do |file|
       file.puts contents
@@ -74,7 +78,7 @@ describe "The database initializer" do
     connection_options = { :adapter => "sqlite3",
                            :dbfile => "foo.sqlite3" }
     flexmock(Adhearsion::Initializer::DatabaseInitializer).should_receive(:require_models).once
-    flexmock(ActiveRecord::Base).should_receive(:establish_connection).with(connection_options)
+    expect_establish_connection.with(connection_options)
 
     start_database_initializer_with_options connection_options
   end
@@ -83,6 +87,7 @@ describe "The database initializer" do
     bogus_model = tempfile_with_contents sample_user_model
     flexmock(Adhearsion::Configuration).new_instances.should_receive(:files_from_setting).once.
         with("paths", "models").and_return [bogus_model.path]
+    expect_establish_connection
     start_database_initializer
     User.superclass.should be ActiveRecord::Base
   end

data/spec/adhearsion/voip/asterisk/commands_spec.rb

@@ -889,7 +889,7 @@ describe 'The #input method' do
 
   it 'input() calls wait_for_digit the specified number of times (when no sound files are given)' do
     mock_call.should_receive(:interruptible_play!).never
-    mock_call.should_receive(:wait_for_digit).times(4).and_return('1', '2', '3', '4')
+    mock_call.should_receive(:wait_for_digit).times(4).with(-1).and_return('1', '2', '3', '4')
     mock_call.input(4).should == '1234'
   end
 
@@ -898,12 +898,95 @@ describe 'The #input method' do
     mock_call.should_receive(:interruptible_play!).once.with('one').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('two').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('three').and_return nil
-    mock_call.should_receive(:wait_for_digit).once.and_throw :digit_request
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_throw :digit_request
     should_throw(:digit_request) { mock_call.input(10, :play => sound_files) }
   end
 
+  it 'waits for digits with :initial_timeout and :interdigit_timeout' do
+    initial_timeout = 6.seconds
+    interdigit_timeout = 3.seconds
+    mock_call.should_receive(:interruptible_play!).never
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(3).with(interdigit_timeout).and_return  '2', '3', '4'
+    mock_call.input(4, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '1234'
+  end
+
+  it 'waits for digits with :initial_timeout when nothing is pressed' do
+    initial_timeout = 6.seconds
+    interdigit_timeout = 3.seconds
+    mock_call.should_receive(:interruptible_play!).never
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return nil
+    mock_call.input(4, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq ''
+  end
+
+  it 'waits for digits, ignoring :timeout if :initial_timeout and :interdigit_timeout are provided' do
+    timeout = 99.hours
+    initial_timeout = 2.seconds
+    interdigit_timeout = 1.second
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(3).with(interdigit_timeout).and_return  '2', '3', '4'
+    mock_call.input(4, :timeout => timeout, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '1234'
+  end
+
+  it 'waits for digits, and given a :timeout and :initial_timeout, defaults :interdigit_timeout to :timeout' do
+    initial_timeout = 20.seconds
+    timeout = 10.seconds
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(2).with(timeout).and_return  '2', '3'
+    mock_call.input(3, :timeout => timeout, :initial_timeout => initial_timeout).should eq '123'
+  end
+
+  it 'waits for digits, and given a :timeout and :interdigit_timeout, defaults :initial_timeout to :timeout' do
+    timeout = 12.seconds
+    interdigit_timeout = 6.seconds
+    mock_call.should_receive(:wait_for_digit).once.with(timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input(5, :timeout => timeout, :interdigit_timeout => interdigit_timeout).should eq '12345'
+  end
+
+  it 'waits for digits for :initial_timeout if sound playback is not interrupted' do
+    initial_timeout = 8.seconds
+    interdigit_timeout = 4.seconds
+    sound_files = %w[ready set go]
+    mock_call.should_receive(:interruptible_play!).once.with('ready').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('set').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('go').and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input(5, :play => sound_files, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12345'
+  end
+
+  it 'ignores :initial_timeout if sound playback is interrupted' do
+    initial_timeout = 8.seconds
+    interdigit_timeout = 4.seconds
+    sound_files = %w[ready set go]
+    mock_call.should_receive(:interruptible_play!).once.with('ready').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('set').and_return '*'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input(5, :play => sound_files, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '*2345'
+  end
+
+  it 'waits for digits for :initial_timeout if speech is not interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your area code?"
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(2).with(interdigit_timeout).and_return '2', '0'
+    mock_call.input(3, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :speak => {:text => text}).should eq '120'
+  end
+
+  it 'ignores :initial_timeout if speech is interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your area code?"
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return '3'
+    mock_call.should_receive(:wait_for_digit).times(2).with(interdigit_timeout).and_return '1', '2'
+    mock_call.input(3, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :speak => {:text => text}).should eq '312'
+  end
+
   it 'should default the :accept_key to "#" when unlimited digits are to be collected' do
-    mock_call.should_receive(:wait_for_digit).times(2).and_return '*', '#'
+    mock_call.should_receive(:wait_for_digit).times(2).with(-1).and_return '*', '#'
     mock_call.input.should == '*'
   end
 
@@ -917,7 +1000,7 @@ describe 'The #input method' do
 
   it 'when :accept_key is false and input() is collecting a finite number of digits, it should allow all DTMFs' do
     all_digits = %w[0 1 2 3 # * 4 5 6 7 8 9]
-    mock_call.should_receive(:wait_for_digit).times(all_digits.size).and_return(*all_digits)
+    mock_call.should_receive(:wait_for_digit).times(all_digits.size).with(-1).and_return(*all_digits)
     the_following_code {
       mock_call.input(all_digits.size, :accept_key => false)
     }.should_not raise_error ArgumentError
@@ -925,7 +1008,7 @@ describe 'The #input method' do
 
   it 'should terminate early when the passed block returns something truthy' do
     three_digits = %w[9 3 0]
-    mock_call.should_receive(:wait_for_digit).times(2).and_return(*three_digits)
+    mock_call.should_receive(:wait_for_digit).times(2).with(-1).and_return(*three_digits)
     mock_call.input(3, :accept_key => false) { |buffer| buffer.size == 2 }.should == '93'
   end
 
@@ -936,9 +1019,10 @@ describe 'The #input method' do
   end
 
   it 'passes wait_for_digit the :timeout option when one is given' do
+    timeout = 1.minute
     mock_call.should_receive(:interruptible_play!).never
-    mock_call.should_receive(:wait_for_digit).twice.and_return '1', '2'
-    mock_call.input(2, :timeout => 1.minute).should == '12'
+    mock_call.should_receive(:wait_for_digit).twice.with(timeout).and_return '1', '2'
+    mock_call.input(2, :timeout => timeout).should == '12'
   end
 
   it 'executes interruptible_play!() with all of the files given to :play' do
@@ -946,7 +1030,7 @@ describe 'The #input method' do
     mock_call.should_receive(:interruptible_play!).once.with('foo').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('bar').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('qaz').and_return '#'
-    mock_call.should_receive(:wait_for_digit).once.and_return '*'
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_return '*'
     mock_call.input(2, :play => sound_files).should == '#*'
   end
 
@@ -955,18 +1039,18 @@ describe 'The #input method' do
     mock_call.should_receive(:play!).once.with('foo').and_return true
     mock_call.should_receive(:play!).once.with('bar').and_return true
     mock_call.should_receive(:play!).once.with('qaz').and_return true
-    mock_call.should_receive(:wait_for_digit).once.and_return '*'
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_return '*'
     mock_call.input(1, :play => sound_files, :interruptible => false).should == '*'
   end
 
   it 'pressing the terminating key before any other digits returns an empty string' do
-    mock_call.should_receive(:wait_for_digit).once.and_return '*'
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_return '*'
     mock_call.input(:accept_key => '*').should == ''
   end
 
   it 'should execute wait_for_digit first if no sound files are given' do
     mock_call.should_receive(:interruptible_play!).never
-    mock_call.should_receive(:wait_for_digit).once.and_throw :digit_request
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_throw :digit_request
     should_throw(:digit_request) { mock_call.input(1) }
   end
 
@@ -979,18 +1063,22 @@ describe 'The #input method' do
   it 'should execute wait_for_digit, even if some interruptible sound files are not found' do
     pbx_should_respond_with_stream_file_failure_on_open
     file = 'foobar'
-    timeout = 1.hour
-    mock_call.should_receive(:wait_for_digit).twice.with(timeout).and_return '8', '9'
-    mock_call.input(2, :timeout => timeout, :play => file).should == '89'
+    initial_timeout = 1.hour
+    interdigit_timeout = 1.minute
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '8'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '9'
+    mock_call.input(2, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :play => file).should == '89'
     pbx_was_asked_to_stream file
   end
 
-  it 'should execute wait_for_digit with, even if some uninterruptible sound files are not found' do
+  it 'should execute wait_for_digit, even if some uninterruptible sound files are not found' do
     pbx_should_respond_with_playback_failure
     file = 'foobar'
-    timeout = 1.hour
-    mock_call.should_receive(:wait_for_digit).twice.with(timeout).and_return '8', '9'
-    mock_call.input(2, :timeout => timeout, :play => file, :interruptible => false).should == '89'
+    initial_timeout = 1.hour
+    interdigit_timeout = 1.minute
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '8'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '9'
+    mock_call.input(2, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :play => file, :interruptible => false).should == '89'
     pbx_was_asked_to_play file
   end
 
@@ -1035,7 +1123,7 @@ describe 'The #input method' do
   it 'should not raise an exception if the sound file is unplayable' do
     pbx_should_respond_with_stream_file_failure_on_open
     file = 'foobar'
-    mock_call.should_receive(:wait_for_digit).once
+    mock_call.should_receive(:wait_for_digit).once.with -1
     the_following_code {
       mock_call.input 1, :play => file
     }.should_not raise_error
@@ -1044,27 +1132,52 @@ describe 'The #input method' do
 
   it 'should default to playing interruptible prompts' do
     mock_call.should_receive(:interruptible_play!).once.with('does_not_matter')
-    mock_call.should_receive(:wait_for_digit).once
+    mock_call.should_receive(:wait_for_digit).once.with -1
     mock_call.input(1, :play => 'does_not_matter')
   end
 
   it 'should render uninterruptible prompts' do
     mock_call.should_receive(:play!).once.with('does_not_matter')
-    mock_call.should_receive(:wait_for_digit).once
+    mock_call.should_receive(:wait_for_digit).once.with -1
     mock_call.input(1, :play => 'does_not_matter', :interruptible => false)
   end
 
   it 'should fall back to speaking TTS if sound file is unplayable' do
     pbx_should_respond_with_stream_file_failure_on_open
     mock_call.should_receive(:speak).once.with("The sound file was not available", :interruptible => true)
-    mock_call.should_receive(:wait_for_digit).once
+    mock_call.should_receive(:wait_for_digit).once.with -1
     mock_call.input(1, :play => 'unavailable sound file', :speak => {:text => "The sound file was not available"})
     @output.read.should == "STREAM FILE \"unavailable sound file\" \"1234567890*#\"\n"
   end
 
+  it 'waits for digits for :initial_timeout if fall back TTS is not interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your sign?"
+    missing_sound_file = 'missing-sound-file'
+    pbx_should_respond_with_stream_file_failure_on_open
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '2'
+    mock_call.input(2, :play => missing_sound_file, :speak => {:text => text}, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12'
+    @output.read.should == "STREAM FILE \"#{missing_sound_file}\" \"1234567890*#\"\n"
+  end
+
+  it 'ignores :initial_timeout if fall back TTS is interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your sign?"
+    missing_sound_file = 'missing-sound-file'
+    pbx_should_respond_with_stream_file_failure_on_open
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return '1'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '2'
+    mock_call.input(2, :play => missing_sound_file, :speak => {:text => text}, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12'
+    @output.read.should == "STREAM FILE \"#{missing_sound_file}\" \"1234567890*#\"\n"
+  end
+
   it 'should allow uninterruptible TTS prompts' do
     mock_call.should_receive(:speak).once.with("The sound file was not available", :interruptible => false)
-    mock_call.should_receive(:wait_for_digit).once
+    mock_call.should_receive(:wait_for_digit).once.with -1
     mock_call.input(1, :speak => {:text => "The sound file was not available"}, :interruptible => false)
   end
 
@@ -1097,16 +1210,99 @@ describe 'The #input! method' do
     mock_call.should_receive(:interruptible_play!).once.with('one').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('two').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('three').and_return nil
-    mock_call.should_receive(:wait_for_digit).once.and_throw :digit_request
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_throw :digit_request
     should_throw(:digit_request) { mock_call.input! 10, :play => sound_files }
   end
 
+  it 'waits for digits with :initial_timeout and :interdigit_timeout' do
+    initial_timeout = 6.seconds
+    interdigit_timeout = 3.seconds
+    mock_call.should_receive(:interruptible_play!).never
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(3).with(interdigit_timeout).and_return  '2', '3', '4'
+    mock_call.input!(4, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '1234'
+  end
+
+  it 'waits for digits with :initial_timeout when nothing is pressed' do
+    initial_timeout = 6.seconds
+    interdigit_timeout = 3.seconds
+    mock_call.should_receive(:interruptible_play!).never
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return nil
+    mock_call.input!(4, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq ''
+  end
+
+  it 'waits for digits, ignoring :timeout if :initial_timeout and :interdigit_timeout are provided' do
+    timeout = 99.hours
+    initial_timeout = 2.seconds
+    interdigit_timeout = 1.second
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(3).with(interdigit_timeout).and_return  '2', '3', '4'
+    mock_call.input!(4, :timeout => timeout, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '1234'
+  end
+
+  it 'waits for digits, and given a :timeout and :initial_timeout, defaults :interdigit_timeout to :timeout' do
+    initial_timeout = 20.seconds
+    timeout = 10.seconds
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(2).with(timeout).and_return  '2', '3'
+    mock_call.input!(3, :timeout => timeout, :initial_timeout => initial_timeout).should eq '123'
+  end
+
+  it 'waits for digits, and given a :timeout and :interdigit_timeout, defaults :initial_timeout to :timeout' do
+    timeout = 12.seconds
+    interdigit_timeout = 6.seconds
+    mock_call.should_receive(:wait_for_digit).once.with(timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input!(5, :timeout => timeout, :interdigit_timeout => interdigit_timeout).should eq '12345'
+  end
+
+  it 'waits for digits for :initial_timeout if sound playback is not interrupted' do
+    initial_timeout = 8.seconds
+    interdigit_timeout = 4.seconds
+    sound_files = %w[ready set go]
+    mock_call.should_receive(:interruptible_play!).once.with('ready').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('set').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('go').and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input!(5, :play => sound_files, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12345'
+  end
+
+  it 'ignores :initial_timeout if sound playback is interrupted' do
+    initial_timeout = 8.seconds
+    interdigit_timeout = 4.seconds
+    sound_files = %w[ready set go]
+    mock_call.should_receive(:interruptible_play!).once.with('ready').and_return nil
+    mock_call.should_receive(:interruptible_play!).once.with('set').and_return '*'
+    mock_call.should_receive(:wait_for_digit).times(4).with(interdigit_timeout).and_return  '2', '3', '4', '5'
+    mock_call.input!(5, :play => sound_files, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '*2345'
+  end
+
+  it 'waits for digits for :initial_timeout if speech is not interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your area code?"
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).times(2).with(interdigit_timeout).and_return '2', '0'
+    mock_call.input!(3, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :speak => {:text => text}).should eq '120'
+  end
+
+  it 'ignores :initial_timeout if speech is interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your area code?"
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return '3'
+    mock_call.should_receive(:wait_for_digit).times(2).with(interdigit_timeout).and_return '1', '2'
+    mock_call.input!(3, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout, :speak => {:text => text}).should eq '312'
+  end
+
   it 'executes interruptible_play!() with all of the files given to :play' do
     sound_files = %w[foo bar qaz]
     mock_call.should_receive(:interruptible_play!).once.with('foo').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('bar').and_return nil
     mock_call.should_receive(:interruptible_play!).once.with('qaz').and_return '#'
-    mock_call.should_receive(:wait_for_digit).once.and_return '*'
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_return '*'
     mock_call.input!(2, :play => sound_files).should == '#*'
   end
 
@@ -1115,13 +1311,13 @@ describe 'The #input! method' do
     mock_call.should_receive(:play!).once.with('foo').and_return true
     mock_call.should_receive(:play!).once.with('bar').and_return true
     mock_call.should_receive(:play!).once.with('qaz').and_return true
-    mock_call.should_receive(:wait_for_digit).once.and_return '*'
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_return '*'
     mock_call.input!(1, :play => sound_files, :interruptible => false).should == '*'
   end
 
   it 'should execute wait_for_digit first if no sound files are given' do
     mock_call.should_receive(:interruptible_play!).never
-    mock_call.should_receive(:wait_for_digit).once.and_throw :digit_request
+    mock_call.should_receive(:wait_for_digit).once.with(-1).and_throw :digit_request
     should_throw(:digit_request) { mock_call.input! 1 }
   end
 
@@ -1135,6 +1331,39 @@ describe 'The #input! method' do
     pbx_was_asked_to_stream file
   end
 
+  it 'should fall back to speaking TTS if sound file is unplayable' do
+    pbx_should_respond_with_stream_file_failure_on_open
+    mock_call.should_receive(:speak).once.with("The sound file was not available", :interruptible => true)
+    mock_call.should_receive(:wait_for_digit).once.with -1
+    mock_call.input!(1, :play => 'unavailable sound file', :speak => {:text => "The sound file was not available"})
+    @output.read.should == "STREAM FILE \"unavailable sound file\" \"1234567890*#\"\n"
+  end
+
+  it 'waits for digits for :initial_timeout if fall back TTS is not interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your sign?"
+    missing_sound_file = 'missing-sound-file'
+    pbx_should_respond_with_stream_file_failure_on_open
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return nil
+    mock_call.should_receive(:wait_for_digit).once.with(initial_timeout).and_return '1'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '2'
+    mock_call.input!(2, :play => missing_sound_file, :speak => {:text => text}, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12'
+    @output.read.should == "STREAM FILE \"#{missing_sound_file}\" \"1234567890*#\"\n"
+  end
+
+  it 'ignores :initial_timeout if fall back TTS is interrupted' do
+    initial_timeout = 10.seconds
+    interdigit_timeout = 5.seconds
+    text = "What's your sign?"
+    missing_sound_file = 'missing-sound-file'
+    pbx_should_respond_with_stream_file_failure_on_open
+    mock_call.should_receive(:speak).once.with(text, :interruptible => true).and_return '1'
+    mock_call.should_receive(:wait_for_digit).once.with(interdigit_timeout).and_return '2'
+    mock_call.input!(2, :play => missing_sound_file, :speak => {:text => text}, :initial_timeout => initial_timeout, :interdigit_timeout => interdigit_timeout).should eq '12'
+    @output.read.should == "STREAM FILE \"#{missing_sound_file}\" \"1234567890*#\"\n"
+  end
+
   it 'should play a series of interruptible files, raising an error if a sound file cannot be found' do
     pbx_should_respond_with_stream_file_success 0
     pbx_should_respond_with_stream_file_failure_on_open
@@ -1535,7 +1764,7 @@ describe "The queue management abstractions" do
 
   it 'should fetch the members with the name given to queue()' do
     mock_call.should_receive(:variable).once.with("QUEUE_MEMBER_COUNT(jay)").and_return 5
-    mock_call.queue('jay').agents.size.should be 5
+    mock_call.queue('jay').agents.size.should == 5
   end
 
   it 'should not fetch a QUEUE_MEMBER_COUNT each time count() is called when caching is enabled' do
@@ -1554,7 +1783,7 @@ describe "The queue management abstractions" do
   it 'when fetching agents, it should properly split by the supported delimiters' do
     queue_name = "doesnt_matter"
     mock_call.should_receive(:get_variable).with("QUEUE_MEMBER_LIST(#{queue_name})").and_return('Agent/007,Agent/003,Zap/2')
-    mock_call.queue(queue_name).agents(:cache => true).to_a.size.should be 3
+    mock_call.queue(queue_name).agents(:cache => true).to_a.size.should == 3
   end
 
   it 'when fetching agents, each array index should be an instance of AgentProxy' do
@@ -1734,7 +1963,7 @@ describe "The queue management abstractions" do
   it 'waiting_count for a queue that does exist' do
     mock_call.should_receive(:get_variable).once.with("QUEUE_WAITING_COUNT(q)").and_return "50"
     flexmock(mock_call.queue('q')).should_receive(:exists?).once.and_return true
-    mock_call.queue('q').waiting_count.should be 50
+    mock_call.queue('q').waiting_count.should == 50
   end
 
   it 'waiting_count for a queue that does not exist' do
@@ -2056,7 +2285,7 @@ describe 'the MenuBuilder' do
       link.bar "4", "5", 6
     end
 
-    builder.weighted_match_calculators.size.should be 6
+    builder.weighted_match_calculators.size.should == 6
     builder.weighted_match_calculators.each do |match_calculator|
       match_calculator.should be_a_kind_of Adhearsion::VoIP::MatchCalculator
     end
@@ -2102,12 +2331,12 @@ describe 'the MenuBuilder' do
     end
     1.upto 9 do |num|
       builder.calculate_matches_for(num).tap do |matches_of_num|
-        matches_of_num.potential_match_count.should be 100
-        matches_of_num.exact_match_count.should be 1
+        matches_of_num.potential_match_count.should == 100
+        matches_of_num.exact_match_count.should == 1
       end
       builder.calculate_matches_for((num * 100) + 5).tap do |matches_of_num|
-        matches_of_num.potential_match_count.should be 0
-        matches_of_num.exact_match_count.should be 1
+        matches_of_num.potential_match_count.should == 0
+        matches_of_num.exact_match_count.should == 1
       end
     end
   end
@@ -2117,7 +2346,7 @@ describe 'the MenuBuilder' do
       link.nineninenine 999
       link.shouldnt_match 4444
     end
-    builder.calculate_matches_for(9).potential_match_count.should be 1
+    builder.calculate_matches_for(9).potential_match_count.should == 1
   end
 
   it "three fixnums that obviously don't conflict" do
@@ -2158,7 +2387,7 @@ describe 'the MenuBuilder' do
       link.range 100..200
     end
     matches = builder.calculate_matches_for 1
-    matches.potential_match_count.should be 100
+    matches.potential_match_count.should == 100
   end
 
 end
@@ -2333,7 +2562,7 @@ describe 'jump_to command' do
     rescue Adhearsion::VoIP::DSL::Dialplan::ControlPassingException
       # Eating this exception
     end
-    mock_call.extension.__real_num.should be 1337
+    mock_call.extension.__real_num.should == 1337
   end
 
   it 'other overrides should be simply metadef()d' do
@@ -2869,7 +3098,7 @@ describe 'the DialPlan::ConfirmationManager' do
   it '::decode_hash() should split the sound files in the :play key to an array by splitting by "++"' do
     decoded_sound_files = Adhearsion::DialPlan::ConfirmationManager.decode_hash(example_encoded_hash)[:play]
     decoded_sound_files.should be_a_kind_of Array
-    decoded_sound_files.size.should be 2
+    decoded_sound_files.size.should == 2
   end
 
   it 'a call to a party which is acknowledged with the proper key during the call to interruptible_play' do

data/spec/adhearsion/voip/asterisk/config_file_generators/voicemail_spec.rb

@@ -107,7 +107,7 @@ describe 'A mailbox definition' do
 
   it 'setting the pin_number should be reflected in the to_hash form of the definition' do
     mailbox.pin_number 555
-    mailbox.to_hash[:pin_number].should be 555
+    mailbox.to_hash[:pin_number].should == 555
   end
 
   it 'the mailbox number should be available in the mailbox_number getter' do
@@ -265,7 +265,7 @@ describe 'An expansive example of the Voicemail config generator' do
       end
     end
     internalized = vm.to_sanitary_hash
-    internalized.size.should be 5 # general, zonemessages, default, employees, groups
+    internalized.size.should == 5 # general, zonemessages, default, employees, groups
 
     target_config = <<-CONFIG
 [general]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -12,12 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-22 00:00:00.000000000 +01:00
-default_executable: 
+date: 2011-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153625640 !ruby/object:Gem::Requirement
+  requirement: &2153249240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -25,10 +24,10 @@ dependencies:
         version: 1.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *2153625640
+  version_requirements: *2153249240
 - !ruby/object:Gem::Dependency
   name: log4r
-  requirement: &2153625040 !ruby/object:Gem::Requirement
+  requirement: &2153248640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -36,10 +35,10 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2153625040
+  version_requirements: *2153248640
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153624560 !ruby/object:Gem::Requirement
+  requirement: &2160508360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -47,10 +46,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153624560
+  version_requirements: *2160508360
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2153624180 !ruby/object:Gem::Requirement
+  requirement: &2160507740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -58,10 +57,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153624180
+  version_requirements: *2160507740
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2153623720 !ruby/object:Gem::Requirement
+  requirement: &2160506720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,10 +68,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153623720
+  version_requirements: *2160506720
 - !ruby/object:Gem::Dependency
   name: rubigen
-  requirement: &2153621640 !ruby/object:Gem::Requirement
+  requirement: &2160505340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -80,10 +79,10 @@ dependencies:
         version: 1.5.6
   type: :runtime
   prerelease: false
-  version_requirements: *2153621640
+  version_requirements: *2160505340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153621020 !ruby/object:Gem::Requirement
+  requirement: &2160504180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -91,10 +90,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153621020
+  version_requirements: *2160504180
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2153620340 !ruby/object:Gem::Requirement
+  requirement: &2160500800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -102,10 +101,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153620340
+  version_requirements: *2160500800
 - !ruby/object:Gem::Dependency
   name: rubigen
-  requirement: &2153619580 !ruby/object:Gem::Requirement
+  requirement: &2160498080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -113,10 +112,10 @@ dependencies:
         version: 1.5.6
   type: :development
   prerelease: false
-  version_requirements: *2153619580
+  version_requirements: *2160498080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153618960 !ruby/object:Gem::Requirement
+  requirement: &2160496140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -124,10 +123,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2153618960
+  version_requirements: *2160496140
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &2153618560 !ruby/object:Gem::Requirement
+  requirement: &2160494480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -135,10 +134,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153618560
+  version_requirements: *2160494480
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153617980 !ruby/object:Gem::Requirement
+  requirement: &2160493320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -146,10 +145,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *2153617980
+  version_requirements: *2160493320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153617540 !ruby/object:Gem::Requirement
+  requirement: &2160491920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -157,10 +156,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153617540
+  version_requirements: *2160491920
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2153617080 !ruby/object:Gem::Requirement
+  requirement: &2160491240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -168,10 +167,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153617080
+  version_requirements: *2160491240
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
-  requirement: &2153616640 !ruby/object:Gem::Requirement
+  requirement: &2160490120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -179,10 +178,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153616640
+  version_requirements: *2160490120
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2153616220 !ruby/object:Gem::Requirement
+  requirement: &2160488600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -190,7 +189,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153616220
+  version_requirements: *2160488600
 description: Adhearsion is an open-source telephony development framework
 email: dev&Adhearsion.com
 executables:
@@ -364,7 +363,6 @@ files:
 - spec/theatre/namespace_spec.rb
 - spec/theatre/spec_helper_spec.rb
 - spec/theatre/theatre_class_spec.rb
-has_rdoc: true
 homepage: http://adhearsion.com
 licenses: []
 post_install_message: 
@@ -379,7 +377,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3254044399957334280
+      hash: 4207106213381902731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -388,10 +386,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3254044399957334280
+      hash: 4207106213381902731
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Adhearsion, open-source telephony development framework