adhearsion 2.0.0.alpha3 → 2.0.0.beta1

data/lib/adhearsion/call_controller/utility.rb

@@ -7,7 +7,7 @@ module Adhearsion
       # @param [Integer] Number of digits to accept in the grammar.
       # @return [RubySpeech::GRXML::Grammar] A grammar suitable for use in SSML prompts
       #
-      def grammar_digits(digits = 1)
+      def grammar_digits(digits = 1) # :nodoc:
         RubySpeech::GRXML.draw :mode => 'dtmf', :root => 'inputdigits' do
           rule id: 'inputdigits', scope: 'public' do
             item repeat: digits.to_s do
@@ -24,7 +24,7 @@ module Adhearsion
       # @param [String] String representing the digits to accept
       # @return [RubySpeech::GRXML::Grammar] A grammar suitable for use in SSML prompts
       #
-      def grammar_accept(digits = '0123456789#*')
+      def grammar_accept(digits = '0123456789#*') # :nodoc:
         allowed_digits = '0123456789#*'
         gram_digits = digits.chars.select { |x| allowed_digits.include? x }
 
@@ -43,7 +43,7 @@ module Adhearsion
       # @param [String] the tone string to be parsed
       # @return [String] the digit in case input was 0-9, * or # if star or pound respectively
       #
-      def parse_single_dtmf(result)
+      def parse_single_dtmf(result) # :nodoc:
         return if result.nil?
         case tone = result.split('-')[1]
         when 'star'

data/lib/adhearsion/calls.rb

@@ -28,10 +28,6 @@ module Adhearsion
       atomically { !calls.empty? }
     end
 
-    def size
-      atomically { calls.size }
-    end
-
     def remove_inactive_call(call)
       atomically { calls.delete call.id }
     end

data/lib/adhearsion/cli_commands.rb

@@ -68,13 +68,12 @@ module Adhearsion
       def stop(path = nil)
         execute_from_app_dir! path
 
-        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
@@ -118,7 +117,7 @@ module Adhearsion
       def execute_from_app_dir!(path)
         return if in_app? and running_script_ahn?
 
-        path ||= '.' if in_app?
+        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)

data/lib/adhearsion/console.rb

@@ -28,23 +28,15 @@ module Adhearsion
     # Start the Adhearsion console
     #
     def run
-      Pry.prompt = [
-                      proc do |*args|
-                        obj, nest_level, pry_instance = args
-                        "AHN#{'  ' * nest_level}> "
-                      end,
-                      proc do |*args|
-                        obj, nest_level, pry_instance = args
-                        "AHN#{'  ' * nest_level}? "
-                      end
-                    ]
+      set_prompt
       Pry.config.command_prefix = "%"
       if libedit?
         logger.error "Cannot start. You are running Adhearsion on Ruby with libedit. You must use readline for the console to work."
       else
         logger.info "Starting up..."
         @pry_thread = Thread.current
-        binding.pry
+        pry
+        logger.info "Console exiting"
       end
     end
 
@@ -82,7 +74,10 @@ module Adhearsion
           logger.error "An active call with that ID does not exist"
         end
       when nil
-        if calls.size == 1
+        case calls.size
+        when 0
+          logger.warn "No calls exist for control"
+        when 1
           interact_with_call calls.values.first
         else
           puts "Please choose a call:"
@@ -97,6 +92,9 @@ module Adhearsion
       else
         raise ArgumentError
       end
+    ensure
+      set_prompt
+      pry
     end
 
     def libedit?
@@ -111,16 +109,46 @@ module Adhearsion
 
     private
 
+    def set_prompt
+      Pry.prompt = [
+                proc do |*args|
+                  obj, nest_level, pry_instance = args
+                  "AHN#{'  ' * nest_level}> "
+                end,
+                proc do |*args|
+                  obj, nest_level, pry_instance = args
+                  "AHN#{'  ' * nest_level}? "
+                end
+              ]
+    end
+
     def interact_with_call(call)
       Pry.prompt = [ proc { "AHN<#{call.id}> " },
                      proc { "AHN<#{call.id}? " }  ]
 
-      CallController.exec InteractiveController.new(call)
+      begin
+        call.pause_controllers
+        CallController.exec InteractiveController.new(call)
+      ensure
+        logger.debug "Resuming call's controllers"
+        call.resume_controllers
+      end
     end
 
     class InteractiveController < CallController
       def run
-        pry
+        logger.debug "Starting interactive controller."
+        begin
+          pry
+        rescue => e
+          logger.error e
+        end
+        logger.debug "Interactive controller finished."
+      end
+
+      def hangup(*args)
+        super
+        exit
       end
     end
   end

data/lib/adhearsion/foundation/thread_safety.rb

@@ -8,8 +8,6 @@ class Object
 end
 
 class ThreadSafeArray
-  include Enumerable
-
   def initialize
     @mutex = Mutex.new
     @array = []
@@ -20,4 +18,12 @@ class ThreadSafeArray
       @array.send method, *args, &block
     end
   end
+
+  def inspect
+    @mutex.synchronize { @array.inspect }
+  end
+
+  def to_s
+    @mutex.synchronize { @array.to_s }
+  end
 end

data/lib/adhearsion/generators/app/templates/Rakefile

@@ -1,8 +1,5 @@
 #!/usr/bin/env rake
 
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-Bundler.require
+require File.expand_path('../config/environment',  __FILE__)
 
 require 'adhearsion/tasks'

data/lib/adhearsion/initializer.rb

@@ -111,14 +111,19 @@ module Adhearsion
     def catch_termination_signal
       %w'INT TERM'.each do |process_signal|
         trap process_signal do
-          logger.info "Received #{process_signal} signal. Shutting down."
+          logger.info "Received SIG#{process_signal}. Shutting down."
           Adhearsion::Process.shutdown
         end
       end
 
-      trap 'QUIT' do
-        logger.info "Received QUIT signal. Hard shutting down."
-        Adhearsion::Process.hard_shutdown
+      trap 'HUP' do
+        logger.debug "Received SIGHUP. Reopening logfiles."
+        Adhearsion::Logging.reopen_logs
+      end
+
+      trap 'ALRM' do
+        logger.debug "Received SIGALRM. Toggling trace logging."
+        Adhearsion::Logging.toggle_trace!
       end
 
       trap 'ABRT' do
@@ -163,7 +168,9 @@ module Adhearsion
           ::Logging.appenders.file(f,
             :layout => ::Logging.layouts.pattern(
               :pattern => Adhearsion::Logging.adhearsion_pattern
-            )
+            ),
+           :auto_flushing => 2,
+           :flush_period => 2
           )
         else
          a

data/lib/adhearsion/logging.rb

@@ -24,16 +24,33 @@ module Adhearsion
         '[%d] %-5l %c: %m\n'
       end
 
+      # Silence Adhearsion's logging, printing only FATAL messages
       def silence!
         self.logging_level = :fatal
       end
 
+      # Restore the default configured logging level
       def unsilence!
-        self.logging_level = :info
+        self.logging_level = Adhearsion.config.platform.logging['level']
       end
 
-      def reset
-        ::Logging.reset
+      # Toggle between the configured log level and :trace
+      # Useful for debugging a live Adhearsion instance
+      def toggle_trace!
+        if level == ::Logging.level_num(Adhearsion.config.platform.logging['level'])
+          logger.warn "Turning TRACE logging ON."
+          self.level = :trace
+        else
+          logger.warn "Turning TRACE logging OFF."
+          self.level = Adhearsion.config.platform.logging['level']
+        end
+      end
+
+      # Close logfiles and reopen them.  Useful for log rotation.
+      def reopen_logs
+        logger.info "Closing logfiles."
+        ::Logging.reopen
+        logger.info "Logfiles reopened."
       end
 
       def init
@@ -58,7 +75,9 @@ module Adhearsion
            :layout => ::Logging.layouts.pattern(
              :pattern => adhearsion_pattern,
              :color_scheme => 'bright'
-           )
+           ),
+           :auto_flushing => 2,
+           :flush_period => 2
          )]
       end
 

data/lib/adhearsion/process.rb

@@ -1,5 +1,6 @@
 require 'state_machine'
 require 'singleton'
+require 'socket'
 
 module Adhearsion
   class Process
@@ -9,7 +10,7 @@ module Adhearsion
       before_transition :log_state_change
       after_transition :on => :shutdown, :do => :request_stop
       after_transition any => :stopped, :do => :final_shutdown
-      after_transition :on => :force_stop, :do => :die_now!
+      before_transition any => :force_stopped, :do => :die_now!
 
       event :booted do
         transition :booting => :running
@@ -27,8 +28,12 @@ module Adhearsion
         # This corresponds to the admin pressing CTRL+C three times.
         transition :rejecting => :stopped
 
+        # On the fourth shutdown request, we are probably hung.
+        # Attempt no more graceful shutdown and exit as quickly as possible.
+        transition :stopped => :force_stopped
+
         # If we are still booting, transition directly to stopped
-        transition :booting => :force_stop
+        transition :booting => :force_stopped
       end
 
       event :hard_shutdown do
@@ -90,6 +95,10 @@ module Adhearsion
       ::Process.exit 1
     end
 
+    def fqdn
+      Socket.gethostbyname(Socket.gethostname).first
+    end
+
     def self.method_missing(method_name, *args, &block)
       instance.send method_name, *args, &block
     end

data/lib/adhearsion/punchblock_plugin.rb

@@ -20,6 +20,7 @@ module Adhearsion
       connection_timeout  60               , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "The amount of time to wait for a connection"
       reconnect_attempts  1.0/0.0          , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "The number of times to (re)attempt connection to the server"
       reconnect_timer     5                , :transform => Proc.new { |v| PunchblockPlugin.validate_number v }, :desc => "Delay between connection attempts"
+      media_engine        nil              , :transform => Proc.new { |v| v.to_sym }, :desc => "The media engine to use. Defaults to platform default."
     end
 
     init :punchblock do
@@ -38,6 +39,13 @@ module Adhearsion
         return 1.0/0.0 if ["Infinity", 1.0/0.0].include? value
         value.to_i
       end
+
+      def execute_component(command, timeout = 60)
+        client.execute_command command
+        response = command.response timeout
+        raise response if response.is_a? Exception
+        command
+      end
     end
   end
 end

data/lib/adhearsion/punchblock_plugin/initializer.rb

@@ -10,19 +10,23 @@ module Adhearsion
           self.config = Adhearsion.config[:punchblock]
           connection_class = case (self.config.platform || :xmpp)
           when :xmpp
+            username = [self.config.username, resource].join('/')
             ::Punchblock::Connection::XMPP
           when :asterisk
+            username = self.config.username
             ::Punchblock::Connection::Asterisk
           end
+
           connection_options = {
-            :username           => self.config.username,
+            :username           => username,
             :password           => self.config.password,
             :connection_timeout => self.config.connection_timeout,
             :host               => self.config.host,
             :port               => self.config.port,
             :root_domain        => self.config.root_domain,
             :calls_domain       => self.config.calls_domain,
-            :mixers_domain      => self.config.mixers_domain
+            :mixers_domain      => self.config.mixers_domain,
+            :media_engine       => self.config.media_engine
           }
 
           self.connection = connection_class.new connection_options
@@ -130,14 +134,17 @@ module Adhearsion
           end
         end
 
-        def dispatch_call_event(event, latch = nil)
+        def dispatch_call_event(event)
           if call = Adhearsion.active_calls.find(event.call_id)
             call.deliver_message! event
-            latch.countdown! if latch
           else
             logger.error "Event received for inactive call #{event.call_id}: #{event.inspect}"
           end
         end
+
+        def resource
+          [Adhearsion::Process.fqdn, ::Process.pid].join '-'
+        end
       end
     end # Punchblock
   end # Plugin

data/lib/adhearsion/version.rb

@@ -1,5 +1,5 @@
 module Adhearsion #:nodoc:
-  VERSION = '2.0.0.alpha3'
+  VERSION = '2.0.0.beta1'
 
   class PkgVersion
     include Comparable

data/spec/adhearsion/call_controller/dial_spec.rb

@@ -19,12 +19,15 @@ module Adhearsion
       let(:latch) { CountDownLatch.new 1 }
 
       describe "#dial" do
-        it "should dial the call to the correct endpoint and return it" do
+        before do
           other_mock_call
+        end
+
+        it "should dial the call to the correct endpoint and return a dial status object" do
           flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
           flexmock(other_mock_call).should_receive(:dial).with(to, :from => 'foo').once
           dial_thread = Thread.new do
-            subject.dial(to, :from => 'foo').should be_a OutboundCall
+            subject.dial(to, :from => 'foo').should be_a Dial::DialStatus
           end
           sleep 0.1
           other_mock_call << mock_end
@@ -32,7 +35,6 @@ module Adhearsion
         end
 
         it "should default the caller ID to that of the original call" do
-          other_mock_call
           flexmock call, :from => 'sip:foo@bar.com'
           flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
           flexmock(other_mock_call).should_receive(:dial).with(to, :from => 'sip:foo@bar.com').once
@@ -45,19 +47,22 @@ module Adhearsion
         end
 
         describe "without a block" do
-          it "blocks the original controller until the new call ends" do
-            other_mock_call
-
+          before do
             flexmock(other_mock_call).should_receive(:dial).once
             flexmock(other_mock_call).should_receive(:hangup).once
             flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
+          end
 
-            latch = CountDownLatch.new 1
-
+          def dial_in_thread
             Thread.new do
-              subject.dial to
+              status = subject.dial to
               latch.countdown!
+              status
             end
+          end
+
+          it "blocks the original controller until the new call ends" do
+            dial_in_thread
 
             latch.wait(1).should be_false
 
@@ -67,18 +72,7 @@ module Adhearsion
           end
 
           it "unblocks the original controller if the original call ends" do
-            other_mock_call
-
-            flexmock(other_mock_call).should_receive(:dial).once
-            flexmock(other_mock_call).should_receive(:hangup).once
-            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
-
-            latch = CountDownLatch.new 1
-
-            Thread.new do
-              subject.dial to
-              latch.countdown!
-            end
+            dial_in_thread
 
             latch.wait(1).should be_false
 
@@ -88,19 +82,9 @@ module Adhearsion
           end
 
           it "joins the new call to the existing one on answer" do
-            other_mock_call
-
-            flexmock(other_mock_call).should_receive(:dial).once
             flexmock(other_mock_call).should_receive(:join).once.with(call)
-            flexmock(other_mock_call).should_receive(:hangup).once
-            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
 
-            latch = CountDownLatch.new 1
-
-            Thread.new do
-              subject.dial to
-              latch.countdown!
-            end
+            dial_in_thread
 
             latch.wait(1).should be_false
 
@@ -111,19 +95,9 @@ module Adhearsion
           end
 
           it "hangs up the new call when the dial unblocks" do
-            other_mock_call
-
-            flexmock(other_mock_call).should_receive(:dial).once
             flexmock(other_mock_call).should_receive(:join).once.with(call)
-            flexmock(other_mock_call).should_receive(:hangup).once
-            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
 
-            latch = CountDownLatch.new 1
-
-            Thread.new do
-              subject.dial to
-              latch.countdown!
-            end
+            dial_in_thread
 
             latch.wait(1).should be_false
 
@@ -132,29 +106,70 @@ module Adhearsion
 
             latch.wait(1).should be_true
           end
+
+          context "when the call is rejected" do
+            it "has an overall dial status of :no_answer" do
+              t = dial_in_thread
+
+              sleep 0.5
+
+              other_mock_call << mock_end
+
+              latch.wait(2).should be_true
+
+              t.join
+              status = t.value
+              status.result.should == :no_answer
+            end
+          end
+
+          context "when the call is answered and joined" do
+            it "has an overall dial status of :answer" do
+              flexmock(other_mock_call).should_receive(:join).once.with(call)
+
+              t = dial_in_thread
+
+              sleep 0.5
+
+              other_mock_call << mock_answered
+              other_mock_call << mock_end
+
+              latch.wait(1).should be_true
+
+              t.join
+              status = t.value
+              status.result.should == :answer
+            end
+          end
         end
 
         describe "with multiple third parties specified" do
-          it "dials all parties and joins the first one to answer, hanging up the rest" do
-            other_mock_call
+          before do
             second_other_mock_call
 
+            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call, second_other_mock_call
+
             flexmock(other_mock_call).should_receive(:dial).once
-            flexmock(other_mock_call).should_receive(:join).once.with(call)
             flexmock(other_mock_call).should_receive(:hangup).once
 
             flexmock(second_other_mock_call).should_receive(:dial).once
             flexmock(second_other_mock_call).should_receive(:join).never
-            flexmock(second_other_mock_call).should_receive(:hangup).twice
-
-            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call, second_other_mock_call
-            latch = CountDownLatch.new 1
+            flexmock(second_other_mock_call).should_receive(:hangup).once
+          end
 
-            t = Thread.new do
-              calls = subject.dial [to, second_to]
+          def dial_in_thread
+            Thread.new do
+              status = subject.dial [to, second_to]
               latch.countdown!
-              calls
+              status
             end
+          end
+
+          it "dials all parties and joins the first one to answer, hanging up the rest" do
+            flexmock(other_mock_call).should_receive(:join).once.with(call)
+            flexmock(second_other_mock_call).should_receive(:hangup).once
+
+            t = dial_in_thread
 
             latch.wait(1).should be_false
 
@@ -168,37 +183,22 @@ module Adhearsion
             latch.wait(2).should be_true
 
             t.join
-            calls = t.value
-            calls.should have(2).calls
-            calls.each { |c| c.should be_a OutboundCall }
+            status = t.value
+            status.should be_a Dial::DialStatus
+            status.should have(2).calls
+            status.calls.each { |c| c.should be_a OutboundCall }
           end
 
           it "unblocks when the joined call unjoins, allowing it to proceed further" do
-            other_mock_call
-            second_other_mock_call
-
-            flexmock(other_mock_call).should_receive(:dial).once
             flexmock(other_mock_call).should_receive(:join).once.with(call)
-            flexmock(other_mock_call).should_receive(:hangup).once
+            flexmock(second_other_mock_call).should_receive(:hangup).once
 
-            flexmock(second_other_mock_call).should_receive(:dial).once
-            flexmock(second_other_mock_call).should_receive(:join).never
-            flexmock(second_other_mock_call).should_receive(:hangup).twice
-
-            flexmock(OutboundCall).should_receive(:new).and_return other_mock_call, second_other_mock_call
-            latch = CountDownLatch.new 1
-
-            t = Thread.new do
-              calls = subject.dial [to, second_to]
-              latch.countdown!
-              calls
-            end
+            t = dial_in_thread
 
             latch.wait(1).should be_false
 
             other_mock_call << mock_answered
             other_mock_call << Punchblock::Event::Unjoined.new(:other_call_id => call.id)
-            other_mock_call << mock_end
 
             latch.wait(1).should be_false
 
@@ -207,9 +207,49 @@ module Adhearsion
             latch.wait(2).should be_true
 
             t.join
-            calls = t.value
-            calls.should have(2).calls
-            calls.each { |c| c.should be_a OutboundCall }
+            status = t.value
+            status.should be_a Dial::DialStatus
+            status.should have(2).calls
+            status.calls.each { |c| c.should be_a OutboundCall }
+          end
+
+          context "when all calls are rejected" do
+            it "has an overall dial status of :no_answer" do
+              t = dial_in_thread
+
+              sleep 0.5
+
+              other_mock_call << mock_end
+              second_other_mock_call << mock_end
+
+              latch.wait(2).should be_true
+
+              t.join
+              status = t.value
+              status.result.should == :no_answer
+            end
+          end
+
+          context "when a call is answered and joined" do
+            it "has an overall dial status of :answer" do
+              flexmock(other_mock_call).should_receive(:join).once.with(call)
+              flexmock(second_other_mock_call).should_receive(:hangup).once
+
+              t = dial_in_thread
+
+              sleep 0.5
+
+              other_mock_call << mock_answered
+              other_mock_call << mock_end
+
+              second_other_mock_call << mock_end
+
+              latch.wait(1).should be_true
+
+              t.join
+              status = t.value
+              status.result.should == :answer
+            end
           end
         end
 
@@ -217,26 +257,24 @@ module Adhearsion
           let(:timeout) { 3 }
 
           it "should abort the dial after the specified timeout" do
-            other_mock_call
-
             flexmock(other_mock_call).should_receive(:dial).once
             flexmock(other_mock_call).should_receive(:hangup).once
             flexmock(OutboundCall).should_receive(:new).and_return other_mock_call
 
-            latch = CountDownLatch.new 1
-
-            value = nil
             time = Time.now
 
-            Thread.new do
-              value = subject.dial to, :timeout => timeout
+            t = Thread.new do
+              status = subject.dial to, :timeout => timeout
               latch.countdown!
+              status
             end
 
             latch.wait
             time = Time.now - time
             time.to_i.should == timeout
-            value.should == false
+            t.join
+            status = t.value
+            status.result.should == :timeout
           end
         end