adhearsion 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9155fcf025c8ed90e014e5262b70387e46e31937
-  data.tar.gz: dcb5d1f0104f854e3b487f34cf199e3134d5d38d
+  metadata.gz: 514090f6f124b09e72ebe60bea5691b5bbad141e
+  data.tar.gz: 3cb8255d9057e5a7731ea5960cb98406e1bdb3d4
 SHA512:
-  metadata.gz: 00076ee1fdd8a0d208dc1895dbb74f33f5c0adc23a2348248c0c8938378715d2bd40b7f8bfe64e42b05d2cd3e9594a0159d00af5b64f8e3285e37d2336249011
-  data.tar.gz: 7b1e9f478d6860f662e485a1c5add9e69ed0d1c2cf0f1d038ed661c47e2fd791224855bd452d89c79c09b18ebec16988df30af6650fb03870b77cde1f190ab14
+  metadata.gz: 2f4e33832002eb3201f8fc77782972ec63ce07b65a81429e5b875a366aa4ea66daa7ca6ffa4f84bd6d8b3582c1ad12255c44bb07249c8dd2b047ff96fc78d29a
+  data.tar.gz: 0432281ea39a81eb779a6ffedfe69d6817afd64b5be958d3fd128effe329c55525d366506b18d1ea0a2fe93208826d2d536600160b4b53d4e806ca512ab79d65

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby-19mode
+  - jruby
   - rbx-2.1.1
   - ruby-head
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.5.2](https://github.com/adhearsion/adhearsion/compare/v2.5.1...v2.5.2) - [2014-04-11](https://rubygems.org/gems/adhearsion/versions/2.5.2)
+  * All changes from 2.5.1 (re-released)
+  * Further fix for outbound call race conditions. When a Rayo server does not support client-supplied outbound call URIs, or refuses a requested URI by silently replacing it with a different one, the behaviour of Adhearsion falls back to the one with a race condition.
+
+# [2.5.1](https://github.com/adhearsion/adhearsion/compare/v2.5.0...v2.5.1) - [2014-04-07](https://rubygems.org/gems/adhearsion/versions/2.5.1) - yanked
+  * Bugfix: Avoid race conditions in event delivery for outbound calls. **note: This requires a Rayo server compliant with Rayo v0.4, which includes changes outlined in [rayo/xmpp#89](https://github.com/rayo/xmpp/issues/89). For FreeSWITCH mod_rayo, this means v1.2.23 of FreeSWITCH or the latest v1.2.stable branch.**([#439](https://github.com/adhearsion/adhearsion/issues/444))
+  * Bugfix: Fix some omissions in 2.5.0 relating to the new application layout ([#439](https://github.com/adhearsion/adhearsion/pull/439))
+  * Bugfix: Log to correct file when supplying an absolute path
+  * Bugfix: Delay configuring plugins until after initialisation. Allows plugin config to use things which are not set until initialisation like the current working directory, Adhearsion.root, etc. ([adhearsion/adhearsion-i18n#4](https://github.com/adhearsion/adhearsion-i18n/issues/4))
+  * Bugfix: Calls which are dead but can still be found now log a warning when receiving events
+  * Bugfix: Cleanup generated application routes spacing
+  * Bugfix: Use Rayo event timestamps for timing call operations. These timestamps are more accurate than using the time of event processing since event delivery/processing might be delayed due to network conditions or application load. This enables more reliable billing. ([#454](https://github.com/adhearsion/adhearsion/pull/454))
+  * Bugfix: Plugins should be more comprehensively loaded for rake tasks
+  * Bugfix: Millisecond-level timestamps now appear not only STDOUT, but in the default adhearsion.log as well.
+
 # [2.5.0](https://github.com/adhearsion/adhearsion/compare/v2.4.0...v2.5.0) - [2014-02-03](https://rubygems.org/gems/adhearsion/versions/2.5.0)
   * **Change: Ruby 1.9.2 is no longer supported**
   * Change: Set default call post-hangup lifetime to one second for better out of the box performance.

data/adhearsion.gemspec

@@ -33,7 +33,7 @@ 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.3"]
+  s.add_runtime_dependency 'punchblock', ["~> 2.4"]
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'ruby_speech', ["~> 2.0"]
   s.add_runtime_dependency 'thor', "~> 0.18.0"
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'guard-cucumber'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rspec', ["~> 2.11"]
+  s.add_development_dependency 'rspec', ["~> 2.13"]
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'
   s.add_development_dependency 'yard'

data/lib/adhearsion.rb

@@ -73,7 +73,7 @@ module Adhearsion
       _config = Configuration.new
       env = environment.to_sym if environment.respond_to? :to_sym
       unless _config.valid_environment? env
-        puts  "You tried to initialize with an invalid environment name #{env}. Valid values are #{_config.valid_environments}."
+        puts  "You tried to initialize with an invalid environment name #{env}; environment-specific config may not load successfully. Valid values are #{_config.valid_environments}."
         env = nil
       end
       _config.platform.environment = env if env
@@ -101,8 +101,7 @@ module Adhearsion
     end
 
     def active_calls
-      Celluloid::Actor[:active_calls] || Calls.supervise_as(:active_calls)
-      Celluloid::Actor[:active_calls]
+      @active_calls ||= Calls.new
     end
 
     #

data/lib/adhearsion/call.rb

@@ -17,7 +17,7 @@ module Adhearsion
     include Celluloid
     include HasGuardedHandlers
 
-    execute_block_on_receiver :register_handler, :register_tmp_handler, :register_handler_with_priority, :register_event_handler, :on_joined, :on_unjoined, :on_end, :execute_controller, *execute_block_on_receiver
+    execute_block_on_receiver :register_handler, :register_tmp_handler, :register_handler_with_priority, :register_handler_with_options, :register_event_handler, :on_joined, :on_unjoined, :on_end, :execute_controller, *execute_block_on_receiver
     finalizer :finalize
 
     def self.new(*args, &block)
@@ -195,7 +195,7 @@ module Adhearsion
       register_event_handler Punchblock::Event::Offer do |offer|
         @offer  = offer
         @client = offer.client
-        @start_time = Time.now
+        @start_time = offer.timestamp.to_time
       end
 
       register_event_handler Punchblock::HasHeaders do |event|
@@ -231,7 +231,7 @@ module Adhearsion
 
       on_end do |event|
         logger.info "Call ended due to #{event.reason}"
-        @end_time = Time.now
+        @end_time = event.timestamp.to_time
         @duration = @end_time - @start_time if @start_time
         clear_from_active_calls
         @end_reason = event.reason
@@ -439,7 +439,11 @@ module Adhearsion
       abort Hangup.new(@end_reason) unless active? || command.is_a?(Punchblock::Command::Hangup)
       merge_headers command.headers if command.respond_to? :headers
       logger.debug "Executing command #{command.inspect}"
-      client.execute_command command, call_id: id, domain: domain, async: true
+      unless command.is_a?(Punchblock::Command::Dial)
+        command.target_call_id = id
+        command.domain = domain
+      end
+      client.execute_command command
     end
 
     ##

data/lib/adhearsion/call_controller/dial.rb

@@ -110,7 +110,7 @@ module Adhearsion
         # Links the lifecycle of the originating call to the Dial operation such that the Dial is unblocked when the originating call ends
         def track_originating_call
           @call.on_end do |_|
-            logger.info "Root call ended, unblocking everything..."
+            logger.debug "Root call ended, unblocking connected calls"
             @waiters.each do |latch|
               latch.countdown! until latch.count == 0
             end
@@ -163,7 +163,7 @@ module Adhearsion
               pre_confirmation_tasks new_call
 
               new_call.on_unjoined @call do |unjoined|
-                join_status.ended
+                join_status.ended unjoined.timestamp.to_time
                 unless @splitting
                   new_call["dial_countdown_#{@id}"] = true
                   @latch.countdown!
@@ -520,8 +520,8 @@ module Adhearsion
           @result = :joined
         end
 
-        def ended
-          @end_time = Time.now
+        def ended(time)
+          @end_time = time
         end
       end
 

data/lib/adhearsion/call_controller/record.rb

@@ -15,7 +15,7 @@ module Adhearsion
         # @param [Adhearsion::CallController] controller on which to execute the recording
         # @param [Hash] options
         # @option options [Boolean, Optional] :async Execute asynchronously. Defaults to false
-        # @option options [Boolean, Optional] :start_beep Indicates whether subsequent record will be preceded with a beep. Default is true.
+        # @option options [Boolean, Optional] :start_beep Indicates whether subsequent record will be preceded with a beep. Default is false.
         # @option options [Boolean, Optional] :start_paused Whether subsequent record will start in PAUSE mode. Default is false.
         # @option options [String, Optional] :max_duration Indicates the maximum duration (seconds) for a recording.
         # @option options [String, Optional] :format File format used during recording.
@@ -108,7 +108,7 @@ module Adhearsion
       #
       # @param [Hash] options
       # @option options [Boolean, Optional] :async Execute asynchronously. Defaults to false
-      # @option options [Boolean, Optional] :start_beep Indicates whether subsequent record will be preceded with a beep. Default is true.
+      # @option options [Boolean, Optional] :start_beep Indicates whether subsequent record will be preceded with a beep. Default is false.
       # @option options [Boolean, Optional] :start_paused Whether subsequent record will start in PAUSE mode. Default is false.
       # @option options [String, Optional] :max_duration Indicates the maximum duration (seconds) for a recording.
       # @option options [String, Optional] :format File format used during recording.

data/lib/adhearsion/calls.rb

@@ -1,18 +1,24 @@
 # encoding: utf-8
 
+require 'thread'
+
 module Adhearsion
   ##
   # This manages the list of calls the Adhearsion service receives
-  class Calls < Hash
-    include Celluloid
-
-    trap_exit :call_died
+  class Calls
+    def initialize
+      @mutex = ::Monitor.new
+      @calls = {}
+      restart_supervisor
+    end
 
     def <<(call)
-      link call
-      self[call.id] = call
-      by_uri[call.uri] = call
-      current_actor
+      @supervisor.link call
+      @mutex.synchronize do
+        self[call.id] = call
+        by_uri[call.uri] = call
+      end
+      self
     end
 
     def remove_inactive_call(call)
@@ -40,6 +46,11 @@ module Adhearsion
       by_uri[uri]
     end
 
+    def restart_supervisor
+      @supervisor.terminate if @supervisor
+      @supervisor = Supervisor.new self
+    end
+
     private
 
     def by_uri
@@ -53,18 +64,34 @@ module Adhearsion
 
     def call_is_dead?(call)
       !call.alive?
-    rescue NoMethodError
+    rescue ::NoMethodError
       false
     end
 
-    def call_died(call, reason)
-      catching_standard_errors do
-        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
+    def method_missing(method, *args, &block)
+      @mutex.synchronize do
+        @calls.send method, *args, &block
+      end
+    end
+
+    class Supervisor
+      include Celluloid
+
+      trap_exit :call_died
+
+      def initialize(collection)
+        @collection = collection
+      end
+
+      def call_died(call, reason)
+        catching_standard_errors do
+          call_id = @collection.key call
+          @collection.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
     end
   end

data/lib/adhearsion/generators/app/templates/Gemfile.erb

@@ -2,9 +2,10 @@ source 'https://rubygems.org'
 
 gem 'adhearsion', '~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>'
 
-# Adhearsion depends on the Punchblock library, but here you can specify the major version your application depends on.
-# Exercise care when updating the major version, since you might encounter API compatability in parts of your Adhearsion application that rely on the Punchblock API.
-# On occasion, an update of Adhearsion might necessitate an update to Punchblock. You will have to manually allow that here, and take care in the upgrade.
+# Exercise care when updating the Punchblock major version, since Adhearsion
+# apps sometimes make use of underlying features from the Punchblock API.
+# Occasionally an update of Adhearsion will necessitate an update to
+# Punchblock; in those cases update this line and test your app thoroughly.
 gem 'punchblock', '~> <%= require "punchblock/version"; Punchblock::VERSION.split('.')[0,2].join('.') %>'
 
 # This is here by default due to deprecation of #ask and #menu.

data/lib/adhearsion/generators/app/templates/README.md

@@ -9,12 +9,13 @@ Edit `extensions.conf` to include the following:
 ```
 [your_context_name]
 exten => _.,1,AGI(agi:async)
+
+[adhearsion-redirect]
+exten => 1,1,AGI(agi:async)
 ```
 
 and setup a user in `manager.conf` with read/write access to `all`.
 
-If you are using Asterisk 1.8, you will need to add an additional context with the name `adhearsion-redirect`. On Asterisk 10 and above this is auto-provisioned.
-
 ## FreeSWITCH
 
 * Ensure that mod_rayo is installed and configured according to its' documentation.

data/lib/adhearsion/generators/app/templates/routes.erb

@@ -1,19 +1,18 @@
 # encoding: utf-8
 
-<% unless options[:empty] %>
+<% unless options[:empty] -%>
 require 'call_controllers/simon_game'
-<% end %>
 
+<% end -%>
 Adhearsion.router do
-<% if options[:empty] %>
+<% if options[:empty] -%>
   route 'default' do
 
   end
-<% else %>
-  #
+<% else -%>
+
   # Specify your call routes, directing calls with particular attributes to a controller
-  #
 
   route 'default', SimonGame
-<% end %>
+<% end -%>
 end

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

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'spec_helper'
+require 'call_controllers/simon_game'
 
 describe SimonGame do
 

data/lib/adhearsion/initializer.rb

@@ -40,6 +40,7 @@ module Adhearsion
     def start
       catch :boot_aborted do
         resolve_pid_file_path
+        configure_plugins
         load_lib_folder
         load_config_file
         load_events_file
@@ -217,10 +218,14 @@ module Adhearsion
       appenders.map! do |a|
         case a
         when String
-          f = File.expand_path(Adhearsion.config.root.dup.concat("/").concat(a)) unless a.start_with?("/")
+          f = if a.start_with?("/")
+            a
+          else
+            File.expand_path(Adhearsion.config.root.dup.concat("/").concat(a))
+          end
           ::Logging.appenders.file(f,
             :layout => ::Logging.layouts.pattern(
-              :pattern => Adhearsion::Logging.adhearsion_pattern
+              Adhearsion::Logging.adhearsion_pattern_options
             ),
            :auto_flushing => 2,
            :flush_period => 2
@@ -237,6 +242,10 @@ module Adhearsion
       end
     end
 
+    def configure_plugins
+      Plugin.configure_plugins
+    end
+
     def init_plugins
       Plugin.init_plugins
     end

data/lib/adhearsion/logging.rb

@@ -34,8 +34,11 @@ module Adhearsion
         :date     => [:bold, :blue],
         :logger   => :cyan
 
-      def adhearsion_pattern
-        '[%d] %-5l %c: %m\n'
+      def adhearsion_pattern_options
+        {
+          :pattern      => '[%d] %-5l %c: %m\n',
+          :date_pattern => '%Y-%m-%d %H:%M:%S.%L'
+        }
       end
 
       # Silence Adhearsion's logging, printing only FATAL messages
@@ -87,9 +90,9 @@ module Adhearsion
         [::Logging.appenders.stdout(
            'stdout',
            :layout => ::Logging.layouts.pattern(
-             :pattern => adhearsion_pattern,
-             :date_pattern => "%Y-%m-%d %H:%M:%S.%L",
-             :color_scheme => 'bright'
+             adhearsion_pattern_options.merge(
+               :color_scheme => 'bright'
+             )
            ),
            :auto_flushing => 2,
            :flush_period => 2

data/lib/adhearsion/outbound_call.rb

@@ -33,11 +33,19 @@ module Adhearsion
     end
 
     def id
-      dial_command.target_call_id if dial_command
+      if dial_command
+        dial_command.target_call_id || @id
+      else
+        @id
+      end
     end
 
     def domain
-      dial_command.domain if dial_command
+      if dial_command
+        dial_command.domain || @domain
+      else
+        @domain
+      end
     end
 
     def client
@@ -73,17 +81,35 @@ module Adhearsion
         wait_timeout = 60
       end
 
-      write_and_await_response(Punchblock::Command::Dial.new(options), wait_timeout, true).tap do |dial_command|
-        @dial_command = dial_command
-        Adhearsion.active_calls << current_actor
+      uri = client.new_call_uri
+      options[:uri] = uri
+
+      @dial_command = Punchblock::Command::Dial.new(options)
+
+      ref = Punchblock::Ref.new uri: uri
+      @transport = ref.scheme
+      @id = ref.call_id
+      @domain = ref.domain
+
+      Adhearsion.active_calls << current_actor
+
+      write_and_await_response(@dial_command, wait_timeout, true).tap do |dial_command|
+        if @dial_command.uri != self.uri
+          logger.warn "Requested call URI (#{uri}) was not respected. Tracking by new URI #{self.uri}. This might cause a race in event handling, please upgrade your Rayo server."
+          Adhearsion.active_calls << current_actor
+          Adhearsion.active_calls.delete(@id)
+        end
         Adhearsion::Events.trigger_immediately :call_dialed, current_actor
       end
+    rescue
+      clear_from_active_calls
+      raise
     end
 
     # @private
     def register_initial_handlers
       super
-      on_answer { |event| @start_time = Time.now }
+      on_answer { |event| @start_time = event.timestamp.to_time }
     end
 
     def run_router
@@ -115,7 +141,11 @@ module Adhearsion
     private
 
     def transport
-      dial_command.transport if dial_command
+      if dial_command
+        dial_command.transport || @transport
+      else
+        @transport
+      end
     end
   end
 end