adhearsion 2.3.5 → 2.4.0.beta1

data/lib/adhearsion/call_controller.rb

@@ -54,7 +54,11 @@ module Adhearsion
       end
     end
 
-    attr_reader :call, :metadata
+    # @return [Call] The call object on which the controller is executing
+    attr_reader :call
+
+    # @return [Hash] The controller's metadata provided at invocation
+    attr_reader :metadata
 
     # @private
     attr_reader :block
@@ -105,7 +109,7 @@ module Adhearsion
       execute_callbacks :before_call
       run
     rescue Call::Hangup
-      logger.info "Call was hung up"
+      logger.info "Call was hung up while executing a controller"
     rescue SyntaxError, StandardError => e
       Events.trigger :exception, [e, logger]
     ensure
@@ -156,18 +160,6 @@ module Adhearsion
       @after_call ||= execute_callbacks :after_call
     end
 
-    #
-    # Hangup the call, and execute after_call callbacks
-    #
-    # @param [Hash] headers
-    #
-    def hangup(headers = nil)
-      block_until_resumed
-      call.hangup headers
-      after_call
-      raise Call::Hangup
-    end
-
     # @private
     def write_and_await_response(command)
       block_until_resumed
@@ -195,6 +187,17 @@ module Adhearsion
       call.answer(*args)
     end
 
+    #
+    # Hangup the call, and execute after_call callbacks
+    #
+    # @param [Hash] headers
+    #
+    def hangup(headers = nil)
+      block_until_resumed
+      call.hangup headers
+      raise Call::Hangup
+    end
+
     #
     # Reject the call
     #
@@ -203,6 +206,7 @@ module Adhearsion
     def reject(*args)
       block_until_resumed
       call.reject(*args)
+      raise Call::Hangup
     end
 
     #
@@ -238,7 +242,7 @@ module Adhearsion
       block_until_resumed
       async = (target.is_a?(Hash) ? target : options).delete :async
       join_command = call.join target, options
-      waiter = join_command.call_id || join_command.mixer_name
+      waiter = join_command.call_uri || join_command.mixer_name
       if async
         call.wait_for_joined waiter
       else

data/lib/adhearsion/call_controller/dial.rb

@@ -33,7 +33,7 @@ module Adhearsion
       # @option options [Numeric] :for this option can be thought of best as a timeout.
       #   i.e. timeout after :for if no one answers the call
       #
-      # @option options [CallController] :confirm the controller to execute on answered outbound calls 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 [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).
       #
       # @example Make a call to the PSTN using my SIP provider for VoIP termination
@@ -47,8 +47,22 @@ module Adhearsion
       #
       # @return [DialStatus] the status of the dial operation
       #
-      def dial(to, options = {}, latch = nil)
-        dial = Dial.new to, options, latch, call
+      def dial(to, options = {})
+        dial = Dial.new to, options, call
+        dial.run
+        dial.await_completion
+        dial.cleanup_calls
+        dial.status
+      end
+
+      # Dial one or more third parties and join one to this call after execution of a confirmation controller.
+      # Confirmation will be attempted on all answered calls, and calls will be allowed to progress through confirmation in parallel. The first to complete confirmation will be joined to the A-leg, with the others being hung up.
+      #
+      # @option options [CallController] :apology controller to execute on calls which lose the race to complete confirmation before they are hung up
+      #
+      # @see #dial
+      def dial_and_confirm(to, options = {})
+        dial = ParallelConfirmationDial.new to, options, call
         dial.run
         dial.await_completion
         dial.cleanup_calls
@@ -58,9 +72,9 @@ module Adhearsion
       class Dial
         attr_accessor :status
 
-        def initialize(to, options, latch, call)
+        def initialize(to, options, call)
           raise Call::Hangup unless call.alive? && call.active?
-          @options, @latch, @call = options, latch, call
+          @options, @call = options, call
           @targets = to.respond_to?(:has_key?) ? to : Array(to)
           set_defaults
         end
@@ -68,7 +82,7 @@ module Adhearsion
         def set_defaults
           @status = DialStatus.new
 
-          @latch ||= CountDownLatch.new @targets.size
+          @latch = CountDownLatch.new @targets.size
 
           @options[:from] ||= @call.from
 
@@ -93,38 +107,43 @@ module Adhearsion
           @calls = @targets.map do |target, specific_options|
             new_call = OutboundCall.new
 
+            join_status = JoinStatus.new
+            status.joins[new_call] = join_status
+
             new_call.on_end do |event|
               @latch.countdown! unless new_call["dial_countdown_#{@call.id}"]
-              status.error! if event.reason == :error
+              if event.reason == :error
+                status.error!
+                join_status.errored!
+              end
             end
 
             new_call.on_answer do |event|
-              @calls.each do |call_to_hangup, _|
-                begin
-                  next if call_to_hangup.id == new_call.id
-                  logger.debug "#dial hanging up call #{call_to_hangup.id} because this call has been answered by another channel"
-                  call_to_hangup.hangup
-                rescue Celluloid::DeadActorError
-                  # This actor may previously have been shut down due to the call ending
-                end
-              end
+              pre_confirmation_tasks new_call
 
               new_call.on_unjoined @call do |unjoined|
                 new_call["dial_countdown_#{@call.id}"] = true
+                join_status.ended
                 @latch.countdown!
               end
 
               if @confirmation_controller
                 status.unconfirmed!
-                new_call.execute_controller @confirmation_controller.new(new_call, @confirmation_metadata), lambda { |call| call.signal :confirmed }
-                new_call.wait :confirmed
+                join_status.unconfirmed!
+                condition = Celluloid::Condition.new
+                new_call.execute_controller @confirmation_controller.new(new_call, @confirmation_metadata), lambda { |call| condition.broadcast }
+                condition.wait
               end
 
-              if new_call.alive? && new_call.active?
-                logger.debug "#dial joining call #{new_call.id} to #{@call.id}"
+              if new_call.alive? && new_call.active? && status.result != :answer
+                logger.info "#dial joining call #{new_call.id} to #{@call.id}"
+                pre_join_tasks new_call
                 @call.answer
+                join_status.started
                 new_call.join @call
-                status.answer!
+                status.answer!(new_call)
+              elsif status.result == :answer
+                join_status.lost_confirmation!
               end
             end
 
@@ -148,8 +167,18 @@ module Adhearsion
         end
 
         def cleanup_calls
-          logger.debug "#dial finished. Hanging up #{@calls.size} outbound calls: #{@calls.map(&:id).join ", "}."
-          @calls.each do |outbound_call|
+          calls_to_hangup = @calls.map do |call|
+            begin
+              [call.id, call] if call.active?
+            rescue Celluloid::DeadActorError
+            end
+          end.compact
+          if calls_to_hangup.size.zero?
+            logger.info "#dial finished with no remaining outbound calls"
+            return
+          end
+          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|
             begin
               outbound_call.hangup
             rescue Celluloid::DeadActorError
@@ -157,15 +186,66 @@ module Adhearsion
             end
           end
         end
+
+        private
+
+        def pre_confirmation_tasks(call)
+          on_all_except call do |target_call|
+            logger.info "#dial hanging up call #{target_call.id} because this call has been answered by another channel"
+            target_call.hangup
+          end
+        end
+
+        def pre_join_tasks(call)
+        end
+
+        def on_all_except(call)
+          @calls.each do |target_call, _|
+            begin
+              next if target_call.id == call.id
+              yield target_call
+            rescue Celluloid::DeadActorError
+              # This actor may previously have been shut down due to the call ending
+            end
+          end
+        end
+      end
+
+      class ParallelConfirmationDial < Dial
+        def set_defaults
+          super
+          @apology_controller = @options.delete :apology
+        end
+
+        private
+
+        def pre_confirmation_tasks(call)
+        end
+
+        def pre_join_tasks(call)
+          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"
+              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"
+              target_call.hangup
+            end
+          end
+        end
       end
 
       class DialStatus
         # The collection of calls created during the dial operation
-        attr_accessor :calls
+        attr_accessor :calls, :joined_call
+
+        # A collection of status objects indexed by call. Provides status on the joins such as duration
+        attr_accessor :joins
 
         # @private
         def initialize
           @result = nil
+          @joins = {}
         end
 
         #
@@ -177,7 +257,8 @@ module Adhearsion
         end
 
         # @private
-        def answer!
+        def answer!(call)
+          @joined_call = call
           @result = :answer
         end
 
@@ -197,6 +278,57 @@ module Adhearsion
         end
       end
 
+      class JoinStatus
+        # The time at which the calls were joined
+        attr_accessor :start_time
+
+        # Time at which the join was broken
+        attr_accessor :end_time
+
+        def initialize
+          @result = :no_answer
+        end
+
+        # The result of the attempt to join calls
+        # Can be:
+        # * :joined - The calls were sucessfully joined
+        # * :no_answer - The attempt to dial the third-party was cancelled before they answered
+        # * :unconfirmed - The callee did not complete confirmation
+        # * :lost_confirmation - The callee completed confirmation, but was beaten by another
+        # * :error - The call ended with some error
+        attr_reader :result
+
+        # The duration for which the calls were joined. Does not include time spent in confirmation controllers or after being separated.
+        def duration
+          if start_time && end_time
+            end_time - start_time
+          else
+            0.0
+          end
+        end
+
+        def errored!
+          @result = :error
+        end
+
+        def unconfirmed!
+          @result = :unconfirmed
+        end
+
+        def lost_confirmation!
+          @result = :lost_confirmation
+        end
+
+        def started
+          @start_time = Time.now
+          @result = :joined
+        end
+
+        def ended
+          @end_time = Time.now
+        end
+      end
+
     end
   end
 end

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

@@ -77,6 +77,14 @@ module Adhearsion
           end
         end
 
+        def method_missing(method_name, *args, &block)
+          if @context
+            @context.send method_name, *args, &block
+          else
+            super
+          end
+        end
+
       end # class MenuBuilder
 
     end

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

@@ -10,7 +10,7 @@ module Adhearsion
         # @raises [PlaybackError] if (one of) the given argument(s) could not be played
         #
         def output(content, options = {})
-          options.merge! :ssml => content.to_s
+          options.merge! :ssml => content
           component = new_output options
           component.register_event_handler Punchblock::Event::Complete do |event|
             controller.logger.error event if event.reason.is_a?(Punchblock::Event::Complete::Error)

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

@@ -8,7 +8,7 @@ module Adhearsion
       class Formatter
 
         def ssml_for_collection(collection)
-          collection.inject RubySpeech::SSML::Speak.new do |doc, argument|
+          collection.inject RubySpeech::SSML.draw do |doc, argument|
             doc + case argument
             when Hash
               ssml_for argument.delete(:value), argument

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

@@ -10,7 +10,7 @@ module Adhearsion
         # @raises [PlaybackError] if (one of) the given argument(s) could not be played
         #
         def output(content, options = {}, &block)
-          options.merge! :ssml => content.to_s
+          options.merge! :ssml => content
           component = new_output options
           if block
             controller.execute_component_and_await_completion component, &block

data/lib/adhearsion/calls.rb

@@ -49,6 +49,8 @@ module Adhearsion
         call_id = key call
         remove_inactive_call call
         return unless reason
+        Adhearsion::Events.trigger :exception, reason
+        logger.error "Call #{call_id} terminated abnormally due to #{reason}. Forcing hangup."
         PunchblockPlugin.client.execute_command Punchblock::Command::Hangup.new, :async => true, :call_id => call_id
       end
     end

data/lib/adhearsion/cli_commands.rb

@@ -22,168 +22,8 @@ end
 
 module Adhearsion
   module CLI
-    class AhnCommand < Thor
-      map %w(-h --h -help --help) => :help
-      map %w(-v --v -version --version) => :version
-      map %w(-) => :start
-
-      check_unknown_options!
-
-      def self.exit_on_failure?
-        true
-      end
-
-      desc "create /path/to/directory", "Create a new Adhearsion application under the given path"
-      def create(path)
-        require 'adhearsion/generators/app/app_generator'
-        Generators::AppGenerator.start
-      end
-
-      desc "generate [generator_name] arguments", Generators.help
-      def generate(generator_name = nil, *args)
-        if generator_name
-          Generators.invoke generator_name
-        else
-          help 'generate'
-        end
-      end
-
-      desc "version", "Shows Adhearsion version"
-      def version
-        say "Adhearsion v#{Adhearsion::VERSION}"
-        exit 0
-      end
-
-      desc "start </path/to/directory>", "Start the Adhearsion server in the foreground with a console"
-      def start(path = nil)
-        start_app path, :console
-      end
-
-      desc "daemon </path/to/directory>", "Start the Adhearsion server in the background"
-      method_option :pidfile, :type => :string, :aliases => %w(--pid-file)
-      def daemon(path = nil)
-        start_app path, :daemon, options[:pidfile]
-      end
-
-      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
-
-        pid_file = if options[:pidfile]
-          File.exists?(File.expand_path(options[:pidfile])) ?
-            options[:pidfile] :
-            File.join(path, options[:pidfile])
-        else
-          path = Dir.pwd
-          File.join path, Adhearsion::Initializer::DEFAULT_PID_FILE_NAME
-        end
-        pid_file = File.expand_path pid_file
-
-        begin
-          pid = File.read(pid_file).to_i
-        rescue
-          raise PIDReadError, pid_file
-        end
-
-        raise PIDReadError, pid_file if pid.nil?
-
-        say "Stopping Adhearsion server at #{path} with pid #{pid}"
-        waiting_timeout = Time.now + 15
-        begin
-          ::Process.kill "TERM", pid
-          sleep 0.25 while process_exists?(pid) && Time.now < waiting_timeout
-          ::Process.kill "KILL", pid
-        rescue Errno::ESRCH
-        end
-
-        File.delete pid_file if File.exists? pid_file
-      end
-
-      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
-        begin
-          invoke :stop
-        rescue PIDReadError => e
-          puts e.message
-        end
-        invoke :daemon
-      end
-
-      protected
-
-      def start_app(path, mode, pid_file = nil)
-        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?
-
-        path ||= Dir.pwd if in_app?
-
-        raise PathRequired, ARGV[0] if path.nil? or path.empty?
-        raise PathInvalid, path unless ScriptAhnLoader.in_ahn_application?(path)
-
-        Dir.chdir path do
-          args = ARGV.dup
-          args[1] = File.expand_path path
-          ScriptAhnLoader.exec_script_ahn! args
-        end
-      end
-
-      def running_script_ahn?
-        $0.to_s == "script/ahn"
-      end
-
-      def in_app?
-        ScriptAhnLoader.in_ahn_application? or ScriptAhnLoader.in_ahn_application_subdirectory?
-      end
-
-      def process_exists?(pid = nil)
-        # FIXME: Raise some error here
-        return false if pid.nil?
-        `ps -p #{pid} | sed -e '1d'`.strip.empty?
-      end
-
-      def method_missing(action, *args)
-        help
-        raise UnknownCommand, [action, *args] * " "
-      end
-    end # AhnCommand
-
-    class UnknownCommand < Thor::Error
-      def initialize(cmd)
-        super "Unknown command: #{cmd}"
-      end
-    end
-
-    class PathRequired < Thor::Error
-      def initialize(cmd)
-        super "A valid path is required for #{cmd}, unless run from an Adhearson app directory"
-      end
-    end
-
-     class UnknownGeneratorError < Thor::Error
-      def initialize(gentype)
-        puts "Please specify generator to use (#{Adhearsion::Generators.mappings.keys.join(", ")})"
-        super "Unknown command: #{gentype}"
-      end
-    end
-
-    class PathInvalid < Thor::Error
-      def initialize(path)
-        super "Directory #{path} does not belong to an Adhearsion project!"
-      end
-    end
-
-    class PIDReadError < Thor::Error
-      def initialize(path)
-        super "Could not read pid from the file #{path}"
-      end
-    end
+    require 'adhearsion/cli_commands/plugin_command'
+    require 'adhearsion/cli_commands/ahn_command'
+    require 'adhearsion/cli_commands/thor_errors'
   end
 end