matrioska 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# develop
+
+# Version 0.0.1
+  * First official release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in plugin-template.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    matrioska (0.0.1)
+      activesupport (>= 3.0.10)
+      adhearsion (~> 2.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.10)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    adhearsion (2.2.0)
+      activesupport (~> 3.0)
+      adhearsion-loquacious (~> 1.9)
+      bundler (~> 1.0)
+      celluloid (~> 0.12, >= 0.12.1)
+      countdownlatch
+      deep_merge
+      ffi (~> 1.0)
+      future-resource (~> 1.0)
+      girl_friday
+      has-guarded-handlers (~> 1.5)
+      logging (~> 1.8)
+      pry
+      punchblock (~> 1.4)
+      rake
+      ruby_speech (~> 1.0)
+      thor
+    adhearsion-loquacious (1.9.3)
+    blather (0.8.2)
+      activesupport (>= 2.3.11)
+      eventmachine (>= 1.0.0)
+      girl_friday
+      niceogiri (~> 1.0)
+      nokogiri (~> 1.5, >= 1.5.6)
+    celluloid (0.12.4)
+      facter (>= 1.6.12)
+      timers (>= 1.0.0)
+    celluloid-io (0.12.1)
+      celluloid (~> 0.12.0)
+      nio4r (>= 0.4.0)
+    coderay (1.0.8)
+    connection_pool (0.9.3)
+    countdownlatch (1.0.0)
+    deep_merge (1.0.0)
+    diff-lcs (1.1.3)
+    eventmachine (1.0.0)
+    facter (1.6.17)
+    ffi (1.2.0)
+    future-resource (1.0.0)
+    girl_friday (0.11.1)
+      connection_pool (~> 0.9.0)
+      rubinius-actor
+    guard (1.5.0)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.1.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    has-guarded-handlers (1.5.0)
+    i18n (0.6.1)
+    json (1.7.5)
+    listen (0.5.3)
+    little-plugger (1.1.3)
+    logging (1.8.1)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.3.6)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    niceogiri (1.1.1)
+      nokogiri (~> 1.5)
+    nio4r (0.4.3)
+    nokogiri (1.5.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    punchblock (1.7.1)
+      activesupport (~> 3.0)
+      blather (>= 0.7.0)
+      celluloid (~> 0.12, >= 0.12.3)
+      future-resource (~> 1.0)
+      has-guarded-handlers (~> 1.5)
+      niceogiri (~> 1.1)
+      ruby_ami (~> 1.2, >= 1.2.1)
+      ruby_fs (~> 1.0)
+      ruby_speech (~> 1.0)
+      state_machine (~> 1.0)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rubinius-actor (0.0.2)
+      rubinius-core-api
+    rubinius-core-api (0.0.1)
+    ruby_ami (1.2.6)
+      celluloid-io (~> 0.12.0)
+      countdownlatch (~> 1.0)
+      future-resource
+      girl_friday
+    ruby_fs (1.0.3)
+      celluloid-io (~> 0.12.0)
+      json
+    ruby_speech (1.0.2)
+      activesupport (>= 3.0.7)
+      niceogiri (~> 1.1, >= 1.1.1)
+      nokogiri (~> 1.5, >= 1.5.6)
+    slop (3.3.3)
+    state_machine (1.1.2)
+    thor (0.16.0)
+    timers (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  guard-rspec
+  matrioska!
+  rake
+  rspec (~> 2.5)

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012 Adhearsion Foundation Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Matrioska
+
+Matrioska is an Adhearsion plugin for running in-call apps at the press of a DTMF.
+
+By mapping controllers or blocks to the desired applications, a listener object waits for DTMF and reacts by executing the specified payload.
+
+## Usage Example
+
+```ruby
+#inside your controller
+runner = Matrioska::AppRunner.new self
+runner.map_app 3 do
+  logger.info "hi there!"
+end
+runner.map_app 5, AppController
+
+call.on_end do
+  runner.stop
+end
+
+runner.start
+```
+
+### Author
+
+Original author: [Luca Pradovera](https://github.com/polysics)
+
+### Links
+
+* [Adhearsion](http://adhearsion.com)
+* [Source](https://github.com/polysics/matrioska)
+* [Bug Tracker](https://github.com/polysics/matrioska/issues)
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2013 Adhearsion Foundation Inc. MIT license (see LICENSE for details).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/matrioska.rb

@@ -0,0 +1,4 @@
+Matrioska = Module.new
+require "matrioska/version"
+require "matrioska/plugin"
+require "matrioska/app_runner"

data/lib/matrioska/app_runner.rb

@@ -0,0 +1,65 @@
+module Matrioska
+  class AppRunner
+    include Adhearsion::CallController::Utility
+
+    def initialize(call)
+      @call = call
+      @app_map = {}
+    end
+
+    def start
+      component = Punchblock::Component::Input.new({ :mode => :dtmf,
+          :grammar => {
+            :value => grammar_accept
+          }
+      })
+      component.register_event_handler Punchblock::Event::Complete do |event|
+        handle_input_complete event
+      end
+      @call.write_and_await_response component
+    end
+
+    def app_map
+      @app_map
+    end
+
+    def map_app(digit, controller=nil, &block)
+      digit = digit.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*#"
+      end
+
+      payload = if block_given?
+        raise ArgumentError, "You cannot specify both a block and a controller name." if controller.is_a? Class
+        block
+      else
+        raise ArgumentError, "You need to provide a block or a controller name." unless controller.is_a? Class
+        controller
+      end
+
+      @app_map[digit] = payload
+    end
+
+    def match_and_run(digit)
+      if match = @app_map[digit]
+        Adhearsion.logger.info "#match_and_run called with #{digit}"
+        callback = lambda {|call| start }
+        
+        @call.execute_controller(nil, callback, &match) if match.is_a? Proc
+        if match.is_a? Class
+          payload = match.new(@call)
+          @call.execute_controller(payload, callback)
+        end
+      end
+      start
+    end
+
+    def handle_input_complete(event)
+      result = event.reason.respond_to?(:utterance) ? event.reason.utterance : nil
+      digit = parse_dtmf result
+      match_and_run digit
+    end
+  end
+end

data/lib/matrioska/plugin.rb

@@ -0,0 +1,29 @@
+module Matrioska
+  class Plugin < Adhearsion::Plugin
+    # Actions to perform when the plugin is loaded
+    #
+    init :matrioska do
+      logger.warn "Matrioska has been loaded"
+    end
+
+    # Basic configuration for the plugin
+    #
+    config :matrioska do
+      greeting "Hello", :desc => "What to use to greet users"
+    end
+
+    # Defining a Rake task is easy
+    # The following can be invoked with:
+    #   rake plugin_demo:info
+    #
+    tasks do
+      namespace :matrioska do
+        desc "Prints the PluginTemplate information"
+        task :info do
+          STDOUT.puts "Matrioska plugin v. #{VERSION}"
+        end
+      end
+    end
+
+  end
+end

data/lib/matrioska/version.rb

@@ -0,0 +1,3 @@
+module Matrioska
+  VERSION = "0.0.1"
+end

data/matrioska.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "matrioska/version"
+
+Gem::Specification.new do |s|
+  s.name        = "matrioska"
+  s.version     = Matrioska::VERSION
+  s.authors     = ["Luca Pradovera"]
+  s.email       = ["lpradovera@mojolingo.com"]
+  s.homepage    = ""
+  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.rubyforge_project = "matrioska"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency %q<adhearsion>, ["~> 2.2"]
+  s.add_runtime_dependency %q<activesupport>, [">= 3.0.10"]
+
+  s.add_development_dependency %q<bundler>, ["~> 1.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.5"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<guard-rspec>
+ end

data/spec/matrioska/app_runner_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+module Matrioska
+  describe AppRunner do
+    let(:mock_call) { mock('Call') }
+    subject { AppRunner.new mock_call }
+    class MockController < Adhearsion::CallController; end
+
+    describe "#start" do
+      let(:grxml) {
+          RubySpeech::GRXML.draw :mode => 'dtmf', :root => 'inputdigits' do
+            rule id: 'inputdigits', scope: 'public' do
+              one_of do
+                0.upto(9) { |d| item { d.to_s } }
+                item { "#" }
+                item { "*" }
+              end
+            end
+          end
+        }
+
+      let(:input_component) {
+        Punchblock::Component::Input.new(
+          { :mode => :dtmf,
+            :grammar => {
+              :value => grxml.to_s
+            }
+          }
+        )
+      }
+
+      it "should start the appropriate component" do
+        mock_call.should_receive(:write_and_await_response).with(input_component)
+        subject.start
+      end
+    end
+
+    describe "#map_app" do
+      context "with invalid input" do
+        let(:too_long) { "ab" }
+        let(:wrong) { "a" }
+        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*#"
+        end
+
+        it "raises if called without either a class or a block" do
+           expect { subject.map_app 1 }.to raise_error ArgumentError, "You need to provide a block or a controller name."
+        end
+
+        it "raises if passed both a class and a block" do
+           expect { subject.map_app(1, Object){} }.to raise_error ArgumentError, "You cannot specify both a block and a controller name."
+        end
+      end
+
+      context "with valid input" do
+        it "properly sets the map for a block" do
+          subject.map_app(3) { p "foo" }
+          subject.app_map["3"].should be_a Proc
+        end
+        it "properly sets the map for a class" do
+          subject.map_app(3, Object)
+          subject.app_map["3"].should be_a Class
+        end
+      end
+    end
+
+    describe "#match_and_run" do
+      before do
+        subject.map_app(3) { p "foo" }
+        subject.map_app(5, MockController)
+      end
+
+      it "does nothing if there is no match, and restarts the launcher" do
+        mock_call.should_receive(:execute_controller).never
+        subject.should_receive(:start).once
+        subject.match_and_run("4")
+      end
+
+      it "executes the block if the payload is a Proc" do
+        mock_call.should_receive(:execute_controller).once.with(&subject.app_map["3"])
+        subject.should_receive(:start).once
+        subject.match_and_run("3")
+      end
+      it "executes the controller if the payload is a Class" do
+        mock_call.should_receive(:execute_controller).once.with(kind_of(MockController), kind_of(Proc))
+        subject.should_receive(:start).once
+        subject.match_and_run("5")
+      end
+    end
+
+    describe "#handle_input_complete" do
+      let(:mock_event) { mock('Event', :reason => mock('Reason', :utterance => "dtmf-5")) }
+      it "runs #match_and_run" do
+        subject.should_receive(:match_and_run).with("5").once
+        subject.handle_input_complete(mock_event)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'adhearsion'
+require 'matrioska'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: matrioska
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Luca Pradovera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adhearsion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adhearsion plugin for in-call apps. Provides a features-style interface
+  to run applications in calls.
+email:
+- lpradovera@mojolingo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matrioska.rb
+- lib/matrioska/app_runner.rb
+- lib/matrioska/plugin.rb
+- lib/matrioska/version.rb
+- matrioska.gemspec
+- spec/matrioska/app_runner_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: matrioska
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adhearsion plugin for in-call apps
+test_files:
+- spec/matrioska/app_runner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: