punchblock 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8dddb3e5a8b1158136add6d851f6f40fbe94438
-  data.tar.gz: ff999c1ed2536e739167e74ab6d9ac96c188f0e9
+  metadata.gz: 8497250485b747e066b5df34ae25d12b6773e884
+  data.tar.gz: 833a6638459f513c128d0765cc9ed39668216218
 SHA512:
-  metadata.gz: 8817401f7029230cc46119a8fabe2a525b72c0af9375eb09127dfbbf8855617ac1a553b2fca2699accec6311df9d9bb378a6dff5322a9df0b26e6a994d2f66fb
-  data.tar.gz: 43668278a0c3943259fbbc75f4b0704e6cc617d41fb2f405b3b0fac1d6aa8093ea78bbf24a8c868b55b3ccced90da00648af8d3b5a18163cecb074dd1b845510
+  metadata.gz: 91fc99d918b5b81045adff0aac91b924abe2874c1777ffd40c452f8a71dd5c88392b1b46d9987dbfa5ba7238f86f3860072c811b962ebda478b810006679783c
+  data.tar.gz: baff387cd63774ab1aefecc86055d816de003b9e4bf216488ecaced37a296f18315bf3e9c4d8682f02475d7ea77e45d4b5fc62701ed29f4e029e94f7b38b1b10

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v2.1.0](https://github.com/adhearsion/punchblock/compare/v2.0.2...v2.1.0) - [2013-11-12](https://rubygems.org/gems/punchblock/versions/2.1.0)
+  * Feature: Support RubySpeech builtin grammars on Asterisk and FreeSWITCH
+  * Update: Update to stable release of Virtus
+
 # [v2.0.2](https://github.com/adhearsion/punchblock/compare/v2.0.1...v2.0.2) - [2013-10-17](https://rubygems.org/gems/punchblock/versions/2.0.2)
   * Bugfix: Reject commands against components which have finished on Asterisk, and garbage collect them
   * Bugfix: Register/lookup components by their full URI rather than component ID since the component ID may only be unique per call

data/lib/punchblock/rayo_node.rb

@@ -5,7 +5,7 @@ require 'virtus'
 
 module Punchblock
   class RayoNode
-    include Virtus
+    include Virtus.model
 
     @@registrations = {}
 
@@ -79,10 +79,6 @@ module Punchblock
       o.is_a?(self.class) && self.to_hash == o.to_hash
     end
 
-    def to_hash
-      get_attributes(&:public_reader?)
-    end
-
     ##
     # @return [RayoNode] the original command issued that lead to this event
     #

data/lib/punchblock/translator/dtmf_recognizer.rb

@@ -3,6 +3,26 @@
 module Punchblock
   module Translator
     class DTMFRecognizer
+      class BuiltinMatcherCache
+        include Singleton
+        include MonitorMixin
+
+        def get(uri)
+          cache[uri] ||= fetch(uri)
+        end
+
+        private
+
+        def fetch(uri)
+          grammar = RubySpeech::GRXML.from_uri(uri)
+          RubySpeech::GRXML::Matcher.new(grammar)
+        end
+
+        def cache
+          @cache ||= {}
+        end
+      end
+
       def initialize(responder, grammar, initial_timeout = nil, inter_digit_timeout = nil, terminator = nil)
         @responder = responder
         self.initial_timeout = initial_timeout || -1
@@ -10,7 +30,11 @@ module Punchblock
         @terminator = terminator
         @finished = false
 
-        @matcher = RubySpeech::GRXML::Matcher.new RubySpeech::GRXML.import(grammar.to_s)
+        @matcher = if grammar.url
+          BuiltinMatcherCache.instance.get(grammar.url)
+        else
+          RubySpeech::GRXML::Matcher.new RubySpeech::GRXML.import(grammar.value.to_s)
+        end
         @buffer = ""
       end
 

data/lib/punchblock/translator/input_component.rb

@@ -8,7 +8,7 @@ module Punchblock
         setup_dtmf_recognizer
         send_ref
         start_timers
-      rescue OptionError => e
+      rescue OptionError, ArgumentError => e
         with_error 'option error', e.message
       end
 
@@ -52,7 +52,7 @@ module Punchblock
 
       def setup_dtmf_recognizer
         @recognizer = DTMFRecognizer.new self,
-                        input_node.grammars.first.value,
+                        input_node.grammars.first,
                         (input_node.initial_timeout || -1),
                         (input_node.inter_digit_timeout || -1),
                         input_node.terminator

data/lib/punchblock/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Punchblock
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/punchblock.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<celluloid>, ["~> 0.14"]
   s.add_runtime_dependency %q<ruby_ami>, ["~> 2.0"]
   s.add_runtime_dependency %q<ruby_fs>, ["~> 1.1"]
-  s.add_runtime_dependency %q<ruby_speech>, ["~> 2.0"]
-  s.add_runtime_dependency %q<virtus>, ["~> 0.5"]
+  s.add_runtime_dependency %q<ruby_speech>, ["~> 2.3"]
+  s.add_runtime_dependency %q<virtus>, ["~> 1.0"]
   s.add_runtime_dependency %q<ruby_jid>, ["~> 1.0"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]

data/spec/punchblock/translator/asterisk/component/input_spec.rb

@@ -127,6 +127,60 @@ module Punchblock
                 end
               end
 
+              context 'with a builtin grammar' do
+                let(:original_command_opts) { { grammar: { url: 'builtin:dtmf/boolean' } } }
+
+                before do
+                  subject.execute
+                  expected_event
+                  send_ami_events_for_dtmf 1
+                end
+
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "true"
+                      input "1", mode: :dtmf
+                    end
+                  end
+                end
+
+                let :expected_event do
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                end
+
+                it "should use RubySpeech builtin grammar" do
+                  reason.should be == expected_event
+                end
+              end
+
+              context 'with a parameterized builtin grammar' do
+                let(:original_command_opts) { { grammar: { url: 'builtin:dtmf/boolean?n=3;y=4' } } }
+
+                before do
+                  subject.execute
+                  expected_event
+                  send_ami_events_for_dtmf 4
+                end
+
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "true"
+                      input "4", mode: :dtmf
+                    end
+                  end
+                end
+
+                let :expected_event do
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                end
+
+                it "should use RubySpeech builtin grammar" do
+                  reason.should be == expected_event
+                end
+              end
+
               context 'with multiple grammars' do
                 let(:original_command_opts) { { :grammars => [{:value => grammar}, {:value => grammar}] } }
                 it "should return an error and not execute any actions" do

data/spec/punchblock/translator/freeswitch/component/input_spec.rb

@@ -123,6 +123,70 @@ module Punchblock
                 end
               end
 
+              context 'with a builtin grammar' do
+                let(:original_command_opts) { { grammar: { url: 'builtin:dtmf/boolean' } } }
+
+                before do
+                  subject.execute
+                  expected_event
+                  send_dtmf 1
+                end
+
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "true"
+                      input "1", mode: :dtmf
+                    end
+                  end
+                end
+
+                let :expected_event do
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                end
+
+                it "should use RubySpeech builtin grammar" do
+                  reason.should be == expected_event
+                end
+              end
+
+              context 'with a parameterized builtin grammar' do
+                let(:original_command_opts) { { grammar: { url: 'builtin:dtmf/boolean?n=3;y=4' } } }
+
+                before do
+                  subject.execute
+                  expected_event
+                  send_dtmf 4
+                end
+
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "true"
+                      input "4", mode: :dtmf
+                    end
+                  end
+                end
+
+                let :expected_event do
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                end
+
+                it "should use RubySpeech builtin grammar" do
+                  reason.should be == expected_event
+                end
+              end
+
+              context 'with a bad builtin grammar name' do
+                let(:original_command_opts) { { grammar: { url: 'builtin:dtmf/foobar' } } }
+
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'foobar is an invalid builtin grammar'
+                  original_command.response(0.1).should be == error
+                end
+              end
+
               context 'with multiple grammars' do
                 let(:original_command_opts) { { :grammars => [{:value => grammar}, {:value => grammar}] } }
                 it "should return an error and not execute any actions" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Jason Goecke
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ruby_jid
   requirement: !ruby/object:Gem::Requirement