adhearsion 2.3.5 → 2.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce13923a79ebf09d66a57ac08187110885e8ab19
-  data.tar.gz: 893aa45657fc58b288d44693b60afbe493449997
+  metadata.gz: 0e1b64f1b1643fc319f4203fbf8e6cf2452c444d
+  data.tar.gz: f533f739a9536421599852a4f049407b287b30b1
 SHA512:
-  metadata.gz: 54bc58e3bef695e4a2edcdc29d15833ce9a5954fc8c0dabab4fd7fc35f3bfac52f74c09ad5ed591242740c53553af1728441288143b7d3028d1edafae7f1629b
-  data.tar.gz: 0173249d5786ffdcf9e96884ec6b271e97b3f1cfacfd9c3674b392e0d73edb4379c163ab62d7d29bc03686a71c69a4c677387bc5466b1001b2ce246a4152a96c
+  metadata.gz: bb6cad9f60e451a309f4e98b5cdb61e19835032e44f053cba58598b9dc4b188abc1d089802d9c596566c3ebdc107e2fec1d61e5a4e26c5f0bfca24bb6f6e5ed8
+  data.tar.gz: 803b943cbebf981da00a580e46151dad0fc86bb188ccb89171e759461cbb03f889355c159e9b9ad67f77a2d5bb149717e85ae10ff96428128bdbff43aff528f5

data/.travis.yml

@@ -10,7 +10,6 @@ matrix:
   allow_failures:
     - rvm: rbx-19mode
     - rvm: ruby-head
-    - rvm: jruby-19mode
 env: ARUBA_TIMEOUT=120 RAILS_ENV=development AHN_ENV=development
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.4.0.beta1](https://github.com/adhearsion/adhearsion/compare/v2.3.5...v2.4.0.beta1) - [2013-08-20](https://rubygems.org/gems/adhearsion/versions/2.4.0.beta1)
+  * Feature: Add Call#wait_for_end, which blocks until the call ends and returns its end reason
+  * Feature: Add joined call attribute to dial status
+  * Feature: Track call start/end time and duration
+  * Feature: Add per-call join duration and disposition to DialStatus
+  * Feature: Add `CallController#dial_and_confirm` which allows parallel confirmation of outbound calls
+  * Feature: Add `#originate` method to console as alias for `Adhearsion::OutboundCall.originate`
+  * Feature: Allow the console to be disabled using `--no-console`
+  * Feature: Add CLI options to generate hooks for a plugin to register on [ahnhub.com](http://www.ahnhub.com)
+  * Bugfix: Removed unnecessary Mocha reference from generated plugin
+  * Bugfix: Call loggers should be deleted after a call finishes
+  * Bugfix: A menu definition's block context is now available
+  * Bugfix: Ensure call's command registry is not leaked outside the actor
+
 # [2.3.5](https://github.com/adhearsion/adhearsion/compare/v2.3.4...v2.3.5) - [2013-06-06](https://rubygems.org/gems/adhearsion/versions/2.3.5)
   * Bugfix: Fix race conditions in barging in before output start is acknowledged
   * Performance enhancement: Use Celluloid's thread pool for call controller threads to reduce thread setup overhead

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'activesupport', '~> 3.0' if RUBY_VERSION == "1.9.2"

data/README.markdown

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/adhearsion.png)](https://rubygems.org/gems/adhearsion)
+[![Build Status](https://secure.travis-ci.org/adhearsion/adhearsion.png?branch=develop)](http://travis-ci.org/adhearsion/adhearsion)
+[![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)
+
 # Adhearsion
 
 Adhearsion is an open-source voice application development framework. Adhearsion users write applications atop the framework with Ruby and **call into their code**.
@@ -24,6 +30,12 @@ Adhearsion rests above a lower-level telephony platform, for example [Asterisk](
   * Prism 11+ with rayo-server
 * An interest in building cool new things
 
+\* Support for Ruby 1.9.2 is deprecated, and requires locking your application to ActiveSupport 3.x as follows:
+
+```ruby
+gem 'active_support', '~> 3.0'
+```
+
 ## Install
 
 `gem install adhearsion`
@@ -47,7 +59,14 @@ Visit [Adhearsion's website](http://adhearsion.com) for code examples and more i
 
 If you're having trouble, you may want to try asking your question on the IRC channel (#adhearsion on irc.freenode.net), [mailing list](http://groups.google.com/group/adhearsion) or, if you've found a bug, report it on the [bug tracker](https://github.com/adhearsion/adhearsion/issues).
 
-## Author
+## Related Projects
+
+These Open Source projects are also maintained by members of the Adhearsion team and may be useful when developing Adhearsion apps:
+
+* [Telephony-Dev-Box](https://github.com/mojolingo/Telephony-Dev-Box) is a system for creating virtual machines that will preconfigure Adhearsion, Asterisk, FreeSWITCH and PRISM together.  Just add a SIP client and start calling your app!
+* [SippyCup](https://github.com/bklang/sippy_cup) makes generating [SIPp](http://sipp.sourceforge.net/) profiles and RTP media easy.  Useful for load testing your apps and telephony infrastructure.
+
+## Authors
 
 Core team:
 
@@ -66,4 +85,4 @@ There is a pre-commit hook that runs encoding checks available in pre-commit. To
 
 ### Copyright
 
-Copyright (c) 2013 Adhearsion Foundation Inc. MIT LICENSE (see LICENSE for details).
+Copyright (c) 2011-2013 Adhearsion Foundation Inc. MIT LICENSE (see LICENSE for details).

data/adhearsion.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'activesupport', ["~> 3.0"]
+  s.add_runtime_dependency 'activesupport', [">= 3.0.0", "< 5.0.0"]
   s.add_runtime_dependency 'adhearsion-loquacious', ["~> 1.9"]
   s.add_runtime_dependency 'bundler', ["~> 1.0"]
   s.add_runtime_dependency 'celluloid', ["~> 0.14"]
@@ -29,9 +29,9 @@ 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', ["~> 1.4"]
+  s.add_runtime_dependency 'punchblock', ["~> 2.0.0.beta1"]
   s.add_runtime_dependency 'rake'
-  s.add_runtime_dependency 'ruby_speech', ["~> 1.0"]
+  s.add_runtime_dependency 'ruby_speech', ["~> 2.0"]
   s.add_runtime_dependency 'thor', "~> 0.18.0"
 
   s.add_development_dependency 'aruba', "~> 0.5"
@@ -40,8 +40,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard-cucumber'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'rspec', ["~> 2.11"]
-  s.add_development_dependency 'ruby_gntp'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'timecop'
 end

data/features/cli_plugin.feature

@@ -0,0 +1,41 @@
+Feature: Adhearsion Ahn CLI (Plugin)
+  As an Adhearsion user
+  I want a cli command (ahn plugin)
+  So that I can perform actions for adhearsion plugins
+
+  Scenario: No arguments given
+    When I run `ahn plugin`
+    Then I should see the plugin usage message
+    And the exit status should be 0
+
+  Scenario: Unrecognized commands
+    When I run `ahn plugin alpha beta`
+    Then the output should contain:
+    """
+    Could not find command "alpha"
+    """
+    And the exit status should be 1
+
+  Scenario: Command help
+    When I run `ahn plugin help`
+    Then I should see the plugin usage message
+    And the exit status should be 0
+
+  Scenario: Command create_rubygem_hook
+    When I run `ahn plugin create_rubygem_hook` interactively
+    And I type "foobar"
+    And I type "SECRET_CODE"
+    Then the output should contain:
+    """
+    Access Denied. Please sign up for an account at http://rubygems.org
+    """
+
+  Scenario: Command create_github_hook
+    When I run `ahn plugin create_github_hook` interactively
+    And I type "username"
+    And I type "SECRET_CODE"
+    And I type "adhearsion/new_plugin"
+    Then the output should contain:
+    """
+    {"message":
+    """

data/features/cli_start.feature

@@ -12,8 +12,8 @@ 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
-    Given that I create a valid app under "path/somewhere"
+    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
     And I wait for output to contain "Starting connection to server"
@@ -21,9 +21,17 @@ 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
-    Given that I create a valid app under "path/somewhere"
+    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"
     Then the output should contain "Adhearsion::Console: Launching Adhearsion Console"
     And the output should contain "Adhearsion shut down"
+
+  Scenario: Starting without the console
+    Given that I create a valid app under "path/somewhere"
+    When I cd to "path/somewhere"
+    And I run `ahn start --no-console` interactively
+    And I wait for output to contain "Starting connection to server"
+    Then the output should not contain "Adhearsion::Console: Launching Adhearsion Console"
+    And the output should contain "Adhearsion shut down"

data/features/step_definitions/cli_steps.rb

@@ -6,10 +6,19 @@ Then /^I should see the usage message$/ do
     Then the output should contain "ahn start"
     Then the output should contain "ahn daemon"
     Then the output should contain "ahn version"
+    Then the output should contain "ahn plugin"
     Then the output should contain "ahn help"
   }
 end
 
+Then /^I should see the plugin usage message$/ do
+  steps %Q{
+    Then the output should contain "ahn plugin create_ahnhub_hooks"
+    Then the output should contain "ahn plugin create_github_hook"
+    Then the output should contain "ahn plugin create_rubygem_hook"
+  }
+end
+
 When /^I wait (\d+) seconds?$/ do |arg1|
   sleep arg1.to_i
 end
@@ -19,6 +28,8 @@ Given /^that I create a valid app under "([^"]*)"$/ do |path|
     When I run `ahn create #{path}`
     Then there should be a valid adhearsion directory named "#{path}"
   }
+
+  remove_file "#{path}/Gemfile"
 end
 
 Then /^there should be a valid adhearsion directory named "([^"]*)"$/ do |path|
@@ -55,3 +66,4 @@ When /^I terminate the process using the pid file "([^"]*)"$/ do |pidfile|
     sleep 1
   end
 end
+

data/features/support/env.rb

@@ -8,7 +8,7 @@ require 'aruba/cucumber'
 require 'adhearsion'
 
 Before do
-  @aruba_timeout_seconds = ENV['ARUBA_TIMEOUT'] || RUBY_PLATFORM == 'java' ? 60 : 30
+  @aruba_timeout_seconds = ENV.has_key?('ARUBA_TIMEOUT') ? ENV['ARUBA_TIMEOUT'].to_i : (RUBY_PLATFORM == 'java' ? 60 : 30)
   ENV['AHN_PUNCHBLOCK_RECONNECT_ATTEMPTS'] = '0'
   ENV['AHN_PUNCHBLOCK_PORT'] = '1'
 end

data/features/support/utils.rb

@@ -4,7 +4,6 @@ Given /^PENDING/ do
   pending
 end
 
-
 Given /^JRuby skip test/ do
   pending "Daemonize not supported under JRuby" if RUBY_PLATFORM == 'java'
 end

data/lib/adhearsion.rb

@@ -73,7 +73,10 @@ module Adhearsion
       _config = Configuration.new
       env = ENV['AHN_ENV'] || ENV['RAILS_ENV']
       env = env.to_sym if env.respond_to? :to_sym
-      env = nil unless _config.valid_environment? env
+      unless _config.valid_environment? env
+        puts  "You tried to initialize with an invalid environment name #{env}. Valid values are #{_config.valid_environments}."
+        env = nil
+      end
       _config.platform.environment = env if env
       _config
     end

data/lib/adhearsion/call.rb

@@ -2,6 +2,7 @@
 
 require 'has_guarded_handlers'
 require 'thread'
+require 'active_support/hash_with_indifferent_access'
 
 module Adhearsion
   ##
@@ -17,6 +18,7 @@ module Adhearsion
     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
+    finalizer :finalize
 
     def self.new(*args, &block)
       super.tap do |proxy|
@@ -28,7 +30,7 @@ module Adhearsion
       end
     end
 
-    attr_reader :end_reason, :commands, :controllers, :variables
+    attr_reader :end_reason, :controllers, :variables, :start_time, :end_time
 
     delegate :[], :[]=, :to => :variables
     delegate :to, :from, :to => :offer, :allow_nil => true
@@ -39,10 +41,12 @@ module Adhearsion
       @offer        = nil
       @tags         = []
       @commands     = CommandRegistry.new
-      @variables    = {}
+      @variables    = HashWithIndifferentAccess.new
       @controllers  = []
       @end_reason   = nil
+      @end_blocker  = Celluloid::Condition.new
       @peers        = {}
+      @duration     = nil
 
       self << offer if offer
     end
@@ -54,6 +58,25 @@ module Adhearsion
       offer.target_call_id if offer
     end
 
+    #
+    # @return [String, nil] The domain on which the call resides
+    #
+    def domain
+      offer.domain if offer
+    end
+
+    #
+    # @return [String, nil] The uri at which the call resides
+    #
+    def uri
+      return nil unless id
+      s = ""
+      s << transport << ":" if transport
+      s << id
+      s << "@" << domain if domain
+      s
+    end
+
     #
     # @return [Array] The set of labels with which this call has been tagged.
     #
@@ -97,6 +120,18 @@ module Adhearsion
       @peers.clone
     end
 
+    #
+    # Wait for the call to end. Returns immediately if the call has already ended, else blocks until it does so.
+    # @return [Symbol] the reason for the call ending
+    #
+    def wait_for_end
+      if end_reason
+        end_reason
+      else
+        @end_blocker.wait
+      end
+    end
+
     def register_event_handler(*guards, &block)
       register_handler :event, *guards, &block
     end
@@ -107,46 +142,65 @@ module Adhearsion
     end
     alias << deliver_message
 
+    def commands
+      @commands.clone
+    end
+
     # @private
     def register_initial_handlers
       register_event_handler Punchblock::Event::Offer do |offer|
         @offer  = offer
         @client = offer.client
+        @start_time = Time.now
         throw :pass
       end
 
       register_event_handler Punchblock::HasHeaders do |event|
-        variables.merge! event.headers_hash
+        merge_headers event.headers
         throw :pass
       end
 
       on_joined do |event|
-        target = event.call_id || event.mixer_name
+        target = event.call_uri || event.mixer_name
         @peers[target] = Adhearsion.active_calls[target]
         signal :joined, target
       end
 
       on_unjoined do |event|
-        target = event.call_id || event.mixer_name
+        target = event.call_uri || event.mixer_name
         @peers.delete target
         signal :unjoined, target
       end
 
       on_end do |event|
-        logger.info "Call ended"
+        logger.info "Call ended due to #{event.reason}"
+        @end_time = Time.now
+        @duration = @end_time - @start_time if @start_time
         clear_from_active_calls
         @end_reason = event.reason
-        commands.terminate
+        @end_blocker.broadcast event.reason
+        @commands.terminate
         after(Adhearsion.config.platform.after_hangup_lifetime) { terminate }
         throw :pass
       end
     end
 
+    # @return [Float] The call duration until the current time, or until the call was disconnected, whichever is earlier
+    def duration
+      if @duration
+        @duration
+      elsif @start_time
+        Time.now - @start_time
+      else
+        0.0
+      end
+    end
+
     ##
     # Registers a callback for when this call is joined to another call or a mixer
     #
     # @param [Call, String, Hash, nil] target the target to guard on. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)
-    # @option target [String] call_id The call ID to guard on
+    # @option target [String] call_uri The call ID to guard on
     # @option target [String] mixer_name The mixer name to guard on
     #
     def on_joined(target = nil, &block)
@@ -160,7 +214,7 @@ module Adhearsion
     # Registers a callback for when this call is unjoined from another call or a mixer
     #
     # @param [Call, String, Hash, nil] target the target to guard on. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)
-    # @option target [String] call_id The call ID to guard on
+    # @option target [String] call_uri The call ID to guard on
     # @option target [String] mixer_name The mixer name to guard on
     #
     def on_unjoined(target = nil, &block)
@@ -218,7 +272,7 @@ module Adhearsion
     # Joins this call to another call or a mixer
     #
     # @param [Call, String, Hash] target the target to join to. May be a Call object, a call ID (String, Hash) or a mixer name (Hash)
-    # @option target [String] call_id The call ID to join to
+    # @option target [String] call_uri The call ID to join to
     # @option target [String] mixer_name The mixer to join to
     # @param [Hash, Optional] options further options to be joined with
     #
@@ -231,7 +285,7 @@ module Adhearsion
     # 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)
-    # @option target [String] call_id The call ID to unjoin from
+    # @option target [String] call_uri The call ID to unjoin from
     # @option target [String] mixer_name The mixer to unjoin from
     #
     def unjoin(target)
@@ -243,11 +297,11 @@ module Adhearsion
     def join_options_with_target(target)
       case target
       when Call
-        { :call_id => target.id }
+        { :call_uri => target.uri }
       when String
-        { :call_id => target }
+        { :call_uri => "#{transport}:#{target}@#{domain}" }
       when Hash
-        abort ArgumentError.new "You cannot specify both a call ID and mixer name" if target.has_key?(:call_id) && target.has_key?(:mixer_name)
+        abort ArgumentError.new "You cannot specify both a call URI and mixer name" if target.has_key?(:call_uri) && target.has_key?(:mixer_name)
         target
       else
         abort ArgumentError.new "Don't know how to join to #{target.inspect}"
@@ -278,10 +332,11 @@ module Adhearsion
 
     # @private
     def write_and_await_response(command, timeout = 60)
-      commands << command
+      @commands << command
       write_command command
 
-      case (response = command.response timeout)
+      response = defer { command.response timeout }
+      case response
       when Punchblock::ProtocolError
         if response.name == :item_not_found
           abort Hangup.new(@end_reason)
@@ -295,21 +350,22 @@ module Adhearsion
       command
     rescue Timeout::Error
       abort CommandTimeout.new(command.to_s)
+    ensure
+      @commands.delete command
     end
 
     # @private
     def write_command(command)
       abort Hangup.new(@end_reason) unless active? || command.is_a?(Punchblock::Command::Hangup)
-      variables.merge! command.headers_hash if command.respond_to? :headers_hash
+      merge_headers command.headers if command.respond_to? :headers
       logger.debug "Executing command #{command.inspect}"
-      client.execute_command command, :call_id => id, :async => true
+      client.execute_command command, call_id: id, domain: domain, async: true
     end
 
     # @private
     def logger_id
-      "#{self.class}: #{id}"
+      "#{self.class}: #{id}@#{domain}"
     end
-
     # @private
     def to_ary
       [current_actor]
@@ -320,7 +376,7 @@ module Adhearsion
       attrs = [:offer, :end_reason, :commands, :variables, :controllers, :to, :from].map do |attr|
         "#{attr}=#{send(attr).inspect}"
       end
-      "#<#{self.class}:#{id} #{attrs.join ', '}>"
+      "#<#{self.class}:#{id}@#{domain} #{attrs.join ', '}>"
     end
 
     def execute_controller(controller = nil, completion_callback = nil, &block)
@@ -355,8 +411,22 @@ module Adhearsion
       @client
     end
 
+    def transport
+      offer.transport if offer
+    end
+
+    def merge_headers(headers)
+      headers.each do |name, value|
+        variables[name.to_s.downcase.gsub('-', '_')] = value
+      end
+    end
+
+    def finalize
+      ::Logging::Repository.instance.delete logger_id
+    end
+
     # @private
-    class CommandRegistry < ThreadSafeArray
+    class CommandRegistry < Array
       def terminate
         hangup = Hangup.new
         each { |command| command.response = hangup if command.requested? }