adhearsion 0.8.4 → 0.8.5

data/CHANGELOG

@@ -1,3 +1,15 @@
+0.8.5
+ - Added XMPP module and sample component. This allows you to easily write components which utilise a persistent XMPP connection maintained by Adhearsion
+ - Prefer finding the dialplan.rb entry point by the AGI request URI instead of the calling context
+ - Added :use_static_conf option for "meetme" to allow the use of disk-file-managed conferences
+ - Logging object now shared with ActiveRecord and Blather
+ - Fixed a longstanding bug where newlines were not sent after each AGI command
+ - Fixed parsing of DBGet AMI command/response
+ - Better shutdown handling/cleanup
+ - Attempt to allow the AMI socket to reconnect if connection is lost
+ - Improved support for Ruby 1.9
+ - Numerous smaller bugs fixed. See: https://adhearsion.lighthouseapp.com/projects/5871-adhearsion/milestones/76510-085
+
 0.8.4
  - Add configurable argument delimiter for talking to Asterisk.  This enables Adhearsion to support Asterisk versions 1.4 (and prior) as well as 1.6 (and later).
  - Fixed using ActiveRecord in Adhearsion components

data/Rakefile

@@ -3,6 +3,7 @@ ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
 
 require 'rubygems'
 require 'rake/gempackagetask'
+require 'rake/testtask'
 
 begin
   require 'spec/rake/spectask'
@@ -45,13 +46,13 @@ Rake::GemPackageTask.new(GEMSPEC).define
 #   # t.options = ['--any', '--extra', '--opts'] # optional
 # end
 
-desc "Run the unit tests for Adhearsion"
-task :spec do
-  Dir[*AHN_TESTS].each do |file|
-    load file
-  end
+Rake::TestTask.new('spec') do |t|
+  t.verbose = true
+  t.pattern = AHN_TESTS
 end
 
+task :default => :spec
+
 desc "Check Ragel version"
 task :check_ragel_version do
   ragel_version_match = `ragel --version`.match(/(\d)\.(\d)+/)

data/adhearsion.gemspec

@@ -14,6 +14,9 @@ ADHEARSION_FILES = %w{
   app_generators/ahn/templates/components/disabled/restful_rpc/README.markdown
   app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.rb
   app_generators/ahn/templates/components/disabled/restful_rpc/spec/restful_rpc_spec.rb
+  app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.rb
+  app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.yml
+  app_generators/ahn/templates/components/disabled/xmpp_gateway/README.markdown
   app_generators/ahn/templates/components/simon_game/simon_game.rb
   app_generators/ahn/templates/config/startup.rb
   app_generators/ahn/templates/dialplan.rb
@@ -38,7 +41,6 @@ ADHEARSION_FILES = %w{
   lib/adhearsion/foundation/custom_daemonizer.rb
   lib/adhearsion/foundation/event_socket.rb
   lib/adhearsion/foundation/future_resource.rb
-  lib/adhearsion/foundation/global.rb
   lib/adhearsion/foundation/metaprogramming.rb
   lib/adhearsion/foundation/numeric.rb
   lib/adhearsion/foundation/pseudo_guid.rb
@@ -55,6 +57,7 @@ ADHEARSION_FILES = %w{
   lib/adhearsion/initializer/drb.rb
   lib/adhearsion/initializer/freeswitch.rb
   lib/adhearsion/initializer/rails.rb
+  lib/adhearsion/initializer/xmpp.rb
   lib/adhearsion/logging.rb
   lib/adhearsion/tasks.rb
   lib/adhearsion/tasks/database.rb
@@ -100,6 +103,7 @@ ADHEARSION_FILES = %w{
   lib/adhearsion/voip/menu_state_machine/matchers.rb
   lib/adhearsion/voip/menu_state_machine/menu_builder.rb
   lib/adhearsion/voip/menu_state_machine/menu_class.rb
+  lib/adhearsion/xmpp/connection.rb
   lib/theatre.rb
   lib/theatre/callback_definition_loader.rb
   lib/theatre/guid.rb
@@ -113,14 +117,14 @@ ADHEARSION_FILES = %w{
 
 Gem::Specification.new do |s|
   s.name = "adhearsion"
-  s.version = "0.8.4"
+  s.version = "0.8.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jay Phillips"]
+  s.authors = ["Jay Phillips", "Jason Goecke", "Ben Klang"]
 
-  s.date = "2008-08-21"
+  s.date = "2010-08-24"
   s.description = "Adhearsion is an open-source telephony development framework"
-  s.email = "Jay&Adhearsion.com"
+  s.email = "dev&Adhearsion.com"
   s.executables = ["ahn", "ahnctl", "jahn"]
 
   s.files = ADHEARSION_FILES

data/app_generators/ahn/ahn_generator.rb

@@ -27,6 +27,10 @@ class AhnGenerator < RubiGen::Base
       m.file  *["components/simon_game/simon_game.rb"]*2
       m.file  *["components/ami_remote/ami_remote.rb"]*2
 
+      m.file  *["components/disabled/xmpp_gateway/xmpp_gateway.rb"]*2
+      m.file  *["components/disabled/xmpp_gateway/xmpp_gateway.yml"]*2
+      m.file  *["components/disabled/xmpp_gateway/README.markdown"]*2
+
       m.file  *["components/disabled/stomp_gateway/stomp_gateway.rb"]*2
       m.file  *["components/disabled/stomp_gateway/stomp_gateway.yml"]*2
       m.file  *["components/disabled/stomp_gateway/README.markdown"]*2
@@ -83,6 +87,7 @@ EOS
     BASEDIRS = %w(
       components/simon_game
       components/disabled/stomp_gateway
+      components/disabled/xmpp_gateway
       components/disabled/sandbox
       components/ami_remote
       components/disabled/restful_rpc/spec

data/app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.rb

@@ -55,7 +55,7 @@ RESTFUL_API_HANDLER = lambda do |env|
   rpc_object = Adhearsion::Components.component_manager.extend_object_with(Object.new, :rpc)
 
   # TODO: set the content-type and other HTTP headers
-  response_object = Array rpc_object.send(path, *json)
+  response_object = rpc_object.send(path, *json)
   [200, {"Content-Type" => "application/json"}, response_object.to_json]
 
 end

data/app_generators/ahn/templates/components/disabled/sandbox/sandbox.rb

@@ -55,7 +55,7 @@ initialization do
                 next
               end
               response.chomp!
-              case
+              case response
                 when "authentication accepted"
                   ahn_log.sandbox "Authentication accepted"
 

data/app_generators/ahn/templates/components/disabled/xmpp_gateway/README.markdown

@@ -0,0 +1,3 @@
+In order to use this component, you must have an XMPP connection enabled in config/startup.rb. It is recommended this be done as an XMPP component rather than a standard client.
+
+You can use all elements of the Blather DSL scoped to XMPP::Connection

data/app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.rb

@@ -0,0 +1,11 @@
+initialization do
+  
+  XMPP::Connection.message :body do |m|
+    XMPP::Connection.say m.from, "You said: #{m.body}"
+  end
+  
+  XMPP::Connection.subscription :request? do |s|
+    XMPP::Connection.write_to_stream s.approve!
+  end
+
+end

data/app_generators/ahn/templates/config/startup.rb

@@ -27,7 +27,8 @@ Adhearsion::Configuration.configure do |config|
   # NOTE: Pay special attention to the argument_delimiter field below:
   # For Asterisk <= 1.4, use "|" (default)
   # For Asterisk >= 1.6, use ","
-  # This setting applies to AMI and AGI
+  # The delimiter can also be specified in Asterisk's asterisk.conf.
+  # This setting applies only to AGI.  The AMI delimiter is auto-detected.
   config.enable_asterisk :argument_delimiter => '|'
   # config.asterisk.enable_ami :host => "127.0.0.1", :username => "admin", :password => "password", :events => true
 
@@ -44,6 +45,8 @@ Adhearsion::Configuration.configure do |config|
 
   # Configure a database to use ActiveRecord-backed models. See ActiveRecord::Base.establish_connection
   # for the appropriate settings here.
+  # You can also override the default log destination by supplying an alternate
+  # logging object with :logger.  The default is ahn_log.db.
   # config.enable_database :adapter  => 'mysql',
   #                        :username => 'joe',
   #                        :password => 'secret',
@@ -59,6 +62,12 @@ Adhearsion::Configuration.configure do |config|
   #                    :password => 'password12345',
   #                    :allow_anonymous => false,
   #                    :try_sasl => false
+  
+  # Configure XMPP call controller
+  # config.enable_xmpp :jid => 'active-calls.xmpp.example.com',
+  #                    :password => 'passwd',
+  #                    :server => 'xmpp.example.com',
+  #                    :port => 5347
 
 end
 

data/lib/adhearsion/cli.rb

@@ -143,12 +143,17 @@ USAGE
                 app_path = PathString.from_application_subdirectory Dir.pwd
                 if app_path
                   disabled_component_path = File.join app_path, "components", "disabled", name
+                  disabled_components_path = File.join app_path, "components", "disabled"
                   enabled_component_path  = File.join app_path, "components", name
                   if File.directory? disabled_component_path
                     FileUtils.mv disabled_component_path, enabled_component_path
                     puts "Enabled component #{name}"
-                  else
+                  elsif File.directory? enabled_component_path
+                    raise ComponentError.new("This component is already enabled.")
+                  elsif !File.directory? disabled_components_path
                     raise ComponentError.new("There is no components/disabled directory!")
+                  else
+                    raise ComponentError.new("The requested component was not found.")
                   end
                 else
                   raise PathInvalid.new(Dir.pwd)
@@ -196,7 +201,7 @@ USAGE
 
         end
 
-        class CLIException < Exception; end
+        class CLIException < StandardError; end
 
         class UnknownCommand < CLIException
           def initialize(cmd)

data/lib/adhearsion/foundation/event_socket.rb

@@ -198,6 +198,6 @@ class EventSocket
 
   end
 
-  class ConnectionError < Exception; end
+  class ConnectionError < StandardError; end
 
 end

data/lib/adhearsion/foundation/future_resource.rb

@@ -27,7 +27,7 @@ class FutureResource
     end
   end
 
-  class ResourceAlreadySetException < Exception
+  class ResourceAlreadySetException < StandardError
     def initialize
       super "Cannot set this resource twice!"
     end

data/lib/adhearsion/host_definitions.rb

@@ -57,7 +57,7 @@ module Adhearsion
       self.class.definitions << self
     end
 
-    class HostDefinitionException < Exception
+    class HostDefinitionException < StandardError
 
     end
 

data/lib/adhearsion/initializer.rb

@@ -1,12 +1,22 @@
 module Adhearsion
 
+  mattr_accessor :status
+
   class << self
 
     ##
     # Shuts down the framework.
     #
     def shutdown!
+      if self.status == :stopping
+        # This is the second shutdown request we've received while attempting
+        # to shut down gracefully.  At this point, let's pull the plug...
+        ahn_log.warning "Shutting down immediately at #{Time.now}"
+        exit
+      end
       ahn_log "Shutting down gracefully at #{Time.now}."
+      self.status = :stopping
+      Events.trigger_immediately :shutdown
       Events.stop!
       exit
     end
@@ -115,7 +125,7 @@ module Adhearsion
     def initialize(path=nil, options={})
       @@started = true
       @path     = path
-      @daemon   = options[:daemon]
+      @daemon   = options[:daemon] || ENV['DAEMON']
       @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
       @loaded_init_files  = options[:loaded_init_files]
     end
@@ -123,6 +133,8 @@ module Adhearsion
     def start
       self.class.ahn_root = path
 
+      Adhearsion.status = :starting
+
       resolve_pid_file_path
       resolve_log_file_path
       daemonize! if should_daemonize?
@@ -140,6 +152,7 @@ module Adhearsion
       init_events_file
 
       ahn_log "Adhearsion initialized!"
+      Adhearsion.status = :running
 
       trigger_after_initialized_hooks
       join_important_threads
@@ -172,9 +185,7 @@ module Adhearsion
     def catch_termination_signal
       %w'INT TERM'.each do |process_signal|
         trap process_signal do
-          ahn_log "Shutting down gracefully at #{Time.now}."
-          Events.trigger_immediately :shutdown
-          exit
+          Adhearsion.shutdown!
         end
       end
     end
@@ -273,11 +284,13 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       require 'adhearsion/initializer/asterisk.rb'
       require 'adhearsion/initializer/drb.rb'
       require 'adhearsion/initializer/rails.rb'
+      require 'adhearsion/initializer/xmpp.rb'
       # require 'adhearsion/initializer/freeswitch.rb'
 
       AsteriskInitializer.start   if AHN_CONFIG.asterisk_enabled?
       DrbInitializer.start        if AHN_CONFIG.drb_enabled?
       RailsInitializer.start      if AHN_CONFIG.rails_enabled?
+      XMPPInitializer.start       if AHN_CONFIG.xmpp_enabled?
       # FreeswitchInitializer.start if AHN_CONFIG.freeswitch_enabled?
 
     end
@@ -303,7 +316,7 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
     end
 
     def should_daemonize?
-      @daemon || ENV['DAEMON']
+      @daemon
     end
 
     def daemonize!
@@ -324,8 +337,8 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       Logging::DefaultAdhearsionLogger.redefine_outputters
     end
 
-    def create_pid_file(file = pid_file)
-      if file
+    def create_pid_file
+      if pid_file
         File.open pid_file, 'w' do |file|
           file.puts Process.pid
         end
@@ -377,6 +390,6 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       end
     end
 
-    class InitializationFailedError < Exception; end
+    class InitializationFailedError < StandardError; end
   end
 end

data/lib/adhearsion/initializer/configuration.rb

@@ -129,8 +129,8 @@ module Adhearsion
       end
 
       def initialize(overrides = {})
-        @listening_port = self.class.default_listening_port
-        @listening_host = self.class.default_listening_host
+        @listening_port = overrides.has_key?(:port) ? overrides[:port] : self.class.default_listening_port
+        @listening_host = overrides.has_key?(:host) ? overrides[:host] : self.class.default_listening_host
         super
       end
     end
@@ -144,8 +144,10 @@ module Adhearsion
           4573
         end
 
+        # Keep Asterisk 1.4 (and prior) as the default to protect upgraders
+        # This setting only applies to AGI.  AMI delimiters are always
+        # auto-detected.
         def default_argument_delimiter
-          # Keep Asterisk 1.4 (and prior) as the default to protect upgraders
           '|'
         end
       end
@@ -265,5 +267,44 @@ module Adhearsion
     end
     add_configuration_for :Rails
 
+    class XMPPConfiguration < AbstractConfiguration
+
+      attr_accessor :jid, :password, :server, :port
+      def initialize(options)
+        jid, password, server, port = check_options options
+        @jid = jid
+        @password = password
+        @server = server
+        @port = port
+      end
+
+      class << self
+        def default_port
+          5222
+        end
+      end
+
+      private
+
+      def check_options(options)
+        options  = options.clone
+        jid      = options.delete :jid
+        password = options.delete :password
+        server   = options.delete :server
+        port     = options.delete :port
+        raise ArgumentError, "Unrecognied argument(s) #{options.keys.to_sentence} in XMPP initializer!" unless options.size.zero?
+        raise ArgumentError, "Must supply a :jid argument to the XMPP initializer!" unless jid
+        raise ArgumentError, "Must supply a :password argument to the XMPP initializer!" unless password
+        if server
+          port ||= self.class.default_port
+        else
+          raise ArgumentError, "Must supply a :server argument as well as :port to the XMPP initializer!" if port
+        end
+        [jid, password, server, port]
+      end
+
+    end
+    add_configuration_for :XMPP
+
   end
 end

data/lib/adhearsion/initializer/database.rb

@@ -14,6 +14,10 @@ module Adhearsion
           # You may need to uncomment the following line for older versions of ActiveRecord
           # ActiveRecord::Base.allow_concurrency = true
           establish_connection
+          ActiveRecord::Base.logger =
+            @@config.connection_options.has_key?(:logger) ?
+              @@config.connection_options[:logger] :
+              ahn_log.db
           create_call_hook_for_connection_cleanup
         end
 
@@ -30,7 +34,13 @@ module Adhearsion
         end
 
         def require_dependencies
-          require 'active_record'
+          begin
+            require 'active_record'
+          rescue LoadError
+            ahn_log.fatal "Database support requires the \"activerecord\" gem."
+            # Silence the abort so we don't get an ugly backtrace
+            abort ""
+          end
         end
 
         def require_models

data/lib/adhearsion/initializer/ldap.rb

@@ -31,7 +31,13 @@ module Adhearsion
         #end
 
         def require_dependencies
-          require 'active_ldap'
+          begin
+            require 'active_ldap'
+          rescue LoadError
+            ahn_log.fatal "LDAP support requires the \"activeldap\" gem."
+            # Silence the abort so we don't get an ugly backtrace
+            abort ""
+          end
         end
 
         def require_models