adhearsion 2.0.0.beta1 → 2.0.0.rc1

data/.travis.yml

@@ -5,8 +5,6 @@ rvm:
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-19mode # currently in active development, may or may not work for your project
   - ruby-head
-env: ARUBA_TIMEOUT=120
+env: ARUBA_TIMEOUT=120 RAILS_ENV=development AHN_ENV=development
 notifications:
-#  irc: "irc.freenode.org#adhearsion"
-  email:
-    - blangfeld@adhearsion.com
+  irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,4 +1,34 @@
-# 2.0.0.beta1 - 2012-03-07
+# [develop](https://github.com/adhearsion/adhearsion)
+
+# [2.0.0.rc1](https://github.com/adhearsion/adhearsion/compare/v2.0.0.beta1...v2.0.0.rc1) - [2012-03-20](https://rubygems.org/gems/adhearsion/versions/2.0.0.rc1)
+  * Change: `CallController#join` now blocks until a corresponding unjoined event is received
+  * Change: `CallController#speak` is now `CallController#say`
+  * Change: `CallController#input` has been removed in favour of `#ask`
+
+  * Feature: `CallController#menu` may now disallow the caller from interrupting prompts by specifying `:interruptible => false`
+  * Feature: `CallController#menu` and `CallController#ask` returns a `Result` object from which the status and response may be established
+  * Feature: `CallController#ask` behaves similarly to `#menu`, processing prompts and supporting `:terminator` and `:limit` options
+  * Feature: Added `Call#unjoin`
+  * Feature: `CallControll#join` now blocks until the corresponding call is unjoined and can be made non-blocking by passing `:async => true`
+  * Feature: `CallController#dial` now supports overriding or extra options for each call destinations
+  * Feature: Asterisk AMI events may now be handled using the `ami` handler
+  * Feature: Added environment debugging info when running at trace level, and by using `rake debugging`
+
+  * Bugfix: `ahn restart` now does not fail if the PID file is not found
+  * Bugfix: AHN_ENV and RAILS_ENV are now respected correctly
+  * Bugfix: `ahn` command now elminates all version mis-matches between installed and bundled gems
+  * Bugfix: Adhearsion is now ruby warning-free
+  * Bugfix: A hangup exception is now raised if call commands fail with a call-not-found
+  * Bugfix: `CallController#record` now functions as advertised
+  * Bugfix: The punchblock JID resource is not overriden if defined in config
+  * Bugfix: `DialStatus` objects returned from `CallController#dial` now include the cases where dials fail
+  * Bugfix: Calls are now processed after Punchblock reconnects
+  * Bugfix: Better exception logging
+  * Bugfix: Strings passed to `CallController#play` which contain `/` but are not file paths are now rendered as text
+  * Bugfix: Adhearsion now functions correctly on Heroku
+  * Cleaned up log messages
+
+# [2.0.0.beta1](https://github.com/adhearsion/adhearsion/compare/v2.0.0.alpha3...v2.0.0.beta1) - [2012-03-07](https://rubygems.org/gems/adhearsion/versions/2.0.0.beta1)
   * Bugfix: #speak now correctly casts the argument to string if it is not SSML
   * Bugfix: The console pauses controllers on a call while taking control
   * Feature: Reopen logfiles on SIGHUP
@@ -9,7 +39,7 @@
   * Feature: Punchblock plugin can now configure the active media engine (mostly for use on Asterisk)
   * Bugfix: Fix forcing Adhearsion to stop with enough SIGTERM or CTRL+C
 
-# 2.0.0.alpha3 - 2012-02-21
+# [2.0.0.alpha3](https://github.com/adhearsion/adhearsion/compare/v2.0.0.alpha2...v2.0.0.alpha3) - [2012-02-21](https://rubygems.org/gems/adhearsion/versions/2.0.0.alpha3)
   * Feature: Add `ahn generate` command to allow invocation of generators
   * Feature: Add simple generator for call controllers
   * Feature: Add simple generator for plugins
@@ -28,7 +58,7 @@
   * Feature: CallController#dial now defaults the outbound caller ID to that of the controller's call
   * Change: The command to take control of a call is now 'take' rather than 'use'. 'take' called without a call ID present a list of currently running calls
 
-# 2.0.0.alpha2 - 2012-01-30
+# [2.0.0.alpha2](https://github.com/adhearsion/adhearsion/compare/v2.0.0.alpha1...v2.0.0.alpha2) - [2012-01-30](https://rubygems.org/gems/adhearsion/versions/2.0.0.alpha2)
   * Change: Plugins no longer load dialplan/event/rpc/console methods using corresponding class methods
   * Feature: CallController and Console can have modules of methods mixed in using `CallController.mixin` and `Console.mixin`
   * Feature: Added the ability to override configuration using environment variables. The correct names are given when running `rake adhearsion:config:show`, and are automatically added for all plugins. Plugins may define how the string environment variable is transformed to be useful.
@@ -45,7 +75,7 @@
   * Bugfix: The console should be shut down when shutting down the process
   * Rake tasks cleaned up and some initialization bugs fixed
 
-# 2.0.0.alpha1 - 2012-01-17
+# [2.0.0.alpha1](https://github.com/adhearsion/adhearsion/compare/v1.2.1...v2.0.0.alpha1) - [2012-01-17](https://rubygems.org/gems/adhearsion/versions/2.0.0.alpha1)
 
 ## Major architectural changes
   * Adhearsion is no longer a framework for creating Asterisk applications, and it does not know anything about the specifics of Asterisk. Adhearsion now makes use of the Punchblock library which abstracts features from common telephony engines. Supported engines are now:

data/README.markdown

@@ -38,7 +38,7 @@ An Adhearsion application can be as simple as this:
 
 ```ruby
 answer
-speak 'Hello, and thank you for your call. We will put you through to the front desk now...'
+say 'Hello, and thank you for your call. We will put you through to the front desk now...'
 dial 'tel:+18005550199'
 hangup
 ```
@@ -69,6 +69,7 @@ Contributions
 -----------------------------
 
 Adhearsion has a set of [contribution guidelines](https://github.com/adhearsion/adhearsion/wiki/Contributing) which help to smooth the contribution process.
+There is a pre-commit hook that runs encoding checks available in pre-commit. To use it, please copy it to .git/hooks/pre-commit and make it executable.
 
 Copyright
 ---------

data/Rakefile

@@ -9,7 +9,9 @@ task :default => [:spec, :features]
 task :gem => :build
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
+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'
@@ -38,3 +40,22 @@ end
 task :stats do
   system 'doc/cloc-1.55.pl . --exclude-dir=.git,vendor,coverage,doc'
 end
+
+task :encodeify do
+  Dir['{bin,features,lib,spec}/**/*.rb'].each do |filename|
+    File.open filename do |file|
+      first_line = file.first
+      if first_line == "# encoding: utf-8\n"
+        puts "#{filename} is utf-8"
+      else
+        puts "Making #{filename} utf-8..."
+        File.unlink filename
+        File.open filename, "w" do |new_file|
+          new_file.write "# encoding: utf-8\n\n"
+          new_file.write first_line
+          new_file.write file.read
+        end
+      end
+    end
+  end
+end

data/adhearsion.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
   s.add_runtime_dependency 'ffi', [">= 1.0.11"]
   s.add_runtime_dependency 'celluloid', [">= 0.9.0"]
+  s.add_runtime_dependency 'deep_merge'
 
   # Development dependencies
   s.add_development_dependency 'rspec', ["~> 2.7.0"]

data/bin/ahn

@@ -22,8 +22,6 @@
 $:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
 
 require 'rubygems'
-require 'bundler/setup'
-require 'adhearsion'
 require 'adhearsion/cli'
 
 Adhearsion::CLI::AhnCommand.start

data/features/cli_daemon.feature

@@ -3,6 +3,7 @@ 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
   Scenario: Command daemon with path works correctly
     Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
@@ -11,6 +12,7 @@ Feature: Adhearsion Ahn CLI (daemon)
     And I terminate the process using the pid file "adhearsion.pid"
     Then the exit status should be 0
 
+  @reconnect
   Scenario: Command daemon with pid option
     Given JRuby skip test
     Given that I create a valid app under "path/somewhere"

data/features/cli_restart.feature

@@ -0,0 +1,19 @@
+Feature: Adhearsion Ahn CLI (stop)
+  As an Adhearsion user
+  I want the ahn command to provide a 'restart' command
+  So that I can restart a running Adhearsion daemon
+
+  @reconnect
+  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`
+    Then the output should contain:
+    """
+    Could not read pid from the file
+    """
+    And the output should contain:
+    """
+    Starting Adhearsion
+    """

data/features/cli_start.feature

@@ -17,17 +17,15 @@ Feature: Adhearsion Ahn CLI (start)
     When I cd to "path/somewhere"
     And I run `ahn start` interactively
     And I wait for output to contain "Starting connection to server"
-    And I terminate the interactive process
-    Then the output should contain "Adhearsion::Console: Starting up..."
+    Then the output should contain "Adhearsion::Console: Launching Adhearsion Console"
     And the output should contain "AHN>"
-    And the output should contain "Transitioning from booting to force_stop"
+    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"
     When I run `ahn start path/somewhere` interactively
     And I wait for output to contain "Starting connection to server"
-    And I terminate the interactive process
-    Then the output should contain "Adhearsion::Console: Starting up..."
+    Then the output should contain "Adhearsion::Console: Launching Adhearsion Console"
     And the output should contain "AHN>"
-    And the output should contain "Transitioning from booting to force_stop"
+    And the output should contain "Adhearsion shut down"

data/features/cli_stop.feature

@@ -3,6 +3,7 @@ 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
   Scenario: Command stop with valid path and pid option
     Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
@@ -14,6 +15,7 @@ Feature: Adhearsion Ahn CLI (stop)
     """
     And the file "ahn.pid" should not exist
 
+  @reconnect
   Scenario: Command stop with valid path and no pid option
     Given JRuby skip test
     Given that I create a valid app under "path/somewhere"
@@ -25,6 +27,7 @@ Feature: Adhearsion Ahn CLI (stop)
     """
     And the file "path/somewhere/adhearsion.pid" should not exist
 
+  @reconnect
   Scenario: Command stop with no options inside the app directory
     Given JRuby skip test
     Given that I create a valid app under "path/somewhere"

data/features/step_definitions/app_generator_steps.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 Then /^the file "([^"]*)" should contain each of these content parts:$/ do |file, content_parts|
   parts = content_parts.split
   parts.each do |p|

data/features/step_definitions/cli_steps.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'timeout'
 
 Then /^I should see the usage message$/ do

data/features/support/aruba_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Aruba
   module Api
     # output() blocks for stderr and stdout it seems

data/features/support/env.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'simplecov'
 require 'simplecov-rcov'
 class SimpleCov::Formatter::MergedFormatter
@@ -18,54 +20,14 @@ require 'cucumber'
 require 'aruba/cucumber'
 require 'adhearsion'
 
-module ChildProcess
-  class << self
-    def new(*args)
-      case os
-      when :unix, :macosx, :linux, :solaris, :bsd, :cygwin
-        if posix_spawn?
-          Unix::PosixSpawnProcess.new(args)
-        elsif jruby?
-          JRuby::Process.new(args)
-        else
-          Unix::ForkExecProcess.new(args)
-        end
-      when :windows
-        Windows::Process.new(args)
-      else
-        raise Error, "unsupported OS #{os.inspect}"
-      end
-    end
-    alias_method :build, :new
-
-    def os
-      @os ||= (
-        require "rbconfig"
-        host_os = RbConfig::CONFIG['host_os'].downcase
-
-        case host_os
-        when /linux/
-          :linux
-        when /darwin|mac os/
-          :macosx
-        when /mswin|msys|mingw32/
-          :windows
-        when /cygwin/
-          :cygwin
-        when /solaris|sunos/
-          :solaris
-        when /bsd/
-          :bsd
-        else
-          raise Error, "unknown os: #{host_os.inspect}"
-        end
-      )
-    end
-  end # class << self
-end # ChildProcess
-
 Before do
   @aruba_timeout_seconds = ENV['ARUBA_TIMEOUT'] || RUBY_PLATFORM == 'java' ? 60 : 30
+  ENV['AHN_PUNCHBLOCK_RECONNECT_ATTEMPTS'] = '0'
+  ENV['AHN_PUNCHBLOCK_PORT'] = '1'
+end
+
+Before '@reconnect' do
+  ENV['AHN_PUNCHBLOCK_RECONNECT_ATTEMPTS'] = '100'
 end
 
 # TODO: check for name space / run issues

data/features/support/utils.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 Given /^PENDING/ do
   pending
 end

data/lib/adhearsion.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 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.2, JRuby 1.6.5 or Rubinius 2.0." if RUBY_VERSION < "1.9.2"
 
 %w{
@@ -16,7 +18,7 @@ abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby
   celluloid
 
   adhearsion/version
-  adhearsion/foundation/all
+  adhearsion/foundation
 }.each { |f| require f }
 
 module Adhearsion
@@ -54,6 +56,7 @@ module Adhearsion
     def initialize_config
       _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
       _config.platform.environment = env if env
       _config
@@ -83,11 +86,6 @@ module Adhearsion
       Adhearsion::Process.state_name
     end
   end
-
-  Hangup             = Class.new StandardError # At the moment, we'll just use this to end a call-handling Thread
-  PlaybackError      = Class.new StandardError # Represents failure to play audio, such as when the sound file cannot be found
-  RecordError        = Class.new StandardError # Represents failure to record such as when a file cannot be written.
-  ConfigurationError = Class.new StandardError # Error raised while trying to configure a non existent plugin
 end
 
 Celluloid.exception_handler { |e| Adhearsion::Events.trigger :exception, e }

data/lib/adhearsion/call.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'thread'
 
 module Adhearsion
@@ -6,7 +8,9 @@ module Adhearsion
   #
   class Call
 
-    ExpiredError = Class.new Celluloid::DeadActorError
+    Hangup          = Class.new StandardError
+    ExpiredError    = Class.new Celluloid::DeadActorError
+    CommandTimeout  = Class.new StandardError
 
     include Celluloid
     include HasGuardedHandlers
@@ -15,7 +19,7 @@ module Adhearsion
       super.tap do |proxy|
         def proxy.method_missing(*args)
           super
-        rescue Celluloid::DeadActorError => e
+        rescue Celluloid::DeadActorError
           raise ExpiredError, "This call is expired and is no longer accessible"
         end
       end
@@ -33,6 +37,7 @@ module Adhearsion
       @commands     = CommandRegistry.new
       @variables    = {}
       @controllers  = []
+      @end_reason   = nil
 
       self << offer if offer
     end
@@ -84,7 +89,20 @@ module Adhearsion
         throw :pass
       end
 
+      register_event_handler Punchblock::Event::Joined do |event|
+        target = event.other_call_id || event.mixer_name
+        signal :joined, target
+        throw :pass
+      end
+
+      register_event_handler Punchblock::Event::Unjoined do |event|
+        target = event.other_call_id || event.mixer_name
+        signal :unjoined, target
+        throw :pass
+      end
+
       on_end do |event|
+        logger.info "Call ended"
         clear_from_active_calls
         @end_reason = event.reason
         commands.terminate
@@ -121,6 +139,7 @@ module Adhearsion
 
     def hangup(headers = nil)
       return false unless active?
+      logger.info "Hanging up"
       @end_reason = true
       write_and_await_response Punchblock::Command::Hangup.new(:headers => headers)
     end
@@ -138,24 +157,51 @@ module Adhearsion
     # @param [Hash, Optional] options further options to be joined with
     #
     def join(target, options = {})
-      case target
+      command = Punchblock::Command::Join.new join_options_with_target(target, options)
+      write_and_await_response command
+    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)
+    # @option target [String] call_id The call ID to unjoin from
+    # @option target [String] mixer_name The mixer to unjoin from
+    #
+    def unjoin(target)
+      command = Punchblock::Command::Unjoin.new join_options_with_target(target)
+      write_and_await_response command
+    end
+
+    def join_options_with_target(target, options = {})
+      options.merge(case target
       when Call
-        options[:other_call_id] = target.id
+        { :other_call_id => target.id }
       when String
-        options[:other_call_id] = target
+        { :other_call_id => target }
       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)
         target.tap do |t|
           t[:other_call_id] = t[:call_id]
           t.delete :call_id
         end
-
-        options.merge! target
       else
         abort ArgumentError.new "Don't know how to join to #{target.inspect}"
+      end)
+    end
+
+    def wait_for_joined(expected_target)
+      target = nil
+      until target == expected_target do
+        target = wait :joined
+      end
+    end
+
+    def wait_for_unjoined(expected_target)
+      target = nil
+      until target == expected_target do
+        target = wait :unjoined
       end
-      command = Punchblock::Command::Join.new options
-      write_and_await_response command
     end
 
     def mute
@@ -169,20 +215,28 @@ module Adhearsion
     def write_and_await_response(command, timeout = 60)
       commands << command
       write_command command
-      begin
-        response = command.response timeout
-      rescue Timeout::Error => e
-        abort e
+
+      case (response = command.response timeout)
+      when Punchblock::ProtocolError
+        if response.name == :item_not_found
+          abort Hangup.new(@end_reason)
+        else
+          abort response
+        end
+      when Exception
+        abort response
       end
-      abort response if response.is_a? Exception
+
       command
+    rescue Timeout::Error => e
+      abort CommandTimeout.new(command.to_s)
     end
 
     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
       logger.debug "Executing command #{command.inspect}"
-      client.execute_command command, :call_id => id
+      client.execute_command command, :call_id => id, :async => true
     end
 
     def logger_id # :nodoc:
@@ -222,11 +276,11 @@ module Adhearsion
     end
 
     def pause_controllers
-      controllers.each &:pause!
+      controllers.each(&:pause!)
     end
 
     def resume_controllers
-      controllers.each &:resume!
+      controllers.each(&:resume!)
     end
 
     class CommandRegistry < ThreadSafeArray # :nodoc: