matrioska 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 733fe495bf17c9860210d440b027d00ee86cb79a
-  data.tar.gz: 9f6945be056f682b47edcedde4d1d78f17adce03
+  metadata.gz: 6ecbdde8b3c29cb0fab98b0d5119057ffea090f2
+  data.tar.gz: 04c8aa768b6407c3e863aee68c7b1a12dbb533cb
 SHA512:
-  metadata.gz: 6ec8e9cf5a602512e90fbfe0be8c4bfb36f885948ac77cbc960c0838c9b062f04db6fe0c0279e7c75bcfcc4a58d99441316d7650d469466620b67c17ade38180
-  data.tar.gz: 6ed1d738cab01ccadff21619a3578ae5c8915351128b702dc6081090707f124bc4b54d5c0993c8a90f94f0eff8b797b8ad8cdc72d26121e1d4a171dbdc9d5b3e
+  metadata.gz: 45f4f78f0ff041f95ffae346f8c52dbba8ab9f4e29f538cf2ee8dfe4cbd8d5ee87a09c3783d31d5ea3adcb7d729a16f4acb8e6d3eb933889f44d37c49f2d62f8
+  data.tar.gz: f24ba4a1137df7f0695e4c87ddbb5159967e868dde1b347339b47220b794dab7e3184b7e257aa03d7207cd709a90a6ca9db23275b63e56c94f7742cec353fc3e

data/.travis.yml

@@ -3,6 +3,8 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.2.0
   - jruby-19mode
   - rbx-19mode
   - ruby-head

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-# develop
+# Version 0.3.0
+  * Feature: added multi-digit patterns
+  * Feature: added inter-digit timeout to support multi-digit patterns
 
 # Version 0.2.1
   * Don't require manual loading of `DialWithApps`

data/lib/matrioska.rb

@@ -3,3 +3,4 @@ require "matrioska/version"
 require "matrioska/plugin"
 require "matrioska/app_runner"
 require "matrioska/dial_with_apps"
+require "matrioska/core_ext/adhearsion_call"

data/lib/matrioska/app_runner.rb

@@ -2,28 +2,36 @@ module Matrioska
   class AppRunner
     include Adhearsion::CallController::Utility
 
+    VALID_DIGITS = /[^0-9*#]/
+
     def initialize(call)
       @call = call
+      register_runner_with_call
       @app_map = {}
-      @running = false
     end
 
     def start
+      if started? && running?
+        logger.warn "Already-active runner #{self} received start event."
+        return
+      end
+
       @state = :started
-      logger.debug "MATRIOSKA START CALLED"
-      unless @running
-        @component = Punchblock::Component::Input.new mode: :dtmf, grammar: { value: grammar_accept }
-        logger.debug "MATRIOSKA STARTING LISTENER"
-        @component.register_event_handler Punchblock::Event::Complete do |event|
-          handle_input_complete event
-        end
-        @call.write_and_await_response @component if @call.active?
+      logger.debug "MATRIOSKA STARTING LISTENER"
+      @component = Punchblock::Component::Input.new mode: :dtmf, inter_digit_timeout: Adhearsion.config[:matrioska].timeout * 1_000, grammar: { value: build_grammar }
+      @component.register_event_handler Punchblock::Event::Complete do |event|
+        handle_input_complete event
       end
+      @call.write_and_await_response @component if @call.alive? && @call.active?
     end
 
     def stop!
       @state = :stopped
-      @component.stop! if @component && @component.executing?
+      @component.stop! if running?
+    end
+
+    def running?
+      !!(@component && @component.executing?)
     end
 
     def status
@@ -38,12 +46,12 @@ module Matrioska
       @state == :stopped
     end
 
-    def map_app(digit, controller = nil, &block)
-      digit = digit.to_s
+    def map_app(pattern, controller = nil, &block)
+      pattern = pattern.to_s
       range = "1234567890*#"
 
-      unless range.include?(digit) && digit.size == 1
-        raise ArgumentError, "The first argument should be a single digit String or number in the range 1234567890*#"
+      if VALID_DIGITS.match(pattern)
+        raise ArgumentError, "The first argument should be a String or number containing only 1234567890*#"
       end
 
       payload = if block_given?
@@ -54,18 +62,18 @@ module Matrioska
         controller
       end
 
-      @app_map[digit] = payload
+      @app_map[pattern] = payload
     end
 
     def handle_input_complete(event)
       if @state == :stopped
-        logger.warn "Stopped runner #{self} received event."
+        logger.warn "Stopped runner #{self} received stop event."
         return
       end
       logger.debug "MATRIOSKA HANDLING INPUT"
       result = event.reason.respond_to?(:utterance) ? event.reason.utterance : nil
       digit = parse_dtmf result
-      match_and_run digit unless @running
+      match_and_run digit
     end
 
     private
@@ -77,12 +85,11 @@ module Matrioska
     def match_and_run(digit)
       if match = @app_map[digit]
         logger.debug "MATRIOSKA #match_and_run called with #{digit}"
-        @running = true
         callback = lambda do |call|
           @running = false
-          logger.debug "MATRIOSKA CALLBACK RESTARTING LISTENER"
-          if call.active?
-            start unless stopped?
+          if call.alive? && call.active? && started?
+            logger.debug "MATRIOSKA CALLBACK RESTARTING LISTENER"
+            start
           else
             logger.debug "MATRIOSKA CALLBACK NOT DOING ANYTHING BECAUSE CALL IS DEAD"
           end
@@ -104,5 +111,26 @@ module Matrioska
     rescue Adhearsion::Call::Hangup
       logger.debug "Matrioska terminated because the call was disconnected"
     end
+
+    def build_grammar
+      current_app_map = app_map
+      RubySpeech::GRXML.draw mode: :dtmf, root: 'options' do
+        rule id: 'options', scope: 'public' do
+          one_of do
+            current_app_map.keys.each do |index|
+              item do
+                index
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def register_runner_with_call
+      @call[:matrioska_runners] ||= []
+      @call[:matrioska_runners] << self
+    end
+
   end
 end

data/lib/matrioska/core_ext/adhearsion_call.rb

@@ -0,0 +1,15 @@
+require 'adhearsion'
+
+class Adhearsion::Call
+  def stop_all_runners!
+    return unless variables[:matrioska_runners]
+
+    variables[:matrioska_runners].each do |runner|
+      runner.stop!
+    end
+  end
+
+  def runners
+    Array(variables[:matrioska_runners])
+  end
+end

data/lib/matrioska/dial_with_apps.rb

@@ -38,15 +38,19 @@ module Matrioska
       dial = Adhearsion::CallController::Dial::ParallelConfirmationDial.new to, options, call
       yield dial
 
-      local_runner = Matrioska::AppRunner.new call
-      @local_runner_block.call local_runner
-      local_runner.start
+      if @local_runner_block
+        local_runner = Matrioska::AppRunner.new call
+        @local_runner_block.call local_runner
+        local_runner.start
+      end
 
       dial.prep_calls do |new_call|
         new_call.on_joined call do
-          remote_runner = Matrioska::AppRunner.new new_call
-          @remote_runner_block.call remote_runner
-          remote_runner.start
+          if @remote_runner_block
+            remote_runner = Matrioska::AppRunner.new new_call
+            @remote_runner_block.call remote_runner
+            remote_runner.start
+          end
         end
       end
 

data/lib/matrioska/plugin.rb

@@ -8,5 +8,9 @@ module Matrioska
         end
       end
     end
+
+    config :matrioska do
+      timeout 2, desc: "Time (in seconds) to wait between each digit before trying to resolve match", transform: Proc.new { |v| v.to_i }
+    end
   end
 end

data/lib/matrioska/version.rb

@@ -1,3 +1,3 @@
 module Matrioska
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/matrioska.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Matrioska::VERSION
   s.authors     = ["Luca Pradovera"]
   s.email       = ["lpradovera@mojolingo.com"]
-  s.homepage    = "https://github.com/polysics/matrioska"
+  s.homepage    = "https://github.com/adhearsion/matrioska"
   s.summary     = %q{Adhearsion plugin for in-call apps}
   s.description = %q{Adhearsion plugin for in-call apps. Provides a features-style interface to run applications in calls.}
   s.license     = 'MIT'

data/spec/matrioska/app_runner_spec.rb

@@ -18,20 +18,24 @@ module Matrioska
     end
 
     describe "#start" do
+      before do
+        subject.map_app("34*") { call.do_stuff_from_a_block }
+        subject.map_app(5, MockController)
+      end
+
       let(:grxml) {
-        RubySpeech::GRXML.draw mode: 'dtmf', root: 'inputdigits' do
-          rule id: 'inputdigits', scope: 'public' do
+        RubySpeech::GRXML.draw mode: :dtmf, root: 'options' do
+          rule id: 'options', scope: 'public' do
             one_of do
-              0.upto(9) { |d| item { d.to_s } }
-              item { "#" }
-              item { "*" }
+              item { "34*" }
+              item { "5" }
             end
           end
         end
       }
 
       let(:input_component) {
-        Punchblock::Component::Input.new mode: :dtmf, grammar: { value: grxml }
+        Punchblock::Component::Input.new mode: :dtmf, inter_digit_timeout: Adhearsion.config[:matrioska].timeout.to_i * 1_000, grammar: { value: grxml }
       }
 
       it "should start the appropriate component" do
@@ -39,6 +43,14 @@ module Matrioska
         subject.start
         subject.status.should == :started
       end
+
+      it "should do nothing if #start is called twice" do
+        call.should_receive(:write_and_await_response).once.with(input_component)
+        subject.should_receive(:running?).once.and_return(true)
+        subject.start
+        subject.start
+      end
+
     end
 
     describe "#stop!" do
@@ -60,12 +72,15 @@ module Matrioska
 
     describe "#map_app" do
       context "with invalid input" do
-        let(:too_long) { "ab" }
-        let(:wrong) { "a" }
+        let(:long_pattern) { "*99" }
+        let(:wrong) { "a12" }
+
+        it "should raise if the first argument has invalid characters" do
+          expect { subject.map_app(wrong) {} }.to raise_error ArgumentError, "The first argument should be a String or number containing only 1234567890*#"
+        end
 
-        it "should raise if the first argument is not a single digit string in the range" do
-          expect { subject.map_app(too_long) {} }.to raise_error ArgumentError, "The first argument should be a single digit String or number in the range 1234567890*#"
-          expect { subject.map_app(wrong) {} }.to raise_error ArgumentError, "The first argument should be a single digit String or number in the range 1234567890*#"
+        it "should not raise if the first argument has multiple valid digits" do
+          expect { subject.map_app(long_pattern) {} }.to_not raise_error
         end
 
         it "raises if called without either a class or a block" do
@@ -84,7 +99,7 @@ module Matrioska
       end
 
       before do
-        subject.map_app(3) { call.do_stuff_from_a_block }
+        subject.map_app("34*") { call.do_stuff_from_a_block }
         subject.map_app(5, MockController)
       end
 
@@ -106,13 +121,15 @@ module Matrioska
 
       it "executes the block if the payload is a Proc" do
         call.should_receive(:do_stuff_from_a_block).once
+        subject.should_receive(:started?).and_return true
         subject.should_receive(:start).once
-        subject.handle_input_complete mock_event("3")
+        subject.handle_input_complete mock_event("34*")
         sleep 0.1 # Give the controller time to finish and the callback to fire
       end
 
       it "executes the controller if the payload is a Class" do
         call.should_receive(:do_stuff_from_a_class).once
+        subject.should_receive(:started?).and_return true
         subject.should_receive(:start).once
         subject.handle_input_complete mock_event("5")
         sleep 0.1 # Give the controller time to finish and the callback to fire

data/spec/matrioska/core_ext/adhearsion_call_spec.rb

@@ -0,0 +1,26 @@
+require 'adhearsion'
+require 'matrioska'
+
+describe Adhearsion::Call do
+  let(:call) { Adhearsion::Call.new }
+
+
+  it 'should track all runners launched with it' do
+    runner = Matrioska::AppRunner.new call
+    call.runners.should include(runner)
+  end
+
+  it 'should be possible to stop all runners on a call' do
+    r1 = Matrioska::AppRunner.new call
+    r2 = Matrioska::AppRunner.new call
+    r3 = Matrioska::AppRunner.new call
+
+    r1.should_receive(:stop!).once
+    r2.should_receive(:stop!).once
+    r3.should_receive(:stop!).once
+
+    call.stop_all_runners!
+  end
+
+
+end

data/spec/matrioska/dial_with_apps_spec.rb

@@ -143,5 +143,75 @@ describe Matrioska::DialWithApps do
       second_other_mock_call << mock_end
       dial_thread.join.should be_true
     end
+
+    it "allows specifying only a local listener" do
+      call.should_receive(:answer).once
+
+      mock_local_runner.should_receive(:bar).once
+      mock_local_runner.should_receive(:start).once
+
+      mock_remote_runner = nil
+
+      other_mock_call.should_receive(:dial).with(to, from: 'foo').once
+      other_mock_call.should_receive(:hangup).once.and_return do
+        other_mock_call << mock_end
+      end
+
+      second_other_mock_call.should_receive(:dial).with(second_to, from: 'foo').once
+      second_other_mock_call.should_receive(:join).once.and_return do
+        second_other_mock_call << Punchblock::Event::Joined.new(call_uri: call_id)
+      end
+
+      dial_thread = Thread.new do
+        controller.instance_exec(to,second_to) do |to, second_to|
+            dial_with_apps([to, second_to], from: 'foo') do |dial|
+
+            local do |runner|
+              runner.bar
+            end
+          end
+        end
+      end
+
+      sleep 0.1
+      second_other_mock_call << mock_answered
+      second_other_mock_call << mock_end
+      dial_thread.join.should be_true
+    end
+
+    it "allows specifying only a remote listener" do
+      call.should_receive(:answer).once
+
+      mock_local_runner = nil
+
+      mock_remote_runner.should_receive(:bar).once
+      mock_remote_runner.should_receive(:start).once
+
+      other_mock_call.should_receive(:dial).with(to, from: 'foo').once
+      other_mock_call.should_receive(:hangup).once.and_return do
+        other_mock_call << mock_end
+      end
+
+      second_other_mock_call.should_receive(:dial).with(second_to, from: 'foo').once
+      second_other_mock_call.should_receive(:join).once.and_return do
+        second_other_mock_call << Punchblock::Event::Joined.new(call_uri: call_id)
+      end
+
+      dial_thread = Thread.new do
+        controller.instance_exec(to,second_to) do |to, second_to|
+            dial_with_apps([to, second_to], from: 'foo') do |dial|
+
+            remote do |runner|
+              runner.bar
+            end
+          end
+        end
+      end
+
+      sleep 0.1
+      second_other_mock_call << mock_answered
+      second_other_mock_call << mock_end
+      dial_thread.join.should be_true
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,4 +11,9 @@ RSpec.configure do |config|
   config.before :suite do
     Adhearsion::Logging.start Adhearsion::Logging.default_appenders, :trace, Adhearsion.config.platform.logging.formatter
   end
+
+  config.before do
+    @uuid = SecureRandom.uuid
+    Punchblock.stub new_request_id: @uuid
+  end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: matrioska
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Pradovera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Adhearsion plugin for in-call apps. Provides a features-style interface
@@ -88,9 +88,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -99,14 +99,16 @@ files:
 - Rakefile
 - lib/matrioska.rb
 - lib/matrioska/app_runner.rb
+- lib/matrioska/core_ext/adhearsion_call.rb
 - lib/matrioska/dial_with_apps.rb
 - lib/matrioska/plugin.rb
 - lib/matrioska/version.rb
 - matrioska.gemspec
 - spec/matrioska/app_runner_spec.rb
+- spec/matrioska/core_ext/adhearsion_call_spec.rb
 - spec/matrioska/dial_with_apps_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/polysics/matrioska
+homepage: https://github.com/adhearsion/matrioska
 licenses:
 - MIT
 metadata: {}
@@ -116,21 +118,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: matrioska
-rubygems_version: 2.0.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Adhearsion plugin for in-call apps
 test_files:
 - spec/matrioska/app_runner_spec.rb
+- spec/matrioska/core_ext/adhearsion_call_spec.rb
 - spec/matrioska/dial_with_apps_spec.rb
 - spec/spec_helper.rb