adhearsion 2.0.1 → 2.1.0

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
+script: bundle exec rake --trace
 rvm:
   - 1.9.2
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode # currently in active development, may or may not work for your project
-  - ruby-head
+  # - 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 RAILS_ENV=development AHN_ENV=development
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.1.0](https://github.com/adhearsion/adhearsion/compare/v2.0.1...v2.1.0) - [2012-08-07](https://rubygems.org/gems/adhearsion/versions/2.1.0)
+
+## Features
+  * Initial support for FreeSWITCH
+  * Added the possibility to specify a confirmation controller on `#dial` operations
+  * Allow specifying a controller to run when originating an outbound call
+  * Allow `Call#execute_controller` to take a block instead of a controller instance. Simplifies event-based execution of simple controllers (eg whisper into a call)
+  * Allow route modifiers such that they:
+    * Do not accept calls that match
+    * Do not execute a controller
+    * Do not hangup after controller execution
+  * Permit asynchronous output using bang version of methods (eg `CallController#play!`), returning an output component, which can be stopped
+  * Added `CallController#safely` which will catch and log `StandardError` in a call controller, but will not allow it to crash the controller
+  * `CallController#record` now has an `:interruptible` option that allows recording to be stopped by pressing any DTMF key
+  * Added `Call#on_joined` and `Call#on_unjoined` for easily registering joined/unjoined handlers
+  * `Adhearsion.root` and `Adhearsion.root=` are now available to return the root path to the application. `Adhearsion.ahn_root=` is deprecated
+  * `Adhearsion.deprecated` added for internal use to clearly mark deprecated methods
+
+## Bugfixes
+  * All output methods will now raise `Adhearsion::CallController::Output::PlaybackError` when output fails, instead of failing silently
+  * `CallController#hangup` now prevents further execution of the controller
+  * Calls which do not match any routes are rejected with an error
+  * Calls are not accepted until a matching route is found
+  * Give sensible dependency defaults for generated plugins
+  * Fixed mocha-fail in generated plugins
+  * Plugins generated with a snake_case name did not have the appropriate constants camelized
+  * `CallController#dial` no longer creates outbound calls if the dialing party hangs up before it executes
+  * `CallController#ask` no longer loops on timeout
+  * Correct default port for Asterisk
+
 # [2.0.1](https://github.com/adhearsion/adhearsion/compare/v2.0.0...v2.0.1) - [2012-06-04](https://rubygems.org/gems/adhearsion/versions/2.0.1)
   * Bugfix: Avoid infinitely recursive exception handlers
   * Bugfix: Don't require rubygems where we don't need it

data/README.markdown

@@ -20,6 +20,7 @@ Adhearsion rests above a lower-level telephony platform, for example [Asterisk](
 * Ruby 1.9.2+ or JRuby 1.6.7+
 * A VoIP platform:
   * Asterisk 1.8+
+  * FreeSWITCH
   * Prism 11+ with rayo-server
 * An interest in building cool new things
 

data/adhearsion.gemspec

@@ -30,19 +30,18 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
   s.add_runtime_dependency 'logging', [">= 1.6.1"]
   s.add_runtime_dependency 'pry'
-  s.add_runtime_dependency 'punchblock', ["~> 1.0"]
+  s.add_runtime_dependency 'punchblock', ["~> 1.4"]
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'ruby_speech', ["~> 1.0"]
   s.add_runtime_dependency 'thor'
-  s.add_runtime_dependency 'uuid'
 
-  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'aruba', "~> 0.4"
   s.add_development_dependency 'ci_reporter'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'flexmock'
   s.add_development_dependency 'guard-cucumber'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rspec', ["~> 2.7.0"]
+  s.add_development_dependency 'rspec', ["~> 2.11.0"]
   s.add_development_dependency 'ruby_gntp'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'

data/bin/ahn

@@ -1,24 +1,4 @@
 #!/usr/bin/env ruby
 
-# This is the main executable file.
-
-# Adhearsion, open source collaboration framework
-# Copyright (C) 2006,2007,2008 Jay Phillips
-#
-# This library is free software; you can redistribute it and/or modify it under
-# the terms of the GNU Lesser General Public License as published by the Free
-# Software Foundation; either version 2.1 of the License, or (at your option)
-# any later version.
-#
-# This library is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
-# details.
-#
-# You should have received a copy of the GNU Lesser General Public License along
-# with this library; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-
 require 'adhearsion/cli'
-
 Adhearsion::CLI::AhnCommand.start

data/features/cli_create.feature

@@ -19,6 +19,6 @@ Feature: Adhearsion Ahn CLI (Create)
     When I run `ahn create`
     Then the output should contain:
     """
-    "create" was called incorrectly. Call as "ahn create /path/to/directory".
+    ahn create requires at least 1 argument: "ahn create /path/to/directory".
     """
     And the exit status should be 1

data/features/cli_restart.feature

@@ -1,4 +1,4 @@
-Feature: Adhearsion Ahn CLI (stop)
+Feature: Adhearsion Ahn CLI (restart)
   As an Adhearsion user
   I want the ahn command to provide a 'restart' command
   So that I can restart a running Adhearsion daemon
@@ -17,3 +17,27 @@ Feature: Adhearsion Ahn CLI (stop)
     """
     Starting Adhearsion
     """
+
+  @reconnect
+  Scenario: Command restart with no path outside of the app directory
+    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 --pid-file=ahn.pid`
+    Then the output should contain:
+    """
+    A valid path is required for restart, unless run from an Adhearson app directory
+    """
+    And the exit status should be 1
+
+  @reconnect
+  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`
+    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

@@ -18,7 +18,6 @@ Feature: Adhearsion Ahn CLI (start)
     And I run `ahn start` 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 "AHN>"
     And the output should contain "Adhearsion shut down"
 
   Scenario: Command start with only path works properly
@@ -27,5 +26,4 @@ Feature: Adhearsion Ahn CLI (start)
     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 "AHN>"
     And the output should contain "Adhearsion shut down"

data/features/plugin_generator.feature

@@ -3,29 +3,80 @@ Feature: Adhearsion plugin generator
   As an Adhearsion plugin developer
   I want to generate a plugin and its basic structure
 
-  Scenario: Generate the basic structure for a plugin
+  Scenario: Generate the basic structure for a plugin with a constant name
     When I run `ahn generate plugin TestPlugin`
     Then the following directories should exist:
-    | test_plugin                                         |
-    | test_plugin/lib                                     |
-    | test_plugin/lib/test_plugin                         |
-    | test_plugin/spec                                    |
+    | test_plugin                 |
+    | test_plugin/lib             |
+    | test_plugin/lib/test_plugin |
+    | test_plugin/spec            |
     And the following files should exist:
-    | test_plugin/test_plugin.gemspec                                      |
-    | test_plugin/Rakefile                                                 |
-    | test_plugin/README.md                                                |
-    | test_plugin/Gemfile                                                  |
-    | test_plugin/lib/test_plugin.rb                                       |
-    | test_plugin/lib/test_plugin/version.rb                               |
-    | test_plugin/lib/test_plugin/plugin.rb                                |
-    | test_plugin/lib/test_plugin/controller_methods.rb                    |
-    | test_plugin/spec/spec_helper.rb                                      |
-    | test_plugin/spec/test_plugin/controller_methods_spec.rb              |
+    | test_plugin/test_plugin.gemspec                         |
+    | test_plugin/Rakefile                                    |
+    | test_plugin/README.md                                   |
+    | test_plugin/Gemfile                                     |
+    | test_plugin/lib/test_plugin.rb                          |
+    | test_plugin/lib/test_plugin/version.rb                  |
+    | test_plugin/lib/test_plugin/plugin.rb                   |
+    | test_plugin/lib/test_plugin/controller_methods.rb       |
+    | test_plugin/spec/spec_helper.rb                         |
+    | test_plugin/spec/test_plugin/controller_methods_spec.rb |
     And the file "test_plugin/test_plugin.gemspec" should contain "test_plugin/version"
     And the file "test_plugin/README.md" should contain "TestPlugin"
     And the file "test_plugin/lib/test_plugin.rb" should contain each of these content parts:
     """
+    TestPlugin
+    test_plugin/version
+    test_plugin/plugin
+    test_plugin/controller_methods
+    """
+    And the file "test_plugin/lib/test_plugin/version.rb" should contain each of these content parts:
+    """
     module TestPlugin
+    VERSION
+    """
+    And the file "test_plugin/lib/test_plugin/plugin.rb" should contain each of these content parts:
+    """
+    module TestPlugin
+    init :test_plugin
+    config :test_plugin
+    namespace :test_plugin
+    """
+    And the file "test_plugin/lib/test_plugin/controller_methods.rb" should contain each of these content parts:
+    """
+    module TestPlugin
+    def greet
+    """
+    And the file "test_plugin/spec/spec_helper.rb" should contain "require 'test_plugin'"
+    And the file "test_plugin/spec/test_plugin/controller_methods_spec.rb" should contain each of these content parts:
+    """
+    module TestPlugin
+    include TestPlugin::ControllerMethods
+    """
+
+  Scenario: Generate the basic structure for a plugin with an underscored name
+    When I run `ahn generate plugin test_plugin`
+    Then the following directories should exist:
+    | test_plugin                 |
+    | test_plugin/lib             |
+    | test_plugin/lib/test_plugin |
+    | test_plugin/spec            |
+    And the following files should exist:
+    | test_plugin/test_plugin.gemspec                         |
+    | test_plugin/Rakefile                                    |
+    | test_plugin/README.md                                   |
+    | test_plugin/Gemfile                                     |
+    | test_plugin/lib/test_plugin.rb                          |
+    | test_plugin/lib/test_plugin/version.rb                  |
+    | test_plugin/lib/test_plugin/plugin.rb                   |
+    | test_plugin/lib/test_plugin/controller_methods.rb       |
+    | test_plugin/spec/spec_helper.rb                         |
+    | test_plugin/spec/test_plugin/controller_methods_spec.rb |
+    And the file "test_plugin/test_plugin.gemspec" should contain "test_plugin/version"
+    And the file "test_plugin/README.md" should contain "TestPlugin"
+    And the file "test_plugin/lib/test_plugin.rb" should contain each of these content parts:
+    """
+    TestPlugin
     test_plugin/version
     test_plugin/plugin
     test_plugin/controller_methods

data/features/support/env.rb

@@ -1,18 +1,5 @@
 # encoding: utf-8
 
-require 'simplecov'
-require 'simplecov-rcov'
-class SimpleCov::Formatter::MergedFormatter
-  def format(result)
-     SimpleCov::Formatter::HTMLFormatter.new.format(result)
-     SimpleCov::Formatter::RcovFormatter.new.format(result)
-  end
-end
-SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
-SimpleCov.start do
-  add_filter "/vendor/"
-end
-
 JRUBY_OPTS_SAVED=ENV['JRUBY_OPTS']
 JAVA_OPTS_SAVED=ENV['JAVA_OPTS']
 

data/lib/adhearsion.rb

@@ -4,14 +4,9 @@ abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby
 
 %w{
   active_support/all
-  uuid
-  future-resource
   punchblock
-  ostruct
   ruby_speech
   countdownlatch
-  has_guarded_handlers
-  girl_friday
   loquacious
   celluloid
 
@@ -42,16 +37,41 @@ module Adhearsion
 
   class << self
 
-    def ahn_root=(path)
+    #
+    # Sets the application path
+    # @param[String|Pathname] The application path to set
+    #
+    def root=(path)
       Adhearsion.config[:platform].root = path.nil? ? nil : File.expand_path(path)
     end
 
+    #
+    # Returns the current application path
+    # @return [Pathname] The application path
+    #
+    def root
+      Adhearsion.config[:platform].root
+    end
+
+    #
+    # @deprecated Use #root= instead
+    #
+    def ahn_root=(path)
+      Adhearsion.deprecated "#Adhearsion.root="
+      Adhearsion.root = path
+    end
+
     def config(&block)
       @config ||= initialize_config
       block_given? and yield @config
       @config
     end
 
+    def deprecated(new_method)
+      logger.info "#{caller[0]} - This method is deprecated, please use #{new_method}."
+      logger.warn caller.join("\n")
+    end
+
     def initialize_config
       _config = Configuration.new
       env = ENV['AHN_ENV'] || ENV['RAILS_ENV']

data/lib/adhearsion/call.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'has_guarded_handlers'
 require 'thread'
 
 module Adhearsion
@@ -114,16 +115,14 @@ module Adhearsion
         throw :pass
       end
 
-      register_event_handler Punchblock::Event::Joined do |event|
+      on_joined do |event|
         target = event.call_id || event.mixer_name
         signal :joined, target
-        throw :pass
       end
 
-      register_event_handler Punchblock::Event::Unjoined do |event|
+      on_unjoined do |event|
         target = event.call_id || event.mixer_name
         signal :unjoined, target
-        throw :pass
       end
 
       on_end do |event|
@@ -132,6 +131,7 @@ module Adhearsion
         @end_reason = event.reason
         commands.terminate
         after(after_end_hold_time) { current_actor.terminate! }
+        throw :pass
       end
     end
 
@@ -140,6 +140,39 @@ module Adhearsion
       30
     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] mixer_name The mixer name to guard on
+    #
+    def on_joined(target = nil, &block)
+      register_event_handler Punchblock::Event::Joined, *guards_for_target(target) do |event|
+        block.call event
+        throw :pass
+      end
+    end
+
+    ##
+    # 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] mixer_name The mixer name to guard on
+    #
+    def on_unjoined(target = nil, &block)
+      register_event_handler Punchblock::Event::Unjoined, *guards_for_target(target) do |event|
+        block.call event
+        throw :pass
+      end
+    end
+
+    # @private
+    def guards_for_target(target)
+      target ? [join_options_with_target(target)] : []
+    end
+
     def on_end(&block)
       register_event_handler Punchblock::Event::End do |event|
         block.call event
@@ -233,11 +266,11 @@ module Adhearsion
     end
 
     def mute
-      write_and_await_response ::Punchblock::Command::Mute.new
+      write_and_await_response Punchblock::Command::Mute.new
     end
 
     def unmute
-      write_and_await_response ::Punchblock::Command::Unmute.new
+      write_and_await_response Punchblock::Command::Unmute.new
     end
 
     # @private
@@ -287,8 +320,10 @@ module Adhearsion
       "#<#{self.class}:#{id} #{attrs.join ', '}>"
     end
 
-    def execute_controller(controller, completion_callback = nil)
+    def execute_controller(controller = nil, completion_callback = nil, &block)
+      raise ArgumentError if controller && block_given?
       call = current_actor
+      controller ||= CallController.new call, &block
       Thread.new do
         catching_standard_errors do
           begin

data/lib/adhearsion/call_controller.rb

@@ -139,8 +139,9 @@ module Adhearsion
     #
     def hangup(headers = nil)
       block_until_resumed
-      hangup_response = call.hangup headers
-      after_call unless hangup_response == false
+      call.hangup headers
+      after_call
+      raise Call::Hangup
     end
 
     # @private
@@ -221,6 +222,8 @@ module Adhearsion
       end
     end
 
+    alias :safely :catching_standard_errors
+
     # @private
     def block_until_resumed
       instance_variable_defined?(:@pause_latch) && @pause_latch.wait