adhearsion-ivr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748ecbe4414a38d5ff3b011feac37449447b150d
-  data.tar.gz: c15534a4e1395b758aefb698bed447875af832fd
+  metadata.gz: 6291bef984d7c1879749d5a74c5e663815e20c63
+  data.tar.gz: 10398791d0968fc7eafd71e2938c6e71527e02e7
 SHA512:
-  metadata.gz: 326c7fd91c2940d5335fd0942b54aaf6e4d00c057f50293de0ee9fd518313408a34363879e709341f2190a1420c2660803f94eebe3ee942cd095e8dc0dd69e6e
-  data.tar.gz: ae1d4057a6e2ad860833f31324aa14f14652866ca2876ba33d0d4e5c42d2acb4da584d40f6506ab1bc68511f1e948a3a0d2bb3218d78b1270976288f7207c0bf
+  metadata.gz: b2a8ea89beec6b451fd9e33d280230395cafb7016a6cb10744c0c4d63d46d69005a1d19b303e74c55b7bd5908f92b9ae3b57030b7eaa7478e81451a18ad46365
+  data.tar.gz: c69cb9bb091a9fa5034c45ef361ea8c6be6081489d929f4fe6f1fa7864706646d331d199894be8740fcdebb6b336ba1e7eb1e216956f0d8076e9229afc00f6d9

data/.hound.yml

@@ -0,0 +1,2 @@
+LineLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # [develop](https://github.com/adhearsion/adhearsion-ivr)
 
+# [v0.2.0](https://github.com/adhearsion/adhearsion-ivr/compare/0.1.0...0.2.0) - [2015-03-27](https://rubygems.org/gems/adhearsion-ivr/versions/0.2.0)
+  * Feature: Added support for defining alternative prompt resolution algorithms by overriding `#prompts`
+  * Feature: Added support for overriding `#max_attempts`
+  * Feature: Added support for specifying a timeout using #timeout
+  * Feature: Added support for specifying a grammar URL using #grammar_url
+  * Feature: Added support for specifying a validation callback
+  * Feature: Added support for specifying a `renderer`
+
 # [v0.1.0](https://github.com/adhearsion/adhearsion-ivr/compare/2c7ff73f5d6471be23e291c7d6c7b61d0128e09a...0.1.0) - [2014-03-12](https://rubygems.org/gems/adhearsion-ivr/versions/0.1.0)
   * Initial release

data/README.md

@@ -36,12 +36,12 @@ class SimplePrompt < Adhearsion::IVRController
       hangup
     end
   end
-  
+
   on_failure do
     say "Sorry you failed kindergarten. Let us transfer you to our trained staff of kindergarten teachers."
     dial 'sip:kindergarten_teachers@elementaryschool.com'
   end
-  
+
   def grammar
     RubySpeech::GRXML.draw do
       # ... put a valid GRXML grammar here
@@ -58,9 +58,9 @@ class EscalatedPrompt < Adhearsion::IVRController
   prompts << "Second attempt: enter a number 1 through 3"
   prompts << "Third attempt: enter a number 1 through 3. That would be the top row of your DTMF keypad. Don't get it wrong again."
   prompts << "Fourth attempt: really? Was I not clear the first 3 times? Last chance, dunce."
-  
+
   max_attempts 4
- 
+
   on_complete do |result|
     case result.nlsml.interpretations.first[:instance] # FIXME?
     when 1
@@ -72,12 +72,46 @@ class EscalatedPrompt < Adhearsion::IVRController
       hangup
     end
   end
-  
+
+  on_failure do
+    say "Sorry you failed kindergarten. Let us transfer you to our trained staff of kindergarten teachers."
+    dial 'sip:kindergarten_teachers@elementaryschool.com'
+  end
+
+  def grammar
+    RubySpeech::GRXML.draw do
+      # ... put a valid GRXML grammar here
+    end
+  end
+end
+```
+
+An example with input validation:
+
+```Ruby
+class InputValidation < Adhearsion::IVRController
+  prompts << "Please enter your favorite fruit"
+
+  on_complete do |result|
+    case result.interpretation
+    when "apple"
+      pass AppleController
+    when "orange"
+      pass OrangeController
+    else
+      pass OtherController
+    end
+  end
+
   on_failure do
     say "Sorry you failed kindergarten. Let us transfer you to our trained staff of kindergarten teachers."
     dial 'sip:kindergarten_teachers@elementaryschool.com'
   end
-  
+
+  validate do
+    ["apple", "orange", "banana", "tomato"].include? @result.interpretation
+  end
+
   def grammar
     RubySpeech::GRXML.draw do
       # ... put a valid GRXML grammar here
@@ -97,9 +131,47 @@ class I18nEscalatedPrompts < Adhearsion::IVRController
   prompts << -> { [ t(:fourth_attempt), t(:this_is_your_final_attempt) ] }
   # Future improvement: we could potentially also include the previous input
   # in the re-prompts, but that isn't implemented now
-  
+
   max_attempts 4
- 
+  timeout 30
+
+  on_complete do |result|
+    case result.nlsml.interpretations.first[:instance] # FIXME?
+    when 1
+      pass OneController
+    when 2
+      pass TwoController
+    when 3
+      say "Yuk yuk yuk"
+      hangup
+    end
+  end
+
+  on_failure do
+    say "Sorry you failed kindergarten. Let us transfer you to our trained staff of kindergarten teachers."
+    dial 'sip:kindergarten_teachers@elementaryschool.com'
+  end
+
+  def grammar
+    RubySpeech::GRXML.draw do
+      # ... put a valid GRXML grammar here
+    end
+  end
+end
+```
+
+## Method overriding in subclasses
+
+If you need to set the configuration for the menu at runtime, `#prompts`, `#timeout`, `#max_attempts` and `renderer` can be defined on the subclass to provide the needed values, as you can see in the following example.
+
+The examples assumes the values have been placed in call variables by an earlier controller, which is also a practical use case for overriding methods.
+
+`renderer` values are the same accepted by the various Adhearsion output methods.
+
+```Ruby
+class OverriddenPrompt < Adhearsion::IVRController
+  prompts << "Please enter a number 1 through 3"
+
   on_complete do |result|
     case result.nlsml.interpretations.first[:instance] # FIXME?
     when 1
@@ -111,12 +183,28 @@ class I18nEscalatedPrompts < Adhearsion::IVRController
       hangup
     end
   end
-  
+
   on_failure do
     say "Sorry you failed kindergarten. Let us transfer you to our trained staff of kindergarten teachers."
     dial 'sip:kindergarten_teachers@elementaryschool.com'
   end
-  
+
+  def prompts
+    ["Please enter a number 1 through 3", "You should enter a number 1 through 3"]
+  end
+
+  def timeout
+    call[:menu_timeout]
+  end
+
+  def renderer
+    :unimrcp
+  end
+
+  def max_attempts
+    call[:menu_retries]
+  end
+
   def grammar
     RubySpeech::GRXML.draw do
       # ... put a valid GRXML grammar here

data/lib/adhearsion-ivr/ivr_controller.rb

@@ -23,6 +23,30 @@ module Adhearsion
         end
       end
 
+      # timeout in seconds for each menu attempt
+      def timeout(num = nil)
+        if num
+          @timeout = num
+        else
+          @timeout || nil
+        end
+      end
+
+      # renderer to use for the prompts
+      def renderer(engine = nil)
+        if engine
+          @renderer = engine
+        else
+          @renderer || nil
+        end
+      end
+
+      # called to verify matched input is valid - should be truthy for valid input, falsey otherwise.
+      def validate_input(&block)
+        @validate_callback = block
+      end
+      attr_reader :validate_callback
+
       # called when the caller successfully provides input
       def on_complete(&block)
         @completion_callback = block
@@ -37,13 +61,15 @@ module Adhearsion
     end
 
     state_machine initial: :prompting do
-      event(:match)    { transition prompting: :complete }
+      event(:match)    { transition prompting: :validation }
+      event(:valid)    { transition validation: :complete }
+      event(:invalid)  { transition validation: :input_error }
       event(:reprompt) { transition input_error: :prompting }
       event(:nomatch)  { transition prompting: :input_error }
       event(:noinput)  { transition prompting: :input_error }
       event(:failure)  { transition prompting: :failure, input_error: :failure }
 
-      after_transition :prompting => :input_error do |controller|
+      after_transition any => :input_error do |controller|
         controller.increment_errors
         if controller.continue?
           controller.reprompt!
@@ -52,11 +78,19 @@ module Adhearsion
         end
       end
 
+      after_transition any => :validation do |controller|
+        if controller.validate_callback
+          controller.valid!
+        else
+          controller.invalid!
+        end
+      end
+
       after_transition any => :prompting do |controller|
         controller.deliver_prompt
       end
 
-      after_transition :prompting => :complete do |controller|
+      after_transition any => :complete do |controller|
         controller.completion_callback
       end
 
@@ -71,11 +105,22 @@ module Adhearsion
     end
 
     def deliver_prompt
-      prompt = self.class.prompts[@errors] || self.class.prompts.last
+      prompt = prompts[@errors] || prompts.last
       prompt = instance_exec(&prompt) if prompt.respond_to? :call
       logger.debug "Prompt: #{prompt.inspect}"
 
-      @result = ask prompt, grammar: grammar, mode: :voice
+      if grammar
+        ask_options = { grammar: grammar, mode: :voice }
+      elsif grammar_url
+        ask_options = { grammar_url: grammar_url, mode: :voice }
+      else
+        fail NotImplementedError, 'You must override #grammar or #grammar_url and provide an input grammar'
+      end
+
+      ask_options[:timeout] = timeout if timeout
+      ask_options[:output_options] = { renderer: renderer } if renderer
+
+      @result = ask prompt, ask_options
       logger.debug "Got result #{@result.inspect}"
       case @result.status
       when :match
@@ -84,19 +129,39 @@ module Adhearsion
         logger.info "Prompt was stopped forcibly. Exiting cleanly..."
       when :hangup
         logger.info "Call was hung up mid-prompt. Exiting controller flow..."
-        raise Adhearsion::Call::Hangup
+        fail Adhearsion::Call::Hangup
       when :nomatch
         nomatch!
       when :noinput
         noinput!
       else
-        raise "Unrecognized result status: #{@result.status}"
+        fail "Unrecognized result status: #{@result.status}"
       end
       @result
     end
 
     def grammar
-      raise NotImplementedError, "You must override #grammar and provide a grammar"
+      nil
+    end
+
+    def grammar_url
+      nil
+    end
+
+    def prompts
+      self.class.prompts
+    end
+
+    def max_attempts
+      self.class.max_attempts
+    end
+
+    def timeout
+      self.class.timeout
+    end
+
+    def renderer
+      self.class.renderer
     end
 
     def increment_errors
@@ -104,7 +169,15 @@ module Adhearsion
     end
 
     def continue?
-      @errors < self.class.max_attempts
+      @errors < max_attempts
+    end
+
+    def validate_callback
+      if self.class.validate_callback
+        instance_exec &self.class.validate_callback
+      else
+        true
+      end
     end
 
     def completion_callback

data/lib/adhearsion-ivr/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class AdhearsionIVR
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/adhearsion-ivr/ivr_controller_spec.rb

@@ -25,6 +25,10 @@ describe Adhearsion::IVRController do
           say apology_announcement
         end
 
+        validate_input do
+          @result.utterance == 'Paris'
+        end
+
         def grammar
           :some_grammar
         end
@@ -71,35 +75,35 @@ describe Adhearsion::IVRController do
       end
     end
 
-    context "when an utterance is received" do
+    context 'when an utterance is received' do
       before do
         controller.should_receive(:ask).once.with(expected_prompts[0], grammar: expected_grammar, mode: :voice).and_return result
       end
 
-      context "that is a match" do
+      context 'that is a match' do
         let(:result) { match_result }
 
-        it "passes the Result object to the on_complete block" do
+        it 'passes the Result object to the on_complete block' do
           controller.should_receive(:say).once.with "Let's go to Paris"
           controller.run
         end
       end
 
-      context "that is a noinput" do
+      context 'that is a noinput' do
         let(:result) { noinput_result }
 
-        context "followed by a match" do
+        context 'followed by a match' do
           before do
             controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return match_result
           end
 
-          it "re-prompts using the next prompt, and then passes the second Result to the on_complete block" do
+          it 're-prompts using the next prompt, and then passes the second Result to the on_complete block' do
             controller.should_receive(:say).once.with "Let's go to Paris"
             controller.run
           end
         end
 
-        context "when there are not enough prompts available for all retries" do
+        context 'when there are not enough prompts available for all retries' do
           let(:expected_prompts) { [SecureRandom.uuid, SecureRandom.uuid] }
 
           before do
@@ -107,26 +111,26 @@ describe Adhearsion::IVRController do
             controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return match_result
           end
 
-          it "reuses the last prompt" do
+          it 'reuses the last prompt' do
             controller.should_receive(:say).once.with "Let's go to Paris"
             controller.run
           end
         end
 
-        context "until it hits the maximum number of attempts" do
-          context "using the default of 3 attempts" do
+        context 'until it hits the maximum number of attempts' do
+          context 'using the default of 3 attempts' do
             before do
               controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return result
               controller.should_receive(:ask).once.with(expected_prompts[2], grammar: expected_grammar, mode: :voice).and_return result
             end
 
-            it "invokes the on_failure block" do
+            it 'invokes the on_failure block' do
               controller.should_receive(:say).once.with apology_announcement
               controller.run
             end
           end
 
-          context "when that value is different from the default" do
+          context 'when that value is different from the default' do
             let(:controller_class) do
               expected_prompts = self.expected_prompts
               apology_announcement = self.apology_announcement
@@ -156,7 +160,7 @@ describe Adhearsion::IVRController do
               controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return result
             end
 
-            it "invokes the on_failure block" do
+            it 'invokes the on_failure block' do
               controller.should_receive(:say).once.with apology_announcement
               controller.run
             end
@@ -164,25 +168,25 @@ describe Adhearsion::IVRController do
         end
       end
 
-      context "that is a nomatch" do
+      context 'that is a nomatch' do
         let(:result) do
           AdhearsionASR::Result.new.tap do |res|
             res.status = :nomatch
           end
         end
 
-        context "followed by a match" do
+        context 'followed by a match' do
           before do
             controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return match_result
           end
 
-          it "re-prompts using the next prompt, and then passes the second Result to the on_complete block" do
+          it 're-prompts using the next prompt, and then passes the second Result to the on_complete block' do
             controller.should_receive(:say).once.with "Let's go to Paris"
             controller.run
           end
         end
 
-        context "when there are not enough prompts available for all retries" do
+        context 'when there are not enough prompts available for all retries' do
           let(:expected_prompts) { [SecureRandom.uuid, SecureRandom.uuid] }
 
           before do
@@ -190,26 +194,26 @@ describe Adhearsion::IVRController do
             controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return match_result
           end
 
-          it "reuses the last prompt" do
+          it 'reuses the last prompt' do
             controller.should_receive(:say).once.with "Let's go to Paris"
             controller.run
           end
         end
 
-        context "until it hits the maximum number of attempts" do
-          context "using the default of 3 attempts" do
+        context 'until it hits the maximum number of attempts' do
+          context 'using the default of 3 attempts' do
             before do
               controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return result
               controller.should_receive(:ask).once.with(expected_prompts[2], grammar: expected_grammar, mode: :voice).and_return result
             end
 
-            it "invokes the on_failure block" do
+            it 'invokes the on_failure block' do
               controller.should_receive(:say).once.with apology_announcement
               controller.run
             end
           end
 
-          context "when that value is different from the default" do
+          context 'when that value is different from the default' do
             let(:controller_class) do
               expected_prompts = self.expected_prompts
               apology_announcement = self.apology_announcement
@@ -239,7 +243,46 @@ describe Adhearsion::IVRController do
               controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return result
             end
 
-            it "invokes the on_failure block" do
+            it 'invokes the on_failure block' do
+              controller.should_receive(:say).once.with apology_announcement
+              controller.run
+            end
+          end
+        end
+      end
+
+      context 'that fails validation' do
+        let(:invalid_result) do
+          AdhearsionASR::Result.new.tap do |res|
+            res.status         = :match
+            res.mode           = :voice
+            res.confidence     = 1
+            res.utterance      = 'London'
+            res.interpretation = 'London'
+            res.nlsml          = nlsml
+          end
+        end
+        let(:result) { invalid_result }
+
+        context 'followed by a succesful validation' do
+          before do
+            controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return match_result
+          end
+
+          it 're-prompt, and then passes the valid result to the on_complete block' do
+            controller.should_receive(:say).once.with "Let's go to Paris"
+            controller.run
+          end
+        end
+
+        context 'until it hits the maximum number of attempts' do
+          context 'using the default of 3 attempts' do
+            before do
+              controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return result
+              controller.should_receive(:ask).once.with(expected_prompts[2], grammar: expected_grammar, mode: :voice).and_return result
+            end
+
+            it 'invokes the on_failure block' do
               controller.should_receive(:say).once.with apology_announcement
               controller.run
             end
@@ -247,7 +290,7 @@ describe Adhearsion::IVRController do
         end
       end
 
-      context "that is a hangup" do
+      context 'that is a hangup' do
         let(:controller_class) do
           expected_prompts = self.expected_prompts
 
@@ -257,11 +300,11 @@ describe Adhearsion::IVRController do
             end
 
             on_complete do |result|
-              raise "Got complete"
+              fail 'Got complete'
             end
 
             on_failure do
-              raise "Got failure"
+              fail 'Got failure'
             end
 
             def grammar
@@ -276,12 +319,12 @@ describe Adhearsion::IVRController do
           end
         end
 
-        it "raises Adhearsion::Call::Hangup" do
+        it 'raises Adhearsion::Call::Hangup' do
           expect { controller.run }.to raise_error(Adhearsion::Call::Hangup)
         end
       end
 
-      context "that is a stop" do
+      context 'that is a stop' do
         let(:controller_class) do
           expected_prompts = self.expected_prompts
 
@@ -291,11 +334,11 @@ describe Adhearsion::IVRController do
             end
 
             on_complete do |result|
-              raise "Got complete"
+              fail 'Got complete'
             end
 
             on_failure do
-              raise "Got failure"
+              fail 'Got failure'
             end
 
             def grammar
@@ -310,13 +353,13 @@ describe Adhearsion::IVRController do
           end
         end
 
-        it "falls through silently" do
+        it 'falls through silently' do
           controller.run
         end
       end
     end
 
-    context "when the prompts are callable" do
+    context 'when the prompts are callable' do
       let(:controller_class) do
         Class.new(Adhearsion::IVRController) do
           prompts << -> { thing }
@@ -338,7 +381,7 @@ describe Adhearsion::IVRController do
         end
       end
 
-      it "should evaluate the prompt repeatedly in the context of the controller instance" do
+      it 'should evaluate the prompt repeatedly in the context of the controller instance' do
         controller.should_receive(:ask).once.with('one', grammar: expected_grammar, mode: :voice).and_return noinput_result
         controller.should_receive(:ask).once.with('two', grammar: expected_grammar, mode: :voice).and_return noinput_result
         controller.should_receive(:ask).once.with('three', grammar: expected_grammar, mode: :voice).and_return noinput_result
@@ -346,10 +389,32 @@ describe Adhearsion::IVRController do
       end
     end
 
-    context "when no grammar is provided" do
+    context 'when a grammar is referenced by url' do
+      let(:test_grammar_url) { 'http://localhost/grammar.grxml' }
+      let(:controller_class) do
+        Class.new(Adhearsion::IVRController) do
+          prompts << 'Hello'
+          max_attempts 1
+
+          on_failure do
+          end
+
+          def grammar_url
+            'http://localhost/grammar.grxml'
+          end
+        end
+      end
+
+      it 'should call #ask with the correct option' do
+        controller.should_receive(:ask).once.with('Hello', grammar_url: test_grammar_url, mode: :voice).and_return noinput_result
+        controller.run
+      end
+    end
+
+    context 'when no grammar is provided' do
       let(:controller_class) do
         Class.new(Adhearsion::IVRController) do
-          prompts << "Hello"
+          prompts << 'Hello'
 
           on_complete do |result|
           end
@@ -359,15 +424,15 @@ describe Adhearsion::IVRController do
         end
       end
 
-      it "should raise NotImplementedError" do
+      it 'should raise NotImplementedError' do
         expect { controller.run }.to raise_error(NotImplementedError)
       end
     end
 
-    context "when no complete callback is provided" do
+    context 'when no complete callback is provided' do
       let(:controller_class) do
         Class.new(Adhearsion::IVRController) do
-          prompts << "Hello"
+          prompts << 'Hello'
 
           def grammar
             :some_grammar
@@ -375,16 +440,89 @@ describe Adhearsion::IVRController do
         end
       end
 
-      it "should simply return the result" do
+      it 'should simply return the result' do
         controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return match_result
         controller.run.should be(match_result)
       end
+
+      it 'should simply return the last result' do
+        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
+        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
+        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
+        controller.run.should be(noinput_result)
+      end
+    end
+
+    context 'when the call is dead' do
+      before { call.terminate }
+
+      it 'executing the controller should raise Adhearsion::Call::Hangup' do
+        expect { subject.run }.to raise_error Adhearsion::Call::Hangup
+      end
     end
 
-    context "when no complete callback is provided" do
+    context 'when overriding prompts' do
+      let(:override_prompts) { [SecureRandom.uuid, SecureRandom.uuid, SecureRandom.uuid] }
+
+      before do
+        override_prompts = self.override_prompts
+        controller_class.send :define_method, :prompts do
+          override_prompts
+        end
+      end
+
+      context 'with a successful match' do
+        let(:result) { match_result }
+
+        it 'plays the correct prompt' do
+          controller.should_receive(:ask).once.with(override_prompts[0], grammar: expected_grammar, mode: :voice).and_return result
+          controller.should_receive(:say).once.with "Let's go to Paris"
+          controller.run
+        end
+      end
+    end
+
+    context 'when overriding max_attempts' do
+      let(:max_attempts_number) { 2 }
+
+      before do
+        max_attempts_number = self.max_attempts_number
+        controller_class.send :define_method, :max_attempts do
+          max_attempts_number
+        end
+      end
+
+      context 'with a different number of attempts than the default and failed input' do
+        it 'plays the apology announcement after receiving the correct number of failed inputs' do
+          controller.should_receive(:ask).once.with(expected_prompts[0], grammar: expected_grammar, mode: :voice).and_return noinput_result
+          controller.should_receive(:ask).once.with(expected_prompts[1], grammar: expected_grammar, mode: :voice).and_return noinput_result
+          controller.should_receive(:say).once.with apology_announcement
+          controller.run
+        end
+      end
+    end
+
+    context 'when specifying a timeout for the menu' do
+      let(:expected_timeout) { 27 }
       let(:controller_class) do
+        expected_prompts = self.expected_prompts
+        apology_announcement = self.apology_announcement
+        expected_timeout = self.expected_timeout
+
         Class.new(Adhearsion::IVRController) do
-          prompts << "Hello"
+          expected_prompts.each do |prompt|
+            prompts << prompt
+          end
+
+          timeout expected_timeout
+
+          on_complete do |result|
+            say "Let's go to #{result.utterance}"
+          end
+
+          on_failure do
+            say apology_announcement
+          end
 
           def grammar
             :some_grammar
@@ -392,19 +530,62 @@ describe Adhearsion::IVRController do
         end
       end
 
-      it "should simply return the last result" do
-        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
-        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
-        controller.should_receive(:ask).once.with('Hello', grammar: expected_grammar, mode: :voice).and_return noinput_result
-        controller.run.should be(noinput_result)
+      it 'passes the correct timeout value to the #ask method' do
+        controller.should_receive(:ask).once.with(expected_prompts[0], grammar: expected_grammar, mode: :voice, timeout: expected_timeout).and_return match_result
+        controller.should_receive(:say).once.with "Let's go to Paris"
+        controller.run
       end
     end
 
-    context "when the call is dead" do
-      before { call.terminate }
+    context 'when specifying a renderer for the menu' do
+      let(:expected_renderer) { :some_renderer }
+      let(:controller_class) do
+        expected_prompts = self.expected_prompts
+        apology_announcement = self.apology_announcement
+        expected_renderer = self.expected_renderer
 
-      it "executing the controller should raise Adhearsion::Call::Hangup" do
-        expect { subject.run }.to raise_error Adhearsion::Call::Hangup
+        Class.new(Adhearsion::IVRController) do
+          expected_prompts.each do |prompt|
+            prompts << prompt
+          end
+
+          renderer expected_renderer
+
+          on_complete do |result|
+            say "Let's go to #{result.utterance}"
+          end
+
+          on_failure do
+            say apology_announcement
+          end
+
+          def grammar
+            :some_grammar
+          end
+        end
+      end
+
+      it 'passes the correct renderer value to the #ask method' do
+        controller.should_receive(:ask).once.with(expected_prompts[0], grammar: expected_grammar, mode: :voice, output_options: { renderer: expected_renderer }).and_return match_result
+        controller.should_receive(:say).once.with "Let's go to Paris"
+        controller.run
+      end
+    end
+
+    context 'when overriding the class method for prompt_timeout' do
+      let(:overridden_timeout) { 29 }
+
+      before do
+        overridden_timeout = self.overridden_timeout
+        controller_class.send :define_method, :timeout do
+          overridden_timeout
+        end
+      end
+
+      it 'passes the correct timeout value to the #ask method' do
+        controller.should_receive(:ask).once.with(expected_prompts[0], grammar: expected_grammar, mode: :voice, timeout: overridden_timeout).and_return match_result
+        controller.should_receive(:say).once.with "Let's go to Paris"
+        controller.run
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-ivr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Klang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: IVR building blocks for Adhearsion applications