adhearsion 2.5.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934b35739888ae39b19f72ea09e02289ebc56bb5
-  data.tar.gz: 8f84e7ccdc30266aff7fe3ff47854dff86511efb
+  metadata.gz: cdd9595f782bf66bc47865e7738e5da1c973d842
+  data.tar.gz: 916b8a0a4a2a07b0a7464f281c05d9a096043acf
 SHA512:
-  metadata.gz: f23fb10c0bdaa93a47f4a4516d756d452a611d07282c8f1396b2c4132f08e7ff1be4af6cec65ebb40a0752d15e6509c04621fb1a13853e4da33f693eae15075d
-  data.tar.gz: 5516860dc709922c9d7babe161d5f760a91a1ce20c9af8cdf68ee2ac3d737258a1acd62d896ffb76c45ffd6405c1a3f3c62d0277b93bbe5b69e494593904b149
+  metadata.gz: 0114fe9c93594187df01011c321e33f754cb6d438d68d6d6bf670b63d926f0cbdae3c59929974c177d37bc724e664e465f0baa0d9b77797f33291bb193a0c77f
+  data.tar.gz: cddca9472cccaa2e7a7a526d7bdd8a57f95ab2e5fa3bc171ef26463dcd4dbcacc289ab8947a7628e349f4e345295b79f6f4d1543ed56fbea1a59560e0664860f

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --colour
 --tty
+--profile

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.6.0](https://github.com/adhearsion/adhearsion/compare/v2.5.4...v2.6.0) - [2015-02-01](https://rubygems.org/gems/adhearsion/versions/2.6.0)
+  * Feature: `Call#after_hangup_lifetime` optionally overrides `Adhearsion.config.platform.after_hangup_lifetime` ([#537](https://github.com/adhearsion/adhearsion/pull/537))
+  * Feature: Accept a `:cleanup` parameter in Dial options, which specifies a controller to be run on each outbound call before cleanup. ([#484](https://github.com/adhearsion/adhearsion/pull/484))
+  * Feature: Add a per-controller callback `on_error` that is invoked whenever an unhandled exception is raised. This can be used to play apology messages before disconnecting the caller ([#486](https://github.com/adhearsion/adhearsion/issues/486))
+  * Feature: Add `Call#redirect` and `CallController#redirect` for redirecting calls to other systems ([#465](https://github.com/adhearsion/adhearsion/issues/465))
+  * Feature: Ensure logging is available on STDOUT during RSpec runs ([#489](https://github.com/adhearsion/adhearsion/pull/489))
+  * Feature: Reduce Adhearsion start-up time by selectively requiring the parts of ActiveSupport we use
+  * Feature: `Call#unjoin` does not require a `target`, allowing to unjoin from all existing joins ([#519](https://github.com/adhearsion/adhearsion/pull/519))
+  * Feature: Add `Output#play_document` and `Output#play_document!` for playing an SSML document from a URL ([#535](https://github.com/adhearsion/adhearsion/pull/535))
+  * Bugfix: Logging around post-routing call termination now accounts for the call already being down.
+  * Bugfix: Bubble component complete events to other registered handlers
+  * Bugfix: Calling `ahn restart` on a stopped application now works
+  * Documentation: Improved INFO level log messages ([#518](https://github.com/adhearsion/adhearsion/pull/518))
+  * Update: Update Punchblock to fix Celluloid incompatibility ([#521](https://github.com/adhearsion/adhearsion/pull/521))
+
 # [2.5.4](https://github.com/adhearsion/adhearsion/compare/v2.5.3...v2.5.4) - [2014-07-18](https://rubygems.org/gems/adhearsion/versions/2.5.4)
   * Bugfix: Ignore dead calls when searching by tag
   * Bugfix: Routing a dead call should end cleanly ([#441](https://github.com/adhearsion/adhearsion/issues/441))

data/README.markdown

@@ -3,6 +3,7 @@
 [![Dependency Status](https://gemnasium.com/adhearsion/adhearsion.png?travis)](https://gemnasium.com/adhearsion/adhearsion)
 [![Code Climate](https://codeclimate.com/github/adhearsion/adhearsion.png)](https://codeclimate.com/github/adhearsion/adhearsion)
 [![Coverage Status](https://coveralls.io/repos/adhearsion/adhearsion/badge.png?branch=develop)](https://coveralls.io/r/adhearsion/adhearsion)
+[![Inline docs](http://inch-ci.org/github/adhearsion/adhearsion.png?branch=develop)](http://inch-ci.org/github/adhearsion/adhearsion)
 
 # Adhearsion
 
@@ -82,4 +83,4 @@ There is a pre-commit hook that runs encoding checks available in pre-commit. To
 
 ### Copyright
 
-Copyright (c) 2011-2013 Adhearsion Foundation Inc. MIT LICENSE (see LICENSE for details).
+Copyright (c) 2011-2014 Adhearsion Foundation Inc. MIT LICENSE (see LICENSE for details).

data/Rakefile

@@ -11,15 +11,10 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   # t.ruby_opts = "-w -r./spec/capture_warnings"
 end
 
-require 'ci/reporter/rake/rspec'
-require 'ci/reporter/rake/cucumber'
-task :ci => ['ci:setup:rspec', :spec, 'ci:setup:rspec', :features]
-
 require 'cucumber'
 require 'cucumber/rake/task'
-require 'ci/reporter/rake/cucumber'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = %w{--tags ~@jruby} unless defined?(JRUBY_VERSION)
+  t.cucumber_opts = %w{--tags ~@skip_jruby} if defined?(JRUBY_VERSION)
 end
 
 Cucumber::Rake::Task.new(:wip) do |t|

data/adhearsion.gemspec

@@ -33,17 +33,18 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
   s.add_runtime_dependency 'logging', ["~> 1.8"]
   s.add_runtime_dependency 'pry'
-  s.add_runtime_dependency 'punchblock', ["~> 2.4"]
+  s.add_runtime_dependency 'punchblock', ["~> 2.6"]
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'ruby_speech', ["~> 2.0"]
   s.add_runtime_dependency 'thor', "~> 0.18.0"
 
   s.add_development_dependency 'aruba', "~> 0.5"
-  s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'ci_reporter_rspec'
+  s.add_development_dependency 'ci_reporter_cucumber'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'guard-cucumber'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rspec', ["~> 2.13"]
+  s.add_development_dependency 'rspec', ["~> 3.0"]
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'
   s.add_development_dependency 'yard'

data/features/cli_daemon.feature

@@ -3,18 +3,16 @@ Feature: Adhearsion Ahn CLI (daemon)
   I want the ahn command to provide a 'daemon' command
   So that I can start my adhearsion app as a daemon
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command daemon with path works correctly
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I run `ahn daemon path/somewhere`
     And I cd to "path/somewhere"
     And I terminate the process using the pid file "adhearsion.pid"
     Then the exit status should be 0
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command daemon with pid option
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I run `ahn daemon path/somewhere --pid-file=ahn.pid`
     And I cd to "path/somewhere"

data/features/cli_restart.feature

@@ -3,9 +3,8 @@ Feature: Adhearsion Ahn CLI (restart)
   I want the ahn command to provide a 'restart' command
   So that I can restart a running Adhearsion daemon
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command restart with a missing or wrong pid
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I run `ahn daemon path/somewhere --pid-file=ahn.pid`
     And I run `ahn restart path/somewhere --pid-file=ahn2.pid`
@@ -29,9 +28,8 @@ Feature: Adhearsion Ahn CLI (restart)
     """
     And the exit status should be 1
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command restart with no path inside of the app directory
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I cd to "path/somewhere"
     And I run `ahn daemon --pid-file=ahn.pid`
@@ -40,4 +38,15 @@ Feature: Adhearsion Ahn CLI (restart)
     """
     Starting Adhearsion
     """
-    And the exit status should be 0
+    And the exit status should be 0
+
+  @reconnect @skip_jruby
+  Scenario: Command restart on a stopped application
+    Given that I create a valid app under "path/somewhere"
+    When I cd to "path/somewhere"
+    And I run `ahn restart --pid-file=ahn.pid`
+    Then the output should contain:
+    """
+    Starting Adhearsion
+    """
+    And the exit status should be 0

data/features/cli_start.feature

@@ -12,7 +12,6 @@ Feature: Adhearsion Ahn CLI (start)
     And the exit status should be 1
 
   Scenario: Command start with no path inside of the app directory
-    Given JRuby skip test because the console causes the process to never exit
     And that I create a valid app under "path/somewhere"
     When I cd to "path/somewhere"
     And I run `ahn start` interactively
@@ -21,7 +20,6 @@ Feature: Adhearsion Ahn CLI (start)
     And the output should contain "Adhearsion shut down"
 
   Scenario: Command start with only path works properly
-    Given JRuby skip test waiting for https://jira.codehaus.org/browse/JRUBY-6994
     And that I create a valid app under "path/somewhere"
     When I run `ahn start path/somewhere` interactively
     And I wait for output to contain "Starting connection to server"

data/features/cli_stop.feature

@@ -3,9 +3,8 @@ Feature: Adhearsion Ahn CLI (stop)
   I want the ahn command to provide a 'stop' command
   So that I can stop a running Adhearsion daemon
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command stop with valid path and pid option
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I run `ahn daemon path/somewhere --pid-file=ahn.pid`
     And I run `ahn stop path/somewhere --pid-file=ahn.pid`
@@ -15,9 +14,8 @@ Feature: Adhearsion Ahn CLI (stop)
     """
     And the file "ahn.pid" should not exist
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command stop with valid path and no pid option
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     When I run `ahn daemon path/somewhere`
     And I run `ahn stop path/somewhere`
@@ -27,9 +25,8 @@ Feature: Adhearsion Ahn CLI (stop)
     """
     And the file "path/somewhere/adhearsion.pid" should not exist
 
-  @reconnect
+  @reconnect @skip_jruby
   Scenario: Command stop with no options inside the app directory
-    Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
     And I cd to "path/somewhere"
     When I run `ahn daemon`
@@ -39,3 +36,15 @@ Feature: Adhearsion Ahn CLI (stop)
     Stopping Adhearsion
     """
     And the file "adhearsion.pid" should not exist
+
+  @reconnect @skip_jruby
+  Scenario: Command stop with pid option inside the app directory
+    Given that I create a valid app under "path/somewhere"
+    And I cd to "path/somewhere"
+    When I run `ahn daemon --pid-file=ahn.pid`
+    And I run `ahn stop --pid-file=ahn.pid`
+    Then the output should contain:
+    """
+    Stopping Adhearsion
+    """
+    And the file "ahn.pid" should not exist

data/lib/adhearsion.rb

@@ -2,36 +2,15 @@
 
 abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby #{RUBY_VERSION} #{RUBY_RELEASE_DATE})! Please upgrade to at least Ruby v1.9.3, JRuby 1.7.0 or Rubinius 2.0." if RUBY_VERSION < "1.9.3"
 
-%w{
-  active_support/all
+%w(
   punchblock
   celluloid
+).each { |r| require r }
 
-  adhearsion/version
-  adhearsion/foundation
-}.each { |f| require f }
 
 module Adhearsion
-  extend ActiveSupport::Autoload
-
   Error = Class.new StandardError
 
-  autoload :Call
-  autoload :CallController
-  autoload :Calls
-  autoload :Configuration
-  autoload :Console
-  autoload :Dispatcher
-  autoload :Events
-  autoload :Generators
-  autoload :Initializer
-  autoload :Logging
-  autoload :OutboundCall
-  autoload :Plugin
-  autoload :Process
-  autoload :Router
-  autoload :Statistics
-
   class << self
 
     #
@@ -130,3 +109,22 @@ module Celluloid
     end
   end
 end
+
+%w(
+  version
+  foundation
+  call
+  call_controller
+  calls
+  configuration
+  console
+  events
+  generators
+  initializer
+  logging
+  outbound_call
+  plugin
+  process
+  router
+  statistics
+).each { |f| require "adhearsion/#{f}" }

data/lib/adhearsion/call.rb

@@ -3,6 +3,8 @@
 require 'has_guarded_handlers'
 require 'thread'
 require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'adhearsion'
 
 module Adhearsion
   ##
@@ -48,9 +50,12 @@ module Adhearsion
     # @return [Time] the time at which the call began. For inbound calls this is the time at which the call was offered to Adhearsion. For outbound calls it is the time at which the remote party answered.
     attr_reader :end_time
 
-    # @return [true, false] wether or not the call should be automatically hung up after executing its controller
+    # @return [true, false] whether or not the call should be automatically hung up after executing its controller
     attr_accessor :auto_hangup
 
+    # @return [Integer] the number of seconds after the call is hung up that the controller will remain active
+    attr_accessor :after_hangup_lifetime
+
     delegate :[], :[]=, :to => :variables
 
     # @return [String] the value of the To header from the signaling protocol
@@ -82,6 +87,7 @@ module Adhearsion
       @peers        = {}
       @duration     = nil
       @auto_hangup  = true
+      @after_hangup_lifetime = nil
 
       self << offer if offer
     end
@@ -230,7 +236,7 @@ module Adhearsion
       end
 
       on_end do |event|
-        logger.info "Call ended due to #{event.reason}"
+        logger.info "Call #{from} -> #{to} ended due to #{event.reason}#{" (code #{event.platform_code})" if event.platform_code}"
         @end_time = event.timestamp.to_time
         @duration = @end_time - @start_time if @start_time
         clear_from_active_calls
@@ -238,7 +244,7 @@ module Adhearsion
         @end_code = event.platform_code
         @end_blocker.broadcast event.reason
         @commands.terminate
-        after(Adhearsion.config.platform.after_hangup_lifetime) { terminate }
+        after(@after_hangup_lifetime || Adhearsion.config.platform.after_hangup_lifetime) { terminate }
       end
     end
 
@@ -295,15 +301,41 @@ module Adhearsion
 
     def accept(headers = nil)
       @accept_command ||= write_and_await_response Punchblock::Command::Accept.new(:headers => headers)
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     def answer(headers = nil)
       write_and_await_response Punchblock::Command::Answer.new(:headers => headers)
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     def reject(reason = :busy, headers = nil)
       write_and_await_response Punchblock::Command::Reject.new(:reason => reason, :headers => headers)
       Adhearsion::Events.trigger_immediately :call_rejected, call: current_actor, reason: reason
+    rescue Punchblock::ProtocolError => e
+      abort e
+    end
+
+    #
+    # Redirect the call to some other target system.
+    #
+    # If the redirect is successful, the call will be released from the
+    # telephony engine and Adhearsion will lose control of the call.
+    #
+    # Note that for the common case, this will result in a SIP 302 or
+    # SIP REFER, which provides the caller with a new URI to dial. As such,
+    # the redirect target cannot be any telephony-engine specific address
+    # (such as sofia/gateway, agent/101, or SIP/mypeer); instead it should be a
+    # fully-qualified external SIP URI that the caller can independently reach.
+    #
+    # @param [String] to the target to redirect to, eg a SIP URI
+    # @param [Hash, optional] headers a set of headers to send along with the redirect instruction
+    def redirect(to, headers = nil)
+      write_and_await_response Punchblock::Command::Redirect.new(to: to, headers: headers)
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     def hangup(headers = nil)
@@ -311,6 +343,8 @@ module Adhearsion
       logger.info "Hanging up"
       @end_reason = true
       write_and_await_response Punchblock::Command::Hangup.new(:headers => headers)
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     # @private
@@ -349,24 +383,30 @@ module Adhearsion
       command = Punchblock::Command::Join.new options.merge(join_options_with_target(target))
       write_and_await_response command
       {command: command, joined_condition: joined_condition, unjoined_condition: unjoined_condition}
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     ##
     # Unjoins this call from another call or a mixer
     #
-    # @param [Call, String, Hash] target the target to unjoin from. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)
+    # @param [Call, String, Hash, nil] target the target to unjoin from. May be a Call object, a call ID (String, Hash), a mixer name (Hash) or missing to unjoin from every existing join (nil)
     # @option target [String] call_uri The call ID to unjoin from
     # @option target [String] mixer_name The mixer to unjoin from
     #
-    def unjoin(target)
+    def unjoin(target = nil)
       logger.info "Unjoining from #{target}"
       command = Punchblock::Command::Unjoin.new join_options_with_target(target)
       write_and_await_response command
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     # @private
     def join_options_with_target(target)
       case target
+      when nil
+        {}
       when Call
         { :call_uri => target.uri }
       when String
@@ -402,10 +442,14 @@ module Adhearsion
 
     def mute
       write_and_await_response Punchblock::Command::Mute.new
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     def unmute
       write_and_await_response Punchblock::Command::Unmute.new
+    rescue Punchblock::ProtocolError => e
+      abort e
     end
 
     # @private

data/lib/adhearsion/call_controller.rb

@@ -1,18 +1,17 @@
 # encoding: utf-8
 
 require 'countdownlatch'
+%w(
+  dial
+  input
+  menu_dsl
+  output
+  record
+  utility
+).each { |r| require "adhearsion/call_controller/#{r}" }
 
 module Adhearsion
   class CallController
-    extend ActiveSupport::Autoload
-
-    autoload :Dial
-    autoload :Input
-    autoload :MenuDSL
-    autoload :Output
-    autoload :Record
-    autoload :Utility
-
     include Dial
     include Input
     include Output
@@ -21,7 +20,7 @@ module Adhearsion
 
     class_attribute :callbacks
 
-    self.callbacks = {:before_call => [], :after_call => []}
+    self.callbacks = {:before_call => [], :after_call => [], :on_error => []}
 
     self.callbacks.keys.each do |name|
       class_eval <<-STOP
@@ -119,9 +118,10 @@ module Adhearsion
       execute_callbacks :before_call
       run
     rescue Call::Hangup, Call::ExpiredError
-      logger.info "Call was hung up while executing a controller"
     rescue SyntaxError, StandardError => e
       Events.trigger :exception, [e, logger]
+      on_error e
+      raise
     ensure
       after_call
       logger.debug "Finished executing controller #{self.inspect}"
@@ -195,6 +195,12 @@ module Adhearsion
       @after_call ||= execute_callbacks :after_call
     end
 
+    # @private
+    def on_error(e)
+      @error = e
+      @on_error ||= execute_callbacks :on_error
+    end
+
     # @private
     def write_and_await_response(command)
       block_until_resumed
@@ -202,6 +208,7 @@ module Adhearsion
       if command.is_a?(Punchblock::Component::ComponentNode)
         command.register_event_handler Punchblock::Event::Complete do |event|
           @active_components.delete command
+          throw :pass
         end
         @active_components << command
       end
@@ -250,6 +257,17 @@ module Adhearsion
       raise Call::Hangup
     end
 
+    #
+    # Redirect the call to some other target
+    #
+    # @see Call#redirect
+    #
+    def redirect(*args)
+      block_until_resumed
+      call.redirect(*args)
+      raise Call::Hangup
+    end
+
     #
     # Mute the call
     #