adhearsion 2.0.0.alpha1 → 2.0.0.alpha2

data/.gitignore

@@ -9,6 +9,7 @@ vendor
 coverage
 spec/reports
 example.log
+adhearsion.pid
 
 # RBX stuff
 *~
@@ -21,3 +22,4 @@ nbproject
 .rvmrc
 .yardoc
 doc
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+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
+env: ARUBA_TIMEOUT=120
+notifications:
+#  irc: "irc.freenode.org#adhearsion"
+  email:
+    - blangfeld@adhearsion.com

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # develop (2.0.0.head)
 
+# 2.0.0.alpha2 - 2012-01-30
+  * 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.
+  * Feature: Rake task adhearsion:config:show improved to make the output copy and paste-able in a configuration file.
+  * Feature: Call variables are aggregated from the headers sent and received during its existence
+  * Feature: Call variables are accessible using `#[]` and `#[]=` on the call
+  * Feature: Router can match against variables on a call using `#[]`
+  * Feature: adhearsion process is named via configuration module
+  * Feature: CallController#dial now takes a `:for` (or `:timeout`) option to specify a timeout on the dial command
+  * Feature: Include a sensible `.gitignore` in generated apps
+  * Feature: CallController can now perform join operations on calls, and take either a call ID, a call object or a mixer name as the target
+  * Bugfix: `Call` and `OutboundCall` now respond to `#to` and `#from` with the correct values from the offer/dial
+  * Bugfix: An `OutboundCall` allows storing call variables just like a `Call`
+  * 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
 
 ## Major architectural changes

data/adhearsion.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
 
   # Runtime dependencies
   s.add_runtime_dependency "bundler", [">= 1.0.10"]
-  s.add_runtime_dependency 'punchblock', [">= 0.8.3"]
+  s.add_runtime_dependency 'punchblock', [">= 0.9.1"]
   s.add_runtime_dependency "logging", [">= 1.6.1"]
-  s.add_runtime_dependency "loquacious", [">= 1.9.0"]
+  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
@@ -36,9 +36,10 @@ Gem::Specification.new do |s|
   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', [">= 0.1.1"]
+  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"]
 
   # Development dependencies
   s.add_development_dependency 'rspec', ["~> 2.7.0"]

data/features/app_generator.feature

@@ -1,6 +1,6 @@
 Feature: Adhearsion App Generator
   In order to do development on new Adhearsion apps
-  As a Adhearsiohn developer
+  As an Adhearsion developer
   I want to generate an Adhearsion app
 
   Scenario: Generate application with valid layout
@@ -12,6 +12,7 @@ Feature: Adhearsion App Generator
       | script                |
 
     And the following files should exist:
+      | .gitignore            |
       | config/adhearsion.rb  |
       | config/environment.rb |
       | Gemfile               |
@@ -19,6 +20,7 @@ Feature: Adhearsion App Generator
       | script/ahn            |
       | README.md             |
       | Rakefile              |
+      | Procfile              |
 
     And the file "config/adhearsion.rb" should contain each of these content parts:
     """

data/features/cli.feature

@@ -1,5 +1,5 @@
 Feature: Adhearsion Ahn CLI
-  As a Adhearsion user
+  As an Adhearsion user
   I want a cli command (ahn)
   So that I can create and interact with adhearsion apps
 
@@ -45,27 +45,27 @@ Feature: Adhearsion Ahn CLI
     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 "Transitioning from booting to running"
+    And I wait for output to contain "Starting connection to server"
     And I terminate the interactive process
     Then the output should contain "Loaded config"
     And the output should contain "Adhearsion::Console: Starting up..."
     And the output should contain "AHN>"
-    And the output should contain "Starting connection"
-    And the output should contain "Transitioning from running to stopping"
+    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 "Transitioning from booting to running"
+    And I wait for output to contain "Starting connection to server"
     And I terminate the interactive process
     Then the output should contain "Loaded config"
     And the output should contain "Adhearsion::Console: Starting up..."
     And the output should contain "AHN>"
-    And the output should contain "Starting connection"
-    And the output should contain "Transitioning from running to stopping"
+    And the output should contain "Transitioning from booting to force_stop"
 
   Scenario: Command daemon with path works correctly
     Given JRuby skip test

data/features/support/env.rb

@@ -18,6 +18,52 @@ 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
 end

data/lib/adhearsion.rb

@@ -14,6 +14,7 @@ abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby
   girl_friday
   loquacious
 
+  adhearsion/version
   adhearsion/foundation/all
 }.each { |f| require f }
 
@@ -27,7 +28,6 @@ module Adhearsion
   autoload :Configuration
   autoload :Console
   autoload :Conveniences
-  autoload :DialplanController
   autoload :Dispatcher
   autoload :Events
   autoload :MenuDSL
@@ -36,7 +36,6 @@ module Adhearsion
   autoload :OutboundCall
   autoload :Plugin
   autoload :Router
-  autoload :Version
 
   class << self
 

data/lib/adhearsion/call.rb

@@ -8,25 +8,25 @@ module Adhearsion
 
     include HasGuardedHandlers
 
-    attr_accessor :offer, :client, :end_reason, :commands
+    attr_accessor :offer, :client, :end_reason, :commands, :variables
+
+    delegate :[], :[]=, :to => :variables
+    delegate :to, :from, :to => :offer, :allow_nil => true
 
     def initialize(offer = nil)
-      if offer
-        @offer  = offer
-        @client = offer.client
-      end
+      register_initial_handlers
 
       @tag_mutex        = Mutex.new
       @tags             = []
       @end_reason_mutex = Mutex.new
-      end_reason        = nil
       @commands         = CommandRegistry.new
+      @variables        = {}
 
-      register_initial_handlers
+      self << offer if offer
     end
 
     def id
-      @offer.call_id
+      offer.call_id
     end
 
     def tags
@@ -58,9 +58,21 @@ module Adhearsion
     def deliver_message(message)
       trigger_handler :event, message
     end
+
     alias << deliver_message
 
     def register_initial_handlers
+      register_event_handler Punchblock::Event::Offer do |offer|
+        @offer  = offer
+        @client = offer.client
+        throw :pass
+      end
+
+      register_event_handler Punchblock::HasHeaders do |event|
+        variables.merge! event.headers_hash
+        throw :pass
+      end
+
       on_end do |event|
         hangup
         @end_reason_mutex.synchronize { @end_reason = event.reason }
@@ -69,7 +81,7 @@ module Adhearsion
     end
 
     def on_end(&block)
-      register_event_handler :class => Punchblock::Event::End do |event|
+      register_event_handler Punchblock::Event::End do |event|
         block.call event
         throw :pass
       end
@@ -101,19 +113,51 @@ module Adhearsion
       Adhearsion.active_calls.remove_inactive_call self
     end
 
-    def join(other_call_id)
-      write_and_await_response Punchblock::Command::Join.new :other_call_id => other_call_id
+    ##
+    # 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] mixer_name The mixer to join to
+    # @param [Hash, Optional] options further options to be joined with
+    #
+    def join(target, options = {})
+      case target
+      when Call
+        options[:other_call_id] = target.id
+      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)
+        target.tap do |t|
+          t[:other_call_id] = t[:call_id]
+          t.delete :call_id
+        end
+
+        options.merge! target
+      else
+        raise ArgumentError, "Don't know how to join to #{target.inspect}"
+      end
+      command = Punchblock::Command::Join.new options
+      write_and_await_response command
+    end
+
+    def mute
+      write_and_await_response ::Punchblock::Command::Mute.new
+    end
+
+    def unmute
+      write_and_await_response ::Punchblock::Command::Unmute.new
     end
 
-    # Lock the socket for a command.  Can be used to allow the console to take
-    # control of the thread in between AGI commands coming from the dialplan.
     def with_command_lock
       @command_monitor ||= Monitor.new
       @command_monitor.synchronize { yield }
     end
 
     def write_and_await_response(command, timeout = 60)
-      logger.trace "Executing command #{command.inspect}"
+      # 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
@@ -123,18 +167,14 @@ module Adhearsion
 
     def write_command(command)
       raise Hangup unless active? || command.is_a?(Punchblock::Command::Hangup)
+      variables.merge! command.headers_hash if command.respond_to? :headers_hash
       client.execute_command command, :call_id => id
     end
 
-    # Sanitize the offer id
     def logger_id
       "#{self.class}: #{id}"
     end
 
-    def variables
-      offer ? offer.headers_hash : nil or {}
-    end
-
     def execute_controller(controller, latch = nil)
       Adhearsion::Process.important_threads << Thread.new do
         catching_standard_errors do

data/lib/adhearsion/call_controller.rb

@@ -33,31 +33,34 @@ module Adhearsion
       STOP
     end
 
-    def self.exec(controller, fresh_call = true)
-      return unless controller
+    class << self
+      def exec(controller, fresh_call = true)
+        return unless controller
+
+        new_controller = catch :pass_controller do
+          controller.skip_accept! unless fresh_call
+          controller.execute!
+          nil
+        end
 
-      new_controller = catch :pass_controller do
-        controller.skip_accept! unless fresh_call
-        controller.execute!
-        nil
+        exec new_controller, false
       end
 
-      exec new_controller, false
+      ##
+      # Include another module into all CallController classes
+      def mixin(mod)
+        include mod
+      end
     end
 
-    attr_reader :call, :metadata
+    attr_reader :call, :metadata, :block
 
     delegate :[], :[]=, :to => :@metadata
     delegate :variables, :logger, :to => :call
-    delegate :write_and_await_response, :accept, :answer, :reject, :to => :call
-
-    def initialize(call, metadata = nil)
-      @call, @metadata = call, metadata || {}
-      setup
-    end
+    delegate :write_and_await_response, :accept, :answer, :reject, :mute, :unmute, :join, :to => :call
 
-    def setup
-      Plugin.add_dialplan_methods self if Plugin
+    def initialize(call, metadata = nil, &block)
+      @call, @metadata, @block = call, metadata || {}, block
     end
 
     def execute!(*options)
@@ -73,6 +76,7 @@ module Adhearsion
     end
 
     def run
+      instance_exec &block if block
     end
 
     def invoke(controller_class, metadata = nil)
@@ -113,14 +117,6 @@ module Adhearsion
       after_call unless hangup_response == false
     end
 
-    def mute
-      write_and_await_response ::Punchblock::Command::Mute.new
-    end
-
-    def unmute
-      write_and_await_response ::Punchblock::Command::Unmute.new
-    end
-
     def execute_component_and_await_completion(component)
       write_and_await_response component
 

data/lib/adhearsion/call_controller/dial.rb

@@ -13,34 +13,29 @@ module Adhearsion
       #
       # @param [Hash] options
       #
-      # +:caller_id+ - the caller id number to be used when the call is placed.  It is advised you properly adhere to the
+      # +:from+ - the caller id to be used when the call is placed. It is advised you properly adhere to the
       # policy of VoIP termination providers with respect to caller id values.
       #
-      # +:name+ - this is the name which should be passed with the caller ID information
-      # if :name=>"John Doe" and :caller_id => "444-333-1000" then the compelete CID and name would be "John Doe" <4443331000>
-      # support for caller id information varies from country to country and from one VoIP termination provider to another.
-      #
       # +:for+ - this option can be thought of best as a timeout.  i.e. timeout after :for if no one answers the call
-      # For example, dial("SIP/jay-desk-650&SIP/jay-desk-601&SIP/jay-desk-601-2", :for => 15.seconds, :caller_id => callerid)
+      # For example, dial(%w{SIP/jay-desk-650 SIP/jay-desk-601 SIP/jay-desk-601-2}, :for => 15.seconds, :from => callerid)
       # this call will timeout after 15 seconds if 1 of the 3 extensions being dialed do not pick prior to the 15 second time limit
       #
-      # +:options+ - This is a string of options like "Tr" which are supported by the asterisk DIAL application.
-      # for a complete list of these options and their usage please check the link below.
-      #
-      # +:confirm+ - ?
-      #
       # @example Make a call to the PSTN using my SIP provider for VoIP termination
       #   dial "SIP/19095551001@my.sip.voip.terminator.us"
       #
       # @example Make 3 Simulataneous calls to the SIP extensions, try for 15 seconds and use the callerid
       # for this call specified by the variable my_callerid
-      #   dial ["SIP/jay-desk-650", "SIP/jay-desk-601", "SIP/jay-desk-601-2"], :for => 15.seconds, :caller_id => my_callerid
+      #   dial %w{SIP/jay-desk-650 SIP/jay-desk-601 SIP/jay-desk-601-2}, :for => 15.seconds, :from => my_callerid
       #
       # @example Make a call using the IAX provider to the PSTN
-      #   dial "IAX2/my.id@voipjet/19095551234", :name => "John Doe", :caller_id => "9095551234"
+      #   dial "IAX2/my.id@voipjet/19095551234", :from => "John Doe <9095551234>"
       #
-      def dial(to, options = {})
-        latch = CountDownLatch.new 1
+      def dial(to, options = {}, latch = nil)
+        latch ||= CountDownLatch.new 1
+
+        _for = options.delete :for
+        options[:timeout] ||= _for if _for
+
         calls = Array(to).map do |target|
           new_call = OutboundCall.new options
 
@@ -48,7 +43,7 @@ module Adhearsion
             calls.each do |call_to_hangup, target|
               call_to_hangup.hangup! unless call_to_hangup.id == new_call.id
             end
-            new_call.join call.id
+            new_call.join call
           end
 
           new_call.on_end do |event|
@@ -58,11 +53,16 @@ module Adhearsion
           [new_call, target]
         end
 
-        calls.each do |call, target|
+        calls.map! do |call, target|
           call.dial target, options
+          call
         end
 
-        latch.wait
+        timeout = latch.wait options[:timeout]
+
+        return timeout unless timeout
+
+        calls.size == 1 ? calls.first : calls
       end
 
     end#module Dial