adhearsion 2.1.3 → 2.2.0

data/lib/adhearsion/generators/controller/templates/lib/controller.rb

@@ -3,4 +3,4 @@
 class <%= @controller_name.camelcase %> < Adhearsion::CallController
   def run
   end
-end  
+end

data/lib/adhearsion/generators/controller/templates/spec/controller_spec.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'spec_helper'
+
 describe <%= @controller_name.camelcase %> do
 
   let(:mock_call) { mock 'Call', :to => '1112223333', :from => "2223334444" }

data/lib/adhearsion/initializer.rb

@@ -38,9 +38,10 @@ module Adhearsion
     end
 
     def start
+      Adhearsion.statistics
       resolve_pid_file_path
       load_lib_folder
-      load_config
+      load_config_file
       initialize_log_paths
       daemonize! if should_daemonize?
       start_logging
@@ -165,7 +166,7 @@ module Adhearsion
       true
     end
 
-    def load_config
+    def load_config_file
       require "#{Adhearsion.config.root}/config/adhearsion.rb"
     end
 

data/lib/adhearsion/outbound_call.rb

@@ -15,6 +15,7 @@ module Adhearsion
       # @param [String] to the URI of the party to dial
       # @param [Hash] opts modifier options
       # @option opts [Class] :controller the controller to execute when the call is answered
+      # @option opts [Hash] :controller_metadata key-value pairs of metadata to set on the controller
       # @yield Call controller routine in block form
       #
       # @return [OutboundCall] the ringing call
@@ -23,7 +24,7 @@ module Adhearsion
       #
       def originate(to, opts = {}, &controller_block)
         new.tap do |call|
-          call.execute_controller_or_router_on_answer opts.delete(:controller), &controller_block
+          call.execute_controller_or_router_on_answer opts.delete(:controller), opts.delete(:controller_metadata), &controller_block
           call.dial to, opts
         end
       end
@@ -69,6 +70,7 @@ module Adhearsion
       write_and_await_response(Punchblock::Command::Dial.new(options), wait_timeout).tap do |dial_command|
         @dial_command = dial_command
         Adhearsion.active_calls << current_actor
+        Adhearsion::Events.trigger_immediately :call_dialed, current_actor
       end
     end
 
@@ -93,9 +95,10 @@ module Adhearsion
       end
     end
 
-    def execute_controller_or_router_on_answer(controller, &controller_block)
+    def execute_controller_or_router_on_answer(controller, metadata = {}, &controller_block)
       if controller || controller_block
         route = Router::Route.new 'inbound', controller, &controller_block
+        route.controller_metadata = metadata
         on_answer { route.dispatch current_actor }
       else
         run_router_on_answer

data/lib/adhearsion/router/route.rb

@@ -24,10 +24,12 @@ module Adhearsion
       end
 
       def dispatch(call, callback = nil)
+        Adhearsion::Events.trigger_immediately :call_routed, call: call, route: self
+
         controller = if target.respond_to?(:call)
-          CallController.new call, &target
+          CallController.new call, controller_metadata, &target
         else
-          target.new call
+          target.new call, controller_metadata
         end
 
         call.accept if accepting?
@@ -45,6 +47,15 @@ module Adhearsion
         }
       end
 
+      def controller_metadata=(metadata)
+        @controller_metadata = metadata
+      end
+
+      def controller_metadata
+        return {} unless instance_variable_defined?(:@controller_metadata)
+        @controller_metadata
+      end
+
       def evented?
         false
       end

data/lib/adhearsion/rspec.rb

@@ -4,4 +4,4 @@ require 'adhearsion'
 
 initializer = Adhearsion::Initializer.new
 initializer.load_lib_folder
-initializer.load_config
+initializer.load_config_file

data/lib/adhearsion/statistics.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+module Adhearsion
+  class Statistics
+    include Celluloid
+
+    exclusive
+
+    def initialize
+      @calls_dialed = @calls_offered = @calls_routed = @calls_rejected = 0
+      @calls_by_route = Hash.new { |h,k| h[k] = 0 }
+    end
+
+    #
+    # Create a point-time dump of process statistics
+    #
+    # @return [Adhearsion::Statistics::Dump]
+    def dump
+      Dump.new timestamp: Time.now, call_counts: dump_call_counts, calls_by_route: dump_calls_by_route
+    end
+
+    # @private
+    def register_call_dialed
+      @calls_dialed += 1
+    end
+
+    # @private
+    def register_call_offered
+      @calls_offered += 1
+    end
+
+    # @private
+    def register_call_routed(data)
+      @calls_routed += 1
+      @calls_by_route[data[:route].name] += 1
+    end
+
+    # @private
+    def register_call_rejected
+      @calls_rejected += 1
+    end
+
+    # @private
+    def setup_event_handlers
+      stats = current_actor
+
+      Events.punchblock(Punchblock::Event::Offer) do
+        begin
+          stats.register_call_offered
+        rescue Celluloid::DeadActorError
+        end
+        throw :pass
+      end
+
+      Events.call_dialed do
+        begin
+          stats.register_call_dialed
+        rescue Celluloid::DeadActorError
+        end
+        throw :pass
+      end
+
+      Events.call_rejected do
+        begin
+          stats.register_call_rejected
+        rescue Celluloid::DeadActorError
+        end
+        throw :pass
+      end
+
+      Events.call_routed do |data|
+        begin
+          stats.register_call_routed data
+        rescue Celluloid::DeadActorError
+        end
+        throw :pass
+      end
+    end
+
+    def to_s
+      "#<#{self.class} dump=#{dump}>"
+    end
+    alias :inspect :to_s
+
+    private
+
+    def dump_call_counts
+      {dialed: @calls_dialed, offered: @calls_offered, routed: @calls_routed, rejected: @calls_rejected, active: Adhearsion.active_calls.count}
+    end
+
+    def dump_calls_by_route
+      @calls_by_route.tap do |index|
+        Adhearsion.router.routes.each do |route|
+          index[route.name]
+        end
+      end
+    end
+
+    #
+    # A point-time dump of process statistics
+    class Dump
+      include Comparable
+
+      #
+      # @attribute
+      # @return [Time] the time at which this dump was generated
+      attr_reader :timestamp
+
+      #
+      # @attribute
+      # @return [Hash] hash of call counts during the lifetime of the process.
+      attr_reader :call_counts
+
+      #
+      # @attribute
+      # @return [Hash] hash of call counts during the lifetime of the process, indexed by the route they matched.
+      attr_reader :calls_by_route
+
+      def initialize(opts = {})
+        @timestamp = opts[:timestamp]
+        @call_counts = opts[:call_counts]
+        @calls_by_route = opts[:calls_by_route]
+      end
+
+      def <=>(other)
+        timestamp <=> other.timestamp
+      end
+
+      def to_s
+        attrs = [:timestamp, :call_counts, :calls_by_route].map do |attr|
+          "#{attr}=#{send(attr).inspect}"
+        end
+        "#<#{self.class} #{attrs.join ', '}>"
+      end
+      alias :inspect :to_s
+    end
+  end
+end

data/lib/adhearsion/tasks/environment.rb

@@ -7,7 +7,7 @@ task :environment do
     Adhearsion.config # load default config vlaues
     initializer = Adhearsion::Initializer.new
     initializer.load_lib_folder
-    initializer.load_config
+    initializer.load_config_file
   rescue Exception => ex
     STDERR.puts "\nError while loading application configuration file: #{ex}"
   end

data/lib/adhearsion/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Adhearsion
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

data/spec/adhearsion/call_controller/dial_spec.rb

@@ -436,6 +436,10 @@ module Adhearsion
               @@confirmation_latch = latch
 
               def run
+                # Copy metadata onto call variables so we can assert it later. Ugly hack
+                metadata.each_pair do |key, value|
+                  call[key] = value
+                end
                 @@confirmation_latch.countdown!
                 call['confirm'] || hangup
               end
@@ -451,6 +455,28 @@ module Adhearsion
             flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
           end
 
+          context "with confirmation controller metadata specified" do
+            let(:options) { {:confirm => confirmation_controller, :confirm_metadata => {:foo => 'bar'}} }
+
+            it "should set the metadata on the controller" do
+              flexmock(other_mock_call).should_receive(:hangup).twice.and_return do
+                other_mock_call << mock_end
+              end
+              other_mock_call['confirm'] = false
+
+              dial_in_thread
+
+              latch.wait(0.1).should be_false
+
+              other_mock_call << mock_answered
+
+              confirmation_latch.wait(1).should be_true
+              latch.wait(2).should be_true
+
+              other_mock_call[:foo].should == 'bar'
+            end
+          end
+
           context "when an outbound call is answered" do
             it "should execute the specified confirmation controller" do
               flexmock(other_mock_call).should_receive(:hangup).twice.and_return do

data/spec/adhearsion/call_controller/input_spec.rb

@@ -63,9 +63,11 @@ module Adhearsion
           )
         }
 
+        let(:utterance) { 'dtmf-5' }
+
         def expect_component_complete_event
           complete_event = Punchblock::Event::Complete.new
-          flexmock(complete_event).should_receive(:reason => flexmock(:interpretation => 'dtmf-5', :name => :input))
+          flexmock(complete_event).should_receive(:reason => flexmock(:utterance => utterance, :name => :input))
           flexmock(Punchblock::Component::Input).new_instances do |input|
             input.should_receive(:complete?).and_return(false)
             input.should_receive(:complete_event).and_return(complete_event)
@@ -84,6 +86,16 @@ module Adhearsion
           subject.wait_for_digit(timeout).should be == '5'
         end
 
+        context "when the utterance does not have dtmf- prefix" do
+          let(:utterance) { '5' }
+
+          it "returns the correct pressed digit" do
+            expect_component_complete_event
+            subject.should_receive(:execute_component_and_await_completion).once.with(Punchblock::Component::Input).and_return input_component
+            subject.wait_for_digit(timeout).should be == '5'
+          end
+        end
+
         context "with a nil timeout" do
           let(:timeout)     { nil }
           let(:timeout_ms)  { nil }

data/spec/adhearsion/call_controller/menu_dsl/array_match_calculator_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      describe ArrayMatchCalculator do
+
+        let(:match_payload) { :doesnt_matter }
+
+        it "matching arrays with fixnums" do
+          calculator = ArrayMatchCalculator.new [11,5,14,115], match_payload
+          match_case = calculator.match '11'
+          match_case.should be_exact_match
+          match_case.should be_potential_match
+          match_case.exact_matches.should be == [11]
+          match_case.potential_matches.should be == [115]
+        end
+
+        it "matching arrays with strings with digits and special digits" do
+          calculator = ArrayMatchCalculator.new %w[*57 4 *54 115 ###], match_payload
+          match_case = calculator.match '*5'
+          match_case.should_not be_exact_match
+          match_case.should be_potential_match
+          match_case.potential_matches.should be == %w[*57 *54]
+
+          match_case = calculator.match '*57'
+          match_case.should be_exact_match
+          match_case.should_not be_potential_match
+          match_case.exact_matches.should be == %w[*57]
+        end
+
+        it "matching an array with a combination of Fixnums and Strings" do
+          calculator = ArrayMatchCalculator.new ['11',5,'14',115], match_payload
+          match_case = calculator.match '11'
+          match_case.should be_exact_match
+          match_case.should be_potential_match
+          match_case.exact_matches.should be == ['11']
+          match_case.potential_matches.should be == [115]
+        end
+
+        it "matching empty array should never match" do
+          calculator = ArrayMatchCalculator.new [], match_payload
+          match_case = calculator.match '98'
+          match_case.should_not be_exact_match
+          match_case.should_not be_potential_match
+          match_case.exact_matches.should be == []
+          match_case.potential_matches.should be == []
+
+          match_case = calculator.match '*2'
+          match_case.should_not be_exact_match
+          match_case.should_not be_potential_match
+          match_case.exact_matches.should be == []
+          match_case.potential_matches.should be == []
+        end
+
+        it "matching array with nil should skip nil field" do
+          pattern = [1,2,nil,5,10]
+          calculator = ArrayMatchCalculator.new pattern, match_payload
+          match_case = calculator.match '1'
+          match_case.should be_exact_match
+          match_case.should be_potential_match
+          match_case.exact_matches.should be == [1]
+          match_case.potential_matches.should be == [10]
+
+          match_case = calculator.match '99'
+          match_case.should_not be_exact_match
+          match_case.should_not be_potential_match
+
+          pattern.should == [1,2,nil,5,10]
+        end
+      end
+    end
+  end
+end

data/spec/adhearsion/call_controller/menu_dsl/fixnum_match_calculator_spec.rb

@@ -10,26 +10,28 @@ module Adhearsion
 
         it "a potential match scenario" do
           calculator = FixnumMatchCalculator.new(444, match_payload)
-          match = calculator.match 4
-          match.potential_match?.should be true
-          match.exact_match?.should_not be true
+          match = calculator.match '4'
+          match.should be_potential_match
+          match.should_not be_exact_match
           match.potential_matches.should be == [444]
         end
 
         it "a multi-digit exact match scenario" do
           calculator = FixnumMatchCalculator.new(5555, match_payload)
-          calculator.match(5555).exact_match?.should be true
+          match = calculator.match '5555'
+          match.should be_exact_match
         end
 
         it "a single-digit exact match scenario" do
           calculator = FixnumMatchCalculator.new(1, match_payload)
-          calculator.match(1).exact_match?.should be true
+          match = calculator.match '1'
+          match.should be_exact_match
         end
 
         it "the context name given to the calculator should be passed on the CalculatedMatch" do
           match_payload = :icanhascheezburger
           calculator = FixnumMatchCalculator.new(1337, match_payload)
-          calculator.match(1337).match_payload.should be match_payload
+          calculator.match('1337').match_payload.should be match_payload
         end
       end
     end