adhearsion 2.0.0.alpha2 → 2.0.0.alpha3

data/.gitignore

@@ -1,25 +1,27 @@
 # Gem related stuff
 *.gem
-pkg
-.bundle
-Gemfile.lock
-vendor
+/pkg
+/.bundle
+/Gemfile.lock
+/vendor
 
 # Testing stuff
-coverage
-spec/reports
-example.log
-adhearsion.pid
+/coverage
+/spec/reports
+*.log
+/adhearsion.pid
 
 # RBX stuff
+/.rbx/
+
+# Editor temp/backup files
 *~
 .*.sw?
-nbproject
-/.rbx/
 
 # General
+/nbproject
 .DS_Store
-.rvmrc
-.yardoc
-doc
-tmp
+/.rvmrc
+/.yardoc
+/doc
+/tmp

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-# develop (2.0.0.head)
+# 2.0.0.alpha3 - 2012-02-21
+  * Feature: Add `ahn generate` command to allow invocation of generators
+  * Feature: Add simple generator for call controllers
+  * Feature: Add simple generator for plugins
+  * Feature: Allow plugins to register their generator classes
+  * Feature: Add log level helper methods to Console
+  * Feature: Console's shutdown/exit method initiates the shutdown routine
+  * Bugfix: Remove config option for auto-accept - hard-coded to true
+  * Bugfix: AHN_ENV and RAILS_ENV now do not interfere with each other when both are set, and ahn will boot in the RAILS_ENV if AHN_ENV is not set
+  * Feature: The console can take control of a call
+  * Bugfix: CallController#dial now blocks until all outbound calls complete
+  * Bugfix: Call commands timing out now raise a timeout exception in the caller, but do not crash the actor
+  * Bugfix: CallController#dial now unblocks immediately if the original call ends
+  * Bugfix: CallController#dial now unblocks when the connected outbound call unjoins, rather than ending, incase post-processing on the outbound call is required
+  * Bugfix: CallController#dial now hangs up outbound legs when it unblocks
+  * 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
   * Change: Plugins no longer load dialplan/event/rpc/console methods using corresponding class methods

data/adhearsion.gemspec

@@ -19,27 +19,28 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Runtime dependencies
-  s.add_runtime_dependency "bundler", [">= 1.0.10"]
+  s.add_runtime_dependency 'bundler', [">= 1.0.10"]
   s.add_runtime_dependency 'punchblock', [">= 0.9.1"]
-  s.add_runtime_dependency "logging", [">= 1.6.1"]
-  s.add_runtime_dependency "adhearsion-loquacious", [">= 1.9.0"]
-  s.add_runtime_dependency "activesupport", [">= 3.0.10"]
+  s.add_runtime_dependency 'logging', [">= 1.6.1"]
+  s.add_runtime_dependency 'adhearsion-loquacious', [">= 1.9.0"]
+  s.add_runtime_dependency 'activesupport', [">= 3.0.10"]
   # i18n is only strictly a dependency for ActiveSupport >= 3.0.0
   # Since it doesn't conflict with <3.0.0 we'll require it to be
   # on the safe side.
-  s.add_runtime_dependency "i18n", ">= 0.5.0"
-  s.add_runtime_dependency "json"
-  s.add_runtime_dependency "thor"
-  s.add_runtime_dependency "rake"
-  s.add_runtime_dependency "pry"
-  s.add_runtime_dependency "uuid"
-  s.add_runtime_dependency "future-resource", [">= 0.0.2"]
-  s.add_runtime_dependency "ruby_speech", [">= 0.4.0"]
+  s.add_runtime_dependency 'i18n', [">= 0.5.0"]
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'pry'
+  s.add_runtime_dependency 'uuid'
+  s.add_runtime_dependency 'future-resource', [">= 0.0.2"]
+  s.add_runtime_dependency 'ruby_speech', [">= 0.4.0"]
   s.add_runtime_dependency 'countdownlatch'
   s.add_runtime_dependency 'has-guarded-handlers', [">= 1.1.0"]
   s.add_runtime_dependency 'girl_friday'
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
-  s.add_runtime_dependency "ffi", [">= 1.0.11"]
+  s.add_runtime_dependency 'ffi', [">= 1.0.11"]
+  s.add_runtime_dependency 'celluloid', [">= 0.9.0"]
 
   # Development dependencies
   s.add_development_dependency 'rspec', ["~> 2.7.0"]

data/features/cli_basic.feature

@@ -0,0 +1,30 @@
+Feature: Adhearsion Ahn CLI (Basic)
+  As an Adhearsion user
+  I want a cli command (ahn)
+  So that I can perform actions against adhearsion apps and interact with adhearsion
+
+  Scenario: No arguments given
+    When I run `ahn`
+    Then I should see the usage message
+    And the exit status should be 0
+
+  Scenario: Unrecognized commands
+    When I run `ahn alpha beta`
+    Then the output should contain:
+    """
+    Unknown command: alpha beta
+    """
+    And the exit status should be 1
+
+  Scenario: Command version should print the version
+    When I run `ahn version`
+    Then the output should contain:
+    """
+    Adhearsion v
+    """
+    And the exit status should be 0
+
+  Scenario: Command help
+    When I run `ahn help`
+    Then I should see the usage message
+    And the exit status should be 0

data/features/cli_create.feature

@@ -0,0 +1,24 @@
+Feature: Adhearsion Ahn CLI (Create)
+  As an Adhearsion user
+  I want the ahn command to allow creating an app
+  So that I can write an Adhearsion app
+
+  Scenario: Command create with correct arguments
+    When I run `ahn create path/somewhere`
+    And I cd to "path/somewhere"
+    Then the following files should exist:
+      | Gemfile               |
+      | README.md             |
+      | Rakefile              |
+      | config/adhearsion.rb  |
+      | config/environment.rb |
+    And the file "config/adhearsion.rb" should contain "Adhearsion.router"
+    Then the exit status should be 0
+
+  Scenario: Running create with no arguments
+    When I run `ahn create`
+    Then the output should contain:
+    """
+    "create" was called incorrectly. Call as "ahn create /path/to/directory".
+    """
+    And the exit status should be 1

data/features/cli_daemon.feature

@@ -0,0 +1,21 @@
+Feature: Adhearsion Ahn CLI (daemon)
+  As an Adhearsion user
+  I want the ahn command to provide a 'daemon' command
+  So that I can start my adhearsion app as a daemon
+
+  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 output should contain "Daemonizing now"
+    And the exit status should be 0
+
+  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"
+    And I terminate the process using the pid file "ahn.pid"
+    Then the output should contain "Daemonizing now"

data/features/cli_generate.feature

@@ -0,0 +1,9 @@
+Feature: Adhearsion Ahn CLI (generate)
+  As an Adhearsion user
+  I want the ahn command to be able to run generators
+  So that I can generate useful code
+
+  Scenario: Listing generators
+    When I run `ahn generate`
+    Then the output should contain "Please choose a generator below."
+    And the output should contain "controller"

data/features/cli_start.feature

@@ -0,0 +1,33 @@
+Feature: Adhearsion Ahn CLI (start)
+  As an Adhearsion user
+  I want the ahn command to provide a 'start' command
+  So that I can start an interactive Adhearsion application
+
+  Scenario: Command start with no path outside of the app directory
+    When I run `ahn start`
+    Then the output should contain:
+    """
+    A valid path is required for start, unless run from an Adhearson app directory
+    """
+    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"
+    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..."
+    And the output should contain "AHN>"
+    And the output should contain "Transitioning from booting to force_stop"
+
+  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..."
+    And the output should contain "AHN>"
+    And the output should contain "Transitioning from booting to force_stop"

data/features/cli_stop.feature

@@ -0,0 +1,38 @@
+Feature: Adhearsion Ahn CLI (stop)
+  As an Adhearsion user
+  I want the ahn command to provide a 'stop' command
+  So that I can stop a running Adhearsion daemon
+
+  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`
+    Then the output should contain:
+    """
+    Stopping Adhearsion
+    """
+    And the file "ahn.pid" should not exist
+
+  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`
+    Then the output should contain:
+    """
+    Stopping Adhearsion
+    """
+    And the file "path/somewhere/adhearsion.pid" should not exist
+
+  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`
+    And I run `ahn stop`
+    Then the output should contain:
+    """
+    Stopping Adhearsion
+    """
+    And the file "adhearsion.pid" should not exist

data/features/controller_generator.feature

@@ -0,0 +1,19 @@
+Feature: Adhearsion controller generator
+  In order to speed up development of an Adhearsion app
+  As an Adhearsion developer
+  I want to generate a controller and its tests
+
+  Scenario: Generate a controller and a test file
+    When I run `ahn create path/somewhere`
+    And I cd to "path/somewhere"
+    And I run `ahn generate controller TestController`
+    Then the following directories should exist:
+      | lib                           |
+      | spec                          |
+
+    And the following files should exist:
+      | lib/test_controller.rb         |
+      | spec/test_controller_spec.rb |
+
+    And the file "lib/test_controller.rb" should contain "class TestController < Adhearsion::CallController"
+    And the file "spec/test_controller_spec.rb" should contain "describe TestController"

data/features/plugin_generator.feature

@@ -0,0 +1,55 @@
+Feature: Adhearsion plugin generator
+  In order to speed up development of an Adhearsion plugin
+  As an Adhearsion plugin developer
+  I want to generate a plugin and its basic structure
+
+  Scenario: Generate the basic structure for a plugin
+    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                                    |
+    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:
+    """
+    module 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
+    """

data/lib/adhearsion.rb

@@ -13,6 +13,7 @@ abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby
   has_guarded_handlers
   girl_friday
   loquacious
+  celluloid
 
   adhearsion/version
   adhearsion/foundation/all
@@ -30,6 +31,7 @@ module Adhearsion
   autoload :Conveniences
   autoload :Dispatcher
   autoload :Events
+  autoload :Generators
   autoload :MenuDSL
   autoload :Initializer
   autoload :Logging
@@ -51,7 +53,7 @@ module Adhearsion
 
     def initialize_config
       _config = Configuration.new
-      env = ENV['AHN_ENV']
+      env = ENV['AHN_ENV'] || ENV['RAILS_ENV']
       env = nil unless _config.valid_environment? env
       _config.platform.environment = env if env
       _config
@@ -87,3 +89,5 @@ module Adhearsion
   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,11 +1,30 @@
 require 'thread'
 
+module Celluloid
+  module ClassMethods
+    def ===(other)
+      other.kind_of? self
+    end
+  end
+
+  class ActorProxy
+    def is_a?(klass)
+      Actor.call @mailbox, :is_a?, klass
+    end
+
+    def kind_of?(klass)
+      Actor.call @mailbox, :kind_of?, klass
+    end
+  end
+end
+
 module Adhearsion
   ##
   # Encapsulates call-related data and behavior.
   #
   class Call
 
+    include Celluloid
     include HasGuardedHandlers
 
     attr_accessor :offer, :client, :end_reason, :commands, :variables
@@ -16,39 +35,35 @@ module Adhearsion
     def initialize(offer = nil)
       register_initial_handlers
 
-      @tag_mutex        = Mutex.new
-      @tags             = []
-      @end_reason_mutex = Mutex.new
-      @commands         = CommandRegistry.new
-      @variables        = {}
+      @tags       = []
+      @commands   = CommandRegistry.new
+      @variables  = {}
 
       self << offer if offer
     end
 
     def id
-      offer.call_id
+      offer.call_id if offer
     end
 
     def tags
-      @tag_mutex.synchronize { @tags.clone }
+      @tags.clone
     end
 
     # This may still be a symbol, but no longer requires the tag to be a symbol although beware
     # that using a symbol would create a memory leak if used improperly
     # @param [String, Symbol] label String or Symbol with which to tag this call
     def tag(label)
-      raise ArgumentError, "Tag must be a String or Symbol" unless [String, Symbol].include?(label.class)
-      @tag_mutex.synchronize { @tags << label }
+      abort ArgumentError.new "Tag must be a String or Symbol" unless [String, Symbol].include?(label.class)
+      @tags << label
     end
 
     def remove_tag(symbol)
-      @tag_mutex.synchronize do
-        @tags.reject! { |tag| tag == symbol }
-      end
+      @tags.reject! { |tag| tag == symbol }
     end
 
     def tagged_with?(symbol)
-      @tag_mutex.synchronize { @tags.include? symbol }
+      @tags.include? symbol
     end
 
     def register_event_handler(*guards, &block)
@@ -56,6 +71,7 @@ module Adhearsion
     end
 
     def deliver_message(message)
+      logger.debug "Receiving message: #{message.inspect}"
       trigger_handler :event, message
     end
 
@@ -74,9 +90,10 @@ module Adhearsion
       end
 
       on_end do |event|
-        hangup
-        @end_reason_mutex.synchronize { @end_reason = event.reason }
+        clear_from_active_calls
+        @end_reason = event.reason
         commands.terminate
+        after(5) { current_actor.terminate! }
       end
     end
 
@@ -88,11 +105,11 @@ module Adhearsion
     end
 
     def active?
-      @end_reason_mutex.synchronize { !end_reason }
+      !end_reason
     end
 
     def accept(headers = nil)
-      write_and_await_response Punchblock::Command::Accept.new(:headers => headers)
+      @accept_command ||= write_and_await_response Punchblock::Command::Accept.new(:headers => headers)
     end
 
     def answer(headers = nil)
@@ -103,14 +120,14 @@ module Adhearsion
       write_and_await_response Punchblock::Command::Reject.new(:reason => reason, :headers => headers)
     end
 
-    def hangup!(headers = nil)
+    def hangup(headers = nil)
       return false unless active?
-      @end_reason_mutex.synchronize { @end_reason = true }
+      @end_reason = true
       write_and_await_response Punchblock::Command::Hangup.new(:headers => headers)
     end
 
-    def hangup
-      Adhearsion.active_calls.remove_inactive_call self
+    def clear_from_active_calls
+      Adhearsion.active_calls.remove_inactive_call current_actor
     end
 
     ##
@@ -128,7 +145,7 @@ module Adhearsion
       when String
         options[:other_call_id] = target
       when Hash
-        raise ArgumentError, "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 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
@@ -136,7 +153,7 @@ module Adhearsion
 
         options.merge! target
       else
-        raise ArgumentError, "Don't know how to join to #{target.inspect}"
+        abort ArgumentError.new "Don't know how to join to #{target.inspect}"
       end
       command = Punchblock::Command::Join.new options
       write_and_await_response command
@@ -150,24 +167,22 @@ module Adhearsion
       write_and_await_response ::Punchblock::Command::Unmute.new
     end
 
-    def with_command_lock
-      @command_monitor ||= Monitor.new
-      @command_monitor.synchronize { yield }
-    end
-
     def write_and_await_response(command, timeout = 60)
-      # TODO: Put this back once we figure out why it's causing CI to fail
-      # logger.trace "Executing command #{command.inspect}"
       commands << command
       write_command command
-      response = command.response timeout
-      raise response if response.is_a? Exception
+      begin
+        response = command.response timeout
+      rescue Timeout::Error => e
+        abort e
+      end
+      abort response if response.is_a? Exception
       command
     end
 
     def write_command(command)
-      raise Hangup unless active? || command.is_a?(Punchblock::Command::Hangup)
+      abort Hangup.new unless active? || command.is_a?(Punchblock::Command::Hangup)
       variables.merge! command.headers_hash if command.respond_to? :headers_hash
+      logger.trace "Executing command #{command.inspect}"
       client.execute_command command, :call_id => id
     end
 
@@ -175,13 +190,21 @@ module Adhearsion
       "#{self.class}: #{id}"
     end
 
+    def logger
+      super
+    end
+
+    def to_ary
+      [current_actor]
+    end
+
     def execute_controller(controller, latch = nil)
       Adhearsion::Process.important_threads << Thread.new do
         catching_standard_errors do
           begin
             CallController.exec controller
           ensure
-            hangup!
+            hangup
           end
           latch.countdown! if latch
         end
@@ -195,22 +218,5 @@ module Adhearsion
       end
     end
 
-    class Registry
-      @registry = Hash.new
-      @mutex = Mutex.new
-
-      def self.[](k)
-        @mutex.synchronize do
-          @registry[k]
-        end
-      end
-
-      def self.[]=(k, value)
-        @mutex.synchronize do
-          @registry[k] = value
-        end
-      end
-    end#Registry
-
   end#Call
 end#Adhearsion