adhearsion-asr 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca0404794461dacc1ea767edf9c7a73ce39037e7
-  data.tar.gz: f8e0d64f713d2ac76a4aa4a88bb8b1a8f331f119
+  metadata.gz: 10b4c378b6fbc550f7d36f9ab5e0ea0cecd4ec60
+  data.tar.gz: 1ce64eaa9708e12f12125eb61dffe121f3d30e07
 SHA512:
-  metadata.gz: 15ee7ed592699c1b0790cb87b5265477eb0db3f60e82ca7223ba933a747e7cfdb6c8afe1f472873a56222266ad50e74a9f1631a4f2a7be4ea71ed4a3bbc12a4a
-  data.tar.gz: 77799f2386d1743d73837d49ab6f5cd4675018d84621f72b5c21edab5eec599633221b21233ef61b36b826b8e05d3a2c679a36ed7eec04623162bd97cc27fa25
+  metadata.gz: 7114b62fe3145dc74cd001c9b7f16e00cc8b8c2415644560393b85f230520c3a78396af63e91cbecf0177fc23ecc486b2c1294efe90be4dbd1db3b6797d39788
+  data.tar.gz: 46787dc004e45f9f089359d8d9db690cb6b53a8ab18edae9dca5438cfcdca5c5a601c52a1ff601ba1490b7f120be2a94c4020f4d5bcf3ed57ede1ec8b2546706

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/adhearsion-asr)
 
+# [v1.4.0](https://github.com/adhearsion/adhearsion-asr/compare/1.3.0...1.4.0) - [2015-06-15](https://rubygems.org/gems/adhearsion-asr/versions/1.4.0)
+  * Feature: Added support for passing a custom render_document to #ask
+  * Feature: Permit specifying a separate inter-digit timeout with a more useful default
+
 # [v1.3.0](https://github.com/adhearsion/adhearsion-asr/compare/1.2.0...1.3.0) - [2015-04-24](https://rubygems.org/gems/adhearsion-asr/versions/1.3.0)
   * Bugfix: Correctly handle nil prompts
   * Feature: Allow disabling timeouts with -1

data/adhearsion_asr.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<ruby_speech>, ["~> 2.1"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]
-  s.add_development_dependency %q<rspec>, ["~> 2.5"]
+  s.add_development_dependency %q<rspec>, ["~> 3.0"]
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<guard-rspec>
   s.add_development_dependency %q<rb-fsevent>, ['~> 0.9']

data/lib/adhearsion-asr/plugin.rb

@@ -4,6 +4,7 @@ module AdhearsionASR
       auto_include true, transform: Proc.new { |v| v == 'true' }, desc: "Enable or disable auto inclusion of overridden Adhearsion Core methods in all call controllers."
       min_confidence 0.5, desc: 'The default minimum confidence level used for all recognizer invocations.', transform: Proc.new { |v| v.to_f }
       timeout 5, desc: 'The default timeout (in seconds) used for all recognizer invocations.', transform: Proc.new { |v| v.to_i }
+      inter_digit_timeout 2, desc: 'The timeout used between DTMF digits and to terminate partial invocations', transform: Proc.new { |v| v.to_i }
       recognizer nil, desc: 'The default recognizer used for all input. Set nil to use platform default.'
       input_language 'en-US', desc: 'The default language set on generated grammars. Set nil to use platform default.'
     end

data/lib/adhearsion-asr/prompt_builder.rb

@@ -6,7 +6,7 @@ module AdhearsionASR
       input_options = {
         mode: options[:mode] || :dtmf,
         initial_timeout: timeout(options[:timeout] || Plugin.config.timeout),
-        inter_digit_timeout: timeout(options[:timeout] || Plugin.config.timeout),
+        inter_digit_timeout: timeout(options[:inter_digit_timeout] || Plugin.config.inter_digit_timeout),
         max_silence: timeout(options[:timeout] || Plugin.config.timeout),
         min_confidence: Plugin.config.min_confidence,
         grammars: grammars,
@@ -15,9 +15,9 @@ module AdhearsionASR
         terminator: options[:terminator]
       }.merge(options[:input_options] || {})
 
-      @prompt = if output_document
+      @prompt = if output_document || options[:render_document]
         output_options = {
-          render_document: {value: output_document},
+          render_document: options[:render_document] || {value: output_document},
           renderer: Adhearsion.config.platform.media.default_renderer,
           voice: Adhearsion.config.platform.media.default_voice
         }.merge(options[:output_options] || {})

data/lib/adhearsion-asr/version.rb

@@ -1,3 +1,3 @@
 module AdhearsionASR
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/adhearsion-asr/controller_methods_spec.rb

@@ -18,7 +18,7 @@ module AdhearsionASR
       end
 
       def expect_component_execution(component, fail = false)
-        expectation = controller.should_receive(:execute_component_and_await_completion).ordered.with(component)
+        expectation = expect(controller).to receive(:execute_component_and_await_completion).ordered.with(component)
         if fail
           expectation.and_raise fail
         else
@@ -61,7 +61,7 @@ module AdhearsionASR
         {
           mode: :dtmf,
           initial_timeout: 5000,
-          inter_digit_timeout: 5000,
+          inter_digit_timeout: 2000,
           max_silence: 5000,
           min_confidence: 0.5,
           recognizer: nil,
@@ -78,7 +78,7 @@ module AdhearsionASR
 
       let(:reason) { Punchblock::Component::Input::Complete::NoMatch.new }
 
-      before { Punchblock::Component::Prompt.any_instance.stub complete_event: double(reason: reason) }
+      before { allow_any_instance_of(Punchblock::Component::Prompt).to receive(:complete_event).and_return(double(reason: reason)) }
 
       describe "#ask" do
         let :digit_limit_grammar do
@@ -121,15 +121,30 @@ module AdhearsionASR
 
           context "with no prompts" do
             it "executes an Input component with the correct grammar" do
-              Punchblock::Component::Input.any_instance.stub complete_event: double(reason: reason)
+              allow_any_instance_of(Punchblock::Component::Input).to receive(:complete_event).and_return(double(reason: reason))
               expect_component_execution Punchblock::Component::Input.new(expected_input_options)
               subject.ask limit: 5
             end
           end
 
+          context "with no prompts, but with a render_document option" do
+            let :expected_output_options do
+              {
+                render_document: {url: 'http://foo.com/bar'},
+                renderer: nil
+              }
+            end
+
+            it "executes an Input component with the correct grammar" do
+              allow_any_instance_of(Punchblock::Component::Input).to receive(:complete_event).and_return(double(reason: reason))
+              expect_component_execution expected_prompt
+              subject.ask limit: 5, render_document: {url: 'http://foo.com/bar'}
+            end
+          end
+
           context "with only nil prompts" do
             it "executes an Input component with the correct grammar" do
-              Punchblock::Component::Input.any_instance.stub complete_event: double(reason: reason)
+              allow_any_instance_of(Punchblock::Component::Input).to receive(:complete_event).and_return(double(reason: reason))
               expect_component_execution Punchblock::Component::Input.new(expected_input_options)
               subject.ask nil, limit: 5
             end
@@ -138,9 +153,9 @@ module AdhearsionASR
           context "with a block passed" do
             it "executes but logs a warning about the block validator" do
               expect_component_execution expected_prompt
-              call.logger.should_receive(:warn).with(/validator/)
+              expect(call.logger).to receive(:warn).with(/validator/)
               target = double
-              target.should_receive(:foo).never
+              expect(target).to receive(:foo).never
 
               subject.ask prompts, limit: 5 do |buffer|
                 target.foo
@@ -306,7 +321,7 @@ module AdhearsionASR
 
           before do
             expected_input_options.merge! initial_timeout: 10000,
-              inter_digit_timeout: 10000,
+              inter_digit_timeout: 2000,
               max_silence: 10000
           end
 
@@ -329,7 +344,7 @@ module AdhearsionASR
           it "executes a Prompt with correct timeout (initial, inter-digit & max-silence)" do
             expect_component_execution expected_prompt
 
-            subject.ask prompts, limit: 5, timeout: -1
+            subject.ask prompts, limit: 5, timeout: -1, inter_digit_timeout: -1
           end
         end
 
@@ -338,7 +353,7 @@ module AdhearsionASR
 
           before do
             expected_input_options.merge! initial_timeout: 10000,
-              inter_digit_timeout: 10000,
+              inter_digit_timeout: 2000,
               max_silence: 10000
           end
 
@@ -492,13 +507,13 @@ module AdhearsionASR
             let(:reason) { Punchblock::Component::Input::Complete::Match.new nlsml: nlsml }
 
             it "returns :match status and the utterance" do
-              result.status.should be :match
-              result.should be_match
-              result.mode.should be :dtmf
-              result.confidence.should == 1
-              result.utterance.should == '123'
-              result.interpretation.should == 'Foo'
-              result.nlsml.should == nlsml
+              expect(result.status).to be :match
+              expect(result).to be_match
+              expect(result.mode).to be :dtmf
+              expect(result.confidence).to eq(1)
+              expect(result.utterance).to eq('123')
+              expect(result.interpretation).to eq('Foo')
+              expect(result.nlsml).to eq(nlsml)
             end
 
             context "with speech input" do
@@ -506,7 +521,7 @@ module AdhearsionASR
               let(:utterance) { 'Hello world' }
 
               it "should not alter the utterance" do
-                result.utterance.should == 'Hello world'
+                expect(result.utterance).to eq('Hello world')
               end
             end
 
@@ -515,7 +530,7 @@ module AdhearsionASR
                 let(:utterance) { 'dtmf-3' }
 
                 it "removes dtmf- previxes" do
-                  result.utterance.should be == '3'
+                  expect(result.utterance).to eq('3')
                 end
               end
 
@@ -523,7 +538,7 @@ module AdhearsionASR
                 let(:utterance) { "dtmf-star" }
 
                 it "interprets as *" do
-                  result.utterance.should be == '*'
+                  expect(result.utterance).to eq('*')
                 end
               end
 
@@ -531,7 +546,7 @@ module AdhearsionASR
                 let(:utterance) { '*' }
 
                 it "interprets as *" do
-                  result.utterance.should be == '*'
+                  expect(result.utterance).to eq('*')
                 end
               end
 
@@ -539,7 +554,7 @@ module AdhearsionASR
                 let(:utterance) { 'dtmf-pound' }
 
                 it "interprets pound as #" do
-                  result.utterance.should be == '#'
+                  expect(result.utterance).to eq('#')
                 end
               end
 
@@ -547,7 +562,7 @@ module AdhearsionASR
                 let(:utterance) { '#' }
 
                 it "interprets # as #" do
-                  result.utterance.should be == '#'
+                  expect(result.utterance).to eq('#')
                 end
               end
 
@@ -555,7 +570,7 @@ module AdhearsionASR
                 let(:utterance) { '1' }
 
                 it "correctly interprets the digits" do
-                  result.utterance.should be == '1'
+                  expect(result.utterance).to eq('1')
                 end
               end
 
@@ -563,7 +578,7 @@ module AdhearsionASR
                 let(:utterance) { nil }
 
                 it "is nil when utterance is nil" do
-                  result.utterance.should be == nil
+                  expect(result.utterance).to eq(nil)
                 end
               end
 
@@ -571,7 +586,7 @@ module AdhearsionASR
                 let(:utterance) { 'foo' }
 
                 it "returns the utterance" do
-                  result.response.should be == 'foo'
+                  expect(result.response).to eq('foo')
                 end
               end
             end
@@ -580,7 +595,7 @@ module AdhearsionASR
               let(:utterance) { '1 dtmf-5 dtmf-star # 2' }
 
               it "returns the digits without space separation" do
-                result.utterance.should be == '15*#2'
+                expect(result.utterance).to eq('15*#2')
               end
             end
           end
@@ -589,9 +604,9 @@ module AdhearsionASR
             let(:reason) { Punchblock::Component::Input::Complete::NoMatch.new }
 
             it "returns :nomatch status and a nil utterance" do
-              result.status.should eql(:nomatch)
-              result.should_not be_match
-              result.utterance.should be_nil
+              expect(result.status).to eql(:nomatch)
+              expect(result).not_to be_match
+              expect(result.utterance).to be_nil
             end
           end
 
@@ -599,9 +614,9 @@ module AdhearsionASR
             let(:reason) { Punchblock::Component::Input::Complete::NoInput.new }
 
             it "returns :noinput status and a nil utterance" do
-              result.status.should eql(:noinput)
-              result.should_not be_match
-              result.utterance.should be_nil
+              expect(result.status).to eql(:noinput)
+              expect(result).not_to be_match
+              expect(result.utterance).to be_nil
             end
           end
 
@@ -609,9 +624,9 @@ module AdhearsionASR
             let(:reason) { Punchblock::Event::Complete::Hangup.new }
 
             it "returns :hangup status and a nil utterance" do
-              result.status.should eql(:hangup)
-              result.should_not be_match
-              result.utterance.should be_nil
+              expect(result.status).to eql(:hangup)
+              expect(result).not_to be_match
+              expect(result.utterance).to be_nil
             end
           end
 
@@ -619,9 +634,9 @@ module AdhearsionASR
             let(:reason) { Punchblock::Event::Complete::Stop.new }
 
             it "returns :stop status and a nil utterance" do
-              result.status.should eql(:stop)
-              result.should_not be_match
-              result.utterance.should be_nil
+              expect(result.status).to eql(:stop)
+              expect(result).not_to be_match
+              expect(result.utterance).to be_nil
             end
           end
 
@@ -676,7 +691,7 @@ module AdhearsionASR
               doo = foo
               match(1) { do_nothing }
             end
-            doo.should == :bar
+            expect(doo).to eq(:bar)
           end
 
           context "with nil prompts" do
@@ -692,7 +707,7 @@ module AdhearsionASR
 
           context "with no prompts" do
             it "executes an Input component with the correct grammar" do
-              Punchblock::Component::Input.any_instance.stub complete_event: double(reason: reason)
+              allow_any_instance_of(Punchblock::Component::Input).to receive(:complete_event).and_return(double(reason: reason))
               expect_component_execution Punchblock::Component::Input.new(expected_input_options)
               subject.menu do
                 match(1) {}
@@ -702,7 +717,7 @@ module AdhearsionASR
 
           context "with only nil prompts" do
             it "executes an Input component with the correct grammar" do
-              Punchblock::Component::Input.any_instance.stub complete_event: double(reason: reason)
+              allow_any_instance_of(Punchblock::Component::Input).to receive(:complete_event).and_return(double(reason: reason))
               expect_component_execution Punchblock::Component::Input.new(expected_input_options)
               subject.menu nil do
                 match(1) {}
@@ -732,7 +747,7 @@ module AdhearsionASR
             it "executes a Prompt with correct timeout (initial, inter-digit & max-silence)" do
               expect_component_execution expected_prompt
 
-              subject.menu prompts, timeout: 10 do
+              subject.menu prompts, timeout: 10, inter_digit_timeout: 10 do
                 match(1) {}
               end
             end
@@ -746,6 +761,7 @@ module AdhearsionASR
             end
 
             temp_config_value :timeout, 10
+            temp_config_value :inter_digit_timeout, 10
 
             it "executes a Prompt with correct timeout (initial, inter-digit & max-silence)" do
               expect_component_execution expected_prompt
@@ -922,8 +938,8 @@ module AdhearsionASR
           context "when input doesn't match any of the specified matches" do
             it "runs the invalid and failure handlers" do
               expect_component_execution expected_prompt
-              should_receive(:do_something_on_invalid).once.ordered
-              should_receive(:do_something_on_failure).once.ordered
+              expect(self).to receive(:do_something_on_invalid).once.ordered
+              expect(self).to receive(:do_something_on_failure).once.ordered
 
               subject.menu prompts do
                 match(1) {}
@@ -949,12 +965,12 @@ module AdhearsionASR
                 some_controller_class = Class.new Adhearsion::CallController
 
                 expect_component_execution(expected_prompt).twice
-                should_receive(:do_something_on_invalid).once.ordered
-                should_receive(:invoke).once.with(some_controller_class, extension: '1').ordered
-                should_receive(:do_something_on_failure).never
+                expect(self).to receive(:do_something_on_invalid).once.ordered
+                expect(self).to receive(:invoke).once.with(some_controller_class, extension: '1').ordered
+                expect(self).to receive(:do_something_on_failure).never
 
                 invocation_count = 0
-                Punchblock::Component::Prompt.any_instance.stub(:complete_event) do
+                allow_any_instance_of(Punchblock::Component::Prompt).to receive(:complete_event) do
                   invocation_count += 1
                   case invocation_count
                   when 1 then double(reason: reason)
@@ -978,8 +994,8 @@ module AdhearsionASR
 
             it "runs the timeout and failure handlers" do
               expect_component_execution expected_prompt
-              should_receive(:do_something_on_timeout).once.ordered
-              should_receive(:do_something_on_failure).once.ordered
+              expect(self).to receive(:do_something_on_timeout).once.ordered
+              expect(self).to receive(:do_something_on_failure).once.ordered
 
               subject.menu prompts do
                 match(1) {}
@@ -1005,12 +1021,12 @@ module AdhearsionASR
                 some_controller_class = Class.new Adhearsion::CallController
 
                 expect_component_execution(expected_prompt).twice
-                should_receive(:do_something_on_timeout).once.ordered
-                should_receive(:invoke).once.with(some_controller_class, extension: '1').ordered
-                should_receive(:do_something_on_failure).never
+                expect(self).to receive(:do_something_on_timeout).once.ordered
+                expect(self).to receive(:invoke).once.with(some_controller_class, extension: '1').ordered
+                expect(self).to receive(:do_something_on_failure).never
 
                 invocation_count = 0
-                Punchblock::Component::Prompt.any_instance.stub(:complete_event) do
+                allow_any_instance_of(Punchblock::Component::Prompt).to receive(:complete_event) do
                   invocation_count += 1
                   case invocation_count
                   when 1 then double(reason: reason)
@@ -1069,7 +1085,7 @@ module AdhearsionASR
                 some_controller_class = Class.new Adhearsion::CallController
 
                 expect_component_execution expected_prompt
-                should_receive(:invoke).once.with(some_controller_class, extension: '3')
+                expect(self).to receive(:invoke).once.with(some_controller_class, extension: '3')
 
                 subject.menu prompts do
                   match(2) {}
@@ -1082,7 +1098,7 @@ module AdhearsionASR
             context "which specifies a block to be run" do
               it "invokes the block, passing in the input that matched" do
                 expect_component_execution expected_prompt
-                should_receive(:do_something_on_match).once.with('3')
+                expect(self).to receive(:do_something_on_match).once.with('3')
 
                 subject.menu prompts do
                   match(2) {}
@@ -1121,7 +1137,7 @@ module AdhearsionASR
 
               it "invokes the match payload" do
                 expect_component_execution expected_prompt
-                should_receive(:do_something_on_match).once.with('3')
+                expect(self).to receive(:do_something_on_match).once.with('3')
 
                 subject.menu prompts do
                   match(0) {}
@@ -1160,7 +1176,7 @@ module AdhearsionASR
 
               it "invokes the match payload" do
                 expect_component_execution expected_prompt
-                should_receive(:do_something_on_match).once.with('3')
+                expect(self).to receive(:do_something_on_match).once.with('3')
 
                 subject.menu prompts do
                   match(0) {}
@@ -1199,7 +1215,7 @@ module AdhearsionASR
 
               it "invokes the match payload" do
                 expect_component_execution expected_prompt
-                should_receive(:do_something_on_match).once.with('3')
+                expect(self).to receive(:do_something_on_match).once.with('3')
 
                 subject.menu prompts do
                   match(0) {}
@@ -1244,8 +1260,8 @@ module AdhearsionASR
 
             it "executes the first successful match" do
               expect_component_execution expected_prompt
-              should_receive(:do_something_on_match).once.with('1')
-              should_receive(:do_otherthing_on_match).never
+              expect(self).to receive(:do_something_on_match).once.with('1')
+              expect(self).to receive(:do_otherthing_on_match).never
 
               subject.menu prompts do
                 match(1) { |v| do_something_on_match v }

data/spec/spec_helper.rb

@@ -2,19 +2,19 @@ require 'adhearsion'
 require 'adhearsion-asr'
 
 RSpec.configure do |config|
-  config.color_enabled = true
+  config.color = true
   config.tty = true
 
   config.mock_with :rspec
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
 
-  config.backtrace_clean_patterns = [/rspec/]
+  config.backtrace_exclusion_patterns = [/rspec/]
 
   config.before do
     @current_datetime = DateTime.now
-    DateTime.stub now: @current_datetime
+    allow(DateTime).to receive(:now).and_return(@current_datetime)
 
-    Punchblock.stub new_request_id: 'foo'
+    allow(Punchblock).to receive(:new_request_id).and_return('foo')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-asr
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ben Langfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement