adhearsion 2.5.4 → 2.6.0

data/lib/adhearsion/call_controller/dial.rb

@@ -36,6 +36,9 @@ module Adhearsion
       # @option options [CallController] :confirm the controller to execute on the first outbound call to be answered, to give an opportunity to screen the call. The calls will be joined if the outbound call is still active after this controller completes.
       # @option options [Hash] :confirm_metadata Metadata to set on the confirmation controller before executing it. This is shared between all calls if dialing multiple endpoints; if you care about it being mutated, you should provide an immutable value (using eg https://github.com/harukizaemon/hamster).
       #
+      # @option options [CallController] :cleanup The controller to execute on each call being cleaned up. This can be used, for instance, to notify that the call is being terminated. Calls are terminated right after this controller completes execution. If this is not specified, calls are silently terminated during cleanup.
+      # @option options [Hash] :cleanup_metadata Metadata to set on the cleanup controller before executing it. Defaults to :confirm_metadata if not specified.
+      #
       # @option options [Hash] :join_options Options to specify the kind of join operation to perform. See `Call#join` for details.
       # @option options [Call, String, Hash] :join_target the target to join to. May be a Call object, a call ID (String, Hash) or a mixer name (Hash). See `Call#join` for details.
       #
@@ -225,31 +228,30 @@ module Adhearsion
         # @option options [Adhearsion::CallController] :others The call controller class to execute on the 'other' call legs (the ones created as a result of the #dial)
         # @option options [Proc] :others_callback A block to call when the :others controller completes on an individual call
         def split(targets = {})
-          logger.info "Splitting calls apart"
           @splitting = true
           calls_to_split = @calls.map do |call|
             ignoring_ended_calls do
               [call.id, call] if call.active?
             end
           end.compact
-          logger.info "Splitting peer calls #{calls_to_split.map(&:first).join ", "}"
+          logger.info "Splitting off peer calls #{calls_to_split.map(&:first).join ", "}"
           calls_to_split.each do |id, call|
             ignoring_ended_calls do
-              logger.info "Unjoining peer #{call.id} from #{join_target}"
+              logger.debug "Unjoining peer #{call.id} from #{join_target}"
               ignoring_missing_joins { call.unjoin join_target }
               if split_controller = targets[:others]
-                logger.info "Executing split controller #{split_controller} on #{call.id}"
+                logger.info "Executing controller #{split_controller} on split call #{call.id}"
                 call.execute_controller split_controller.new(call, 'current_dial' => self), targets[:others_callback]
               end
             end
           end
           ignoring_ended_calls do
             if join_target != @call
-              logger.info "Unjoining main call #{@call.id} from #{join_target}"
+              logger.debug "Unjoining main call #{@call.id} from #{join_target}"
               @call.unjoin join_target
             end
             if split_controller = targets[:main]
-              logger.info "Executing split controller #{split_controller} on main call"
+              logger.info "Executing controller #{split_controller} on main call"
               @call.execute_controller split_controller.new(@call, 'current_dial' => self), targets[:main_callback]
             end
           end
@@ -327,7 +329,15 @@ module Adhearsion
           else
             logger.info "#dial finished. Hanging up #{calls_to_hangup.size} outbound calls which are still active: #{calls_to_hangup.map(&:first).join ", "}."
             calls_to_hangup.each do |id, outbound_call|
-              ignoring_ended_calls { outbound_call.hangup }
+              ignoring_ended_calls do
+                if @cleanup_controller
+                  logger.info "#dial running #{@cleanup_controller.class.name} on #{outbound_call.id}"
+                  outbound_call.execute_controller @cleanup_controller.new(outbound_call, @cleanup_metadata), ->(call) { call.hangup }
+                else
+                  logger.info "#dial hanging up #{outbound_call.id}"
+                  outbound_call.hangup
+                end
+              end
             end
           end
         end
@@ -373,6 +383,8 @@ module Adhearsion
           @join_options = @options.delete(:join_options) || {}
           @join_target = @options.delete(:join_target) || @call
 
+          @cleanup_controller = @options.delete :cleanup
+          @cleanup_metadata = @options.delete :cleanup_metadata || @confirmation_metadata
           @skip_cleanup = false
         end
 
@@ -384,7 +396,7 @@ module Adhearsion
         end
 
         def pre_join_tasks(call)
-          @pre_join[call] if @pre_join
+          @pre_join.call(call) if @pre_join
           terminate_ringback
         end
 
@@ -425,7 +437,7 @@ module Adhearsion
           super
           on_all_except call do |target_call|
             if @apology_controller
-              logger.info "#dial apologising to call #{target_call.id} because this call has been confirmed by another channel"
+              logger.info "#dial executing apology controller #{@apology_controller} on call #{target_call.id} because this call has been confirmed by another channel"
               target_call.async.execute_controller @apology_controller.new(target_call, @confirmation_metadata), ->(call) { call.hangup }
             else
               logger.info "#dial hanging up call #{target_call.id} because this call has been confirmed by another channel"

data/lib/adhearsion/call_controller/menu_dsl.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
 
+%w(
+  calculated_match
+  calculated_match_collection
+  match_calculator
+  fixnum_match_calculator
+  range_match_calculator
+  string_match_calculator
+  array_match_calculator
+  menu_builder
+  menu
+).each { |r| require "adhearsion/call_controller/menu_dsl/#{r}" }
+
 module Adhearsion
   class CallController
     # @private
     module MenuDSL
-      extend ActiveSupport::Autoload
-
-      autoload :Exceptions
-      autoload :CalculatedMatch
-      autoload :CalculatedMatchCollection
-      autoload :MatchCalculator
-      autoload :FixnumMatchCalculator
-      autoload :RangeMatchCalculator
-      autoload :StringMatchCalculator
-      autoload :ArrayMatchCalculator
-      autoload :MenuBuilder
-      autoload :Menu
     end
   end
 end

data/lib/adhearsion/call_controller/menu_dsl/array_match_calculator.rb

@@ -13,7 +13,7 @@ module Adhearsion
 
             if pattern_string == query_string
               args[:exact_matches] << pat
-            elsif pattern_string.starts_with? query_string
+            elsif pattern_string.start_with? query_string
               args[:potential_matches] << pat
             end
           end

data/lib/adhearsion/call_controller/menu_dsl/fixnum_match_calculator.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'adhearsion/call_controller/menu_dsl/string_match_calculator'
 
 module Adhearsion
   class CallController

data/lib/adhearsion/call_controller/menu_dsl/string_match_calculator.rb

@@ -13,7 +13,7 @@ module Adhearsion
 
           if pattern_string == query_string
             args[:exact_matches] = [pattern]
-          elsif pattern_string.starts_with? query_string
+          elsif pattern_string.start_with? query_string
             args[:potential_matches] = [pattern]
           end
 

data/lib/adhearsion/call_controller/output.rb

@@ -1,15 +1,16 @@
 # encoding: utf-8
+require 'uri'
+
+%w(
+  abstract_player
+  async_player
+  formatter
+  player
+).each { |r| require "adhearsion/call_controller/output/#{r}" }
 
 module Adhearsion
   class CallController
     module Output
-      extend ActiveSupport::Autoload
-
-      autoload :AbstractPlayer
-      autoload :AsyncPlayer
-      autoload :Formatter
-      autoload :Player
-
       PlaybackError = Class.new Adhearsion::Error # Represents failure to play audio, such as when the sound file cannot be found
       NoDocError = Class.new Adhearsion::Error # Represents failure to provide documents to playback
 
@@ -245,6 +246,34 @@ module Adhearsion
         async_player.play_ssml output_formatter.ssml_for_numeric(number), options
       end
 
+      #
+      # Plays the given SSML document from a URL.
+      #
+      # @param [String] url String containing a valid URL, like "http://example.com/document.ssml".
+      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      #
+      # @raise [ArgumentError] if the given argument can not be played
+      #
+      def play_document(url, options = {})
+        raise ArgumentError unless url =~ URI::regexp
+        player.play_url url, options
+        true
+      end
+
+      #
+      # Plays the given SSML document from a URL and returns as soon as it begins.
+      #
+      # @param [String] url String containing a valid URL, like "http://example.com/document.ssml".
+      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      #
+      # @raise [ArgumentError] if the given argument can not be played
+      # @return [Punchblock::Component::Output]
+      #
+      def play_document!(url, options = {})
+        raise ArgumentError unless url =~ URI::regexp
+        async_player.play_url url, options
+      end
+
       #
       # Plays the given output, allowing for DTMF input of a single digit from the user
       # At the end of the played file it returns nil

data/lib/adhearsion/call_controller/output/abstract_player.rb

@@ -19,6 +19,10 @@ module Adhearsion
           end
         end
 
+        def play_url(url, options = {})
+          output url, options.merge(render_document: {url: url, content_type: "application/ssml+xml"})
+        end
+
         def new_output(options)
           defaults = {}
 

data/lib/adhearsion/call_controller/record.rb

@@ -22,6 +22,7 @@ module Adhearsion
         # @option options [String, Optional] :initial_timeout Controls how long (seconds) the recognizer should wait after the end of the prompt for the caller to speak before sending a Recorder event.
         # @option options [String, Optional] :final_timeout Controls the length (seconds) of a period of silence after callers have spoken to conclude they finished.
         # @option options [Boolean, Optional] :interruptible Allows the recording to be terminated by any single DTMF key, default is false
+        # @option options [Symbol, Optional] :direction Controls which sides of the conversation are recorded: :recv (what the caller hears), :send (what the caller said), or :duplex (both)
         #
         def initialize(controller, options = {})
           @controller = controller

data/lib/adhearsion/cli_commands/ahn_command.rb

@@ -52,7 +52,7 @@ module Adhearsion
       desc "stop </path/to/directory>", "Stop a running Adhearsion server"
       method_option :pidfile, :type => :string, :aliases => %w(--pid-file)
       def stop(path = nil)
-        execute_from_app_dir! path
+        path = execute_from_app_dir! path
 
         pid_file = if options[:pidfile]
           File.exists?(File.expand_path(options[:pidfile])) ?
@@ -87,7 +87,7 @@ module Adhearsion
       desc "restart </path/to/directory>", "Restart the Adhearsion server"
       method_option :pidfile, :type => :string, :aliases => %w(--pid-file)
       def restart(path = nil)
-        execute_from_app_dir! path
+        path = execute_from_app_dir! path
         begin
           invoke :stop
         rescue PIDReadError => e
@@ -99,13 +99,15 @@ module Adhearsion
       protected
 
       def start_app(path, mode, pid_file = nil)
-        execute_from_app_dir! path
+        path = execute_from_app_dir! path
         say "Starting Adhearsion server at #{Dir.pwd}"
         Adhearsion::Initializer.start :mode => mode, :pid_file => pid_file
       end
 
       def execute_from_app_dir!(path)
-        return if in_app? and running_script_ahn?
+        if in_app? and running_script_ahn?
+          return Dir.pwd
+        end
 
         path ||= Dir.pwd if in_app?
 
@@ -117,6 +119,7 @@ module Adhearsion
           args[1] = '.'
           ScriptAhnLoader.exec_script_ahn! args
         end
+        path
       end
 
       def running_script_ahn?

data/lib/adhearsion/cli_commands/plugin_command.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'active_support/json'
+
 module Adhearsion
   module CLI
     class PluginCommand < Thor

data/lib/adhearsion/generators.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
+require 'adhearsion/generators/generator'
+
 module Adhearsion
   module Generators
-    extend ActiveSupport::Autoload
-
-    autoload :Generator
-
     class << self
 
       # Show help message with available generators.

data/lib/adhearsion/generators/app/templates/simon_game_spec.rb

@@ -15,21 +15,21 @@ describe SimonGame do
 
   describe "#random_number" do
 
-    before { subject.stub!(:rand).and_return(example_number) }
+    before { allow(subject).to receive(:rand).and_return(example_number) }
 
     it "generates a random number" do
-      subject.random_number.should eq example_number
+      expect(subject.random_number).to eq example_number
     end
   end
 
   describe "#update_number" do
 
     before { subject.number = "123" }
-    before { subject.stub!(:random_number).and_return "4" }
+    before { allow(subject).to receive(:random_number).and_return "4" }
 
     it "adds a digit to the end of the number" do
       subject.update_number
-      subject.number.should eq "1234"
+      expect(subject.number).to eq "1234"
     end
   end
 
@@ -40,7 +40,7 @@ describe SimonGame do
       before { subject.number = "3" }
 
       it "asks for a 1 digits number" do
-        subject.should_receive(:ask).with("3", :limit => 1).and_return(example_response)
+        expect(subject).to receive(:ask).with("3", :limit => 1).and_return(example_response)
         subject.collect_attempt
       end
     end
@@ -50,7 +50,7 @@ describe SimonGame do
       before { subject.number = long_number }
 
       it "asks for a 5 digits number" do
-        subject.should_receive(:ask).with(long_number, :limit => 5).and_return(long_response)
+        expect(subject).to receive(:ask).with(long_number, :limit => 5).and_return(long_response)
         subject.collect_attempt
       end
     end
@@ -60,9 +60,9 @@ describe SimonGame do
       before { subject.number = "12345" }
 
       it "based on the user's response" do
-        subject.should_receive(:ask).with("12345", :limit => 5).and_return(long_response)
+        expect(subject).to receive(:ask).with("12345", :limit => 5).and_return(long_response)
         subject.collect_attempt
-        subject.attempt.should eq long_number
+        expect(subject.attempt).to eq long_number
       end
     end
   end
@@ -76,7 +76,7 @@ describe SimonGame do
       before { subject.attempt = "7" }
 
       it "returns true" do
-        subject.attempt_correct?.should be_true
+        expect(subject.attempt_correct?).to be_truthy
       end
     end
 
@@ -85,7 +85,7 @@ describe SimonGame do
       before { subject.attempt = "9" }
 
       it "returns true" do
-        subject.attempt_correct?.should be_false
+        expect(subject.attempt_correct?).to be_falsey
       end
     end
   end
@@ -93,10 +93,10 @@ describe SimonGame do
   describe "#verify_attempt" do
     context "when the user is a good guesser" do
 
-      before { subject.stub!(:attempt_correct?).and_return true }
+      before { allow(subject).to receive(:attempt_correct?).and_return true }
 
       it "congradulates them" do
-        subject.should_receive(:speak).with('good')
+        expect(subject).to receive(:speak).with('good')
         subject.verify_attempt
       end
     end
@@ -107,7 +107,7 @@ describe SimonGame do
       before { subject.attempt = "12346" }
 
       it "congradulates them" do
-        subject.should_receive(:speak).with('4 times wrong, try again smarty')
+        expect(subject).to receive(:speak).with('4 times wrong, try again smarty')
         subject.verify_attempt
       end
     end
@@ -118,22 +118,22 @@ describe SimonGame do
     before { subject.reset }
 
     it "sets @number" do
-      subject.number.should eq ''
+      expect(subject.number).to eq ''
     end
 
     it "sets @attempt" do
-      subject.attempt.should eq ''
+      expect(subject.attempt).to eq ''
     end
   end
 
   describe "#run" do
     it "loops the loop" do
-      subject.should_receive :answer
-      subject.should_receive :reset
+      expect(subject).to receive :answer
+      expect(subject).to receive :reset
 
-      subject.should_receive :update_number
-      subject.should_receive :collect_attempt
-      subject.should_receive(:verify_attempt).and_throw :rspec_loop_stop
+      expect(subject).to receive :update_number
+      expect(subject).to receive :collect_attempt
+      expect(subject).to receive(:verify_attempt).and_throw :rspec_loop_stop
 
       catch :rspec_loop_stop do
         subject.run

data/lib/adhearsion/initializer.rb

@@ -163,10 +163,10 @@ module Adhearsion
         logger.info "Received SIG#{signal}. Shutting down."
         Adhearsion::Process.shutdown
       when 'HUP'
-        logger.debug "Received SIGHUP. Reopening logfiles."
+        logger.info "Received SIGHUP. Reopening logfiles."
         Adhearsion::Logging.reopen_logs
       when 'ALRM'
-        logger.debug "Received SIGALRM. Toggling trace logging."
+        logger.info "Received SIGALRM. Toggling trace logging."
         Adhearsion::Logging.toggle_trace!
       when 'ABRT'
         logger.info "Received ABRT signal. Forcing stop."

data/lib/adhearsion/plugin.rb

@@ -1,6 +1,12 @@
 # encoding: utf-8
 
 require 'loquacious'
+require 'active_support/inflector'
+require 'adhearsion/configuration'
+%w(
+  collection
+  initializer
+).each { |r| require "adhearsion/plugin/#{r}" }
 
 module Adhearsion
 
@@ -51,14 +57,8 @@ module Adhearsion
   #
   class Plugin
 
-    extend ActiveSupport::Autoload
-
     METHODS_OPTIONS = {:load => true, :scope => false}
 
-    autoload :Configuration
-    autoload :Collection
-    autoload :Initializer
-
     class << self
       ##
       # Class method that allows any subclass (any Adhearsion plugin) to register rake tasks.