adhearsion 0.8.6 → 1.0.0

data/CHANGELOG

@@ -1,9 +1,33 @@
+1.0.0
+ - Fall back to using Asterisk's context if the AGI URI context is not found
+ - Enable configuration of :auto_reconnect parameter for AMI
+ - Replace all uses of Object#returning with Object#tap
+ - Add support for loading Adhearsion components from RubyGems
+ - Fix long-running AMI session parser failure bug (#72)
+ - Support for Rails 3 (and ActiveSupport 3.0)
+
 0.8.6
  - Fix packaging problem so all files are publicly readable
  - Improve AMI reconnecting logic; add "connection refused" retry timer
  - AGI protocol improvements: parse the status code and response text
 
 0.8.5
+  NOTE: If you are upgrading an Adhearsion application to 0.8.5, note the change
+  to how request URIs are handled.  With 0.8.4, the context name in Asterisk was
+  required to match the Adhearsion context in dialplan.rb.  Starting in 0.8.5 if
+  an application path is passed in on the AGI URI, it will be preferred over the
+  context name.  For example:
+  
+  [stuff]
+  exten => _X.,1,AGI(agi://localhost/myapp)
+  
+  AHN 0.8.4- will execute the "stuff" context in dialplan.rb
+  AHN 0.8.5+ will execute the "myapp" context in dialplan.rb
+  
+  If you followed the documentation and did not specify an application path in
+  the URI (eg. agi://localhost) you will not be impacted by this change.
+
+  Other changes:
  - 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

data/Rakefile

@@ -4,11 +4,13 @@ ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
 require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/testtask'
+require 'date'
 
 begin
+  gem 'rspec', '~> 1.3.0'
   require 'spec/rake/spectask'
 rescue LoadError
-  abort "You must install RSpec: sudo gem install rspec"
+  abort "You must install RSpec 1.3: sudo gem install rspec -v'<2.0.0'"
 end
 
 begin

data/adhearsion.gemspec

@@ -60,6 +60,7 @@ ADHEARSION_FILES = %w{
   lib/adhearsion/initializer/xmpp.rb
   lib/adhearsion/logging.rb
   lib/adhearsion/tasks.rb
+  lib/adhearsion/tasks/components.rb
   lib/adhearsion/tasks/database.rb
   lib/adhearsion/tasks/deprecations.rb
   lib/adhearsion/tasks/generating.rb
@@ -122,7 +123,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Phillips", "Jason Goecke", "Ben Klang"]
 
-  s.date = "2010-08-24"
+  s.date = Date.today.to_s
   s.description = "Adhearsion is an open-source telephony development framework"
   s.email = "dev&Adhearsion.com"
   s.executables = ["ahn", "ahnctl", "jahn"]
@@ -135,22 +136,38 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "adhearsion"
   s.rubygems_version = "1.2.0"
   s.summary = "Adhearsion, open-source telephony development framework"
+  s.post_install_message =<<-EOM
+    *******************************************************************
+    * NOTE: You must manually install the "rubigen" gem to create     *
+    * new Adhearsion applications.                                    *
+    *                                                                 *
+    * The Rubigen package is no longer automatically installed due to *
+    * dependency conflicts with ActiveSupport 3.0.                    *
+    * Users of existing Adhearsion applications can safely ignore     *
+    * this message.                                                   *
+    *******************************************************************
+  EOM
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
     if current_version >= 3 then
-      s.add_runtime_dependency("rubigen", [">= 1.0.6"])
+      # Runtime dependencies
       s.add_runtime_dependency("log4r", [">= 1.0.5"])
       s.add_runtime_dependency("activesupport", [">= 2.1.0"])
+
+      # Development dependencies
+      s.add_development_dependency('rubigen', [">= 1.0.6"])
+      s.add_development_dependency('rspec', ["< 2.0.0"])
+      s.add_development_dependency('test-unit')
+      s.add_development_dependency('flexmock')
+      s.add_development_dependency('active_record')
     else
-      s.add_dependency("rubigen", [">= 1.0.6"])
       s.add_dependency("log4r", [">= 1.0.5"])
       s.add_dependency("activesupport", [">= 2.1.0"])
     end
   else
-    s.add_dependency("rubigen", [">= 1.0.6"])
     s.add_dependency("log4r", [">= 1.0.5"])
     s.add_dependency("activesupport", [">= 2.1.0"])
   end

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

@@ -1,5 +1,9 @@
-require 'rack'
-require 'json'
+begin
+  require 'rack'
+  require 'json'
+rescue LoadError
+  abort "ERROR: restful_rpc requires the 'rack' and 'json' gems"
+end
 
 # Don't you love regular expressions? Matches only 0-255 octets. Recognizes "*" as an octet wildcard.
 VALID_IP_ADDRESS = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|\*)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|\*)$/

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

@@ -1,7 +1,9 @@
 unless defined? Adhearsion
   if File.exists? File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
-    # If you wish to freeze a copy of Adhearsion to this app, simply place a copy of Adhearsion
-    # into a folder named "adhearsion" within this app's main directory.
+    # For development purposes try to load a local copy of Adhearsion here.
+    # This will not work if started using "ahn" or "jahn".  You must execute
+    # config/startup.rb directly and have a local checkout of Adhearsion in your
+    # application directory.
     require File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
   else
     require 'rubygems'
@@ -12,6 +14,13 @@ end
 
 Adhearsion::Configuration.configure do |config|
 
+  # Components to load from the system.
+  # All components that are activated in components/ will be automatically
+  # loaded and made available.
+  # This configuration option allows you to load components provided by gems.
+  # List the gem names here:
+  # config.add_component "ahn_test_component"
+
   # Supported levels (in increasing severity) -- :debug < :info < :warn < :error < :fatal
   config.logging :level => :info
 

data/lib/adhearsion.rb

@@ -24,7 +24,13 @@ require 'adhearsion/voip/asterisk/commands'
 require 'adhearsion/voip/dsl/dialing_dsl'
 require 'adhearsion/voip/call_routing'
 
-require 'active_support/core_ext'
+begin
+  # Try ActiveSupport >= 2.3.0
+  require 'active_support/all'
+rescue LoadError
+  # Assume ActiveSupport < 2.3.0
+  require 'active_support'
+end
 
 module Adhearsion
   # Sets up the Gem require path.

data/lib/adhearsion/component_manager.rb

@@ -43,6 +43,13 @@ module Adhearsion
         components.map! { |path| File.basename path }
         components.each do |component|
           next if component == "disabled"
+          component_file = File.join(@path_to_container_directory, component, 'lib', component + ".rb")
+          if File.exists? component_file
+            load_file component_file
+            next
+          end
+
+          # Try the old-style components/<component>/<component>.rb
           component_file = File.join(@path_to_container_directory, component, component + ".rb")
           if File.exists? component_file
             load_file component_file
@@ -51,6 +58,11 @@ module Adhearsion
           end
         end
 
+        # Load configured system- or gem-provided components
+        AHN_CONFIG.components_to_load.each do |component|
+          require component
+        end
+
       end
 
       ##
@@ -59,11 +71,19 @@ module Adhearsion
       # @return [Hash] The loaded YAML for the given component name. An empty Hash if no YAML file exists.
       #
       def configuration_for_component_named(component_name)
+        # Look for configuration in #{AHN_ROOT}/config/components first
+        if File.exists?("#{AHN_ROOT}/config/components/#{component_name}.yml")
+          return YAML.load_file "#{AHN_ROOT}/config/components/#{component_name}.yml"
+        end
+
+        # Next try the local app component directory
         component_dir = File.join(@path_to_container_directory, component_name)
         config_file = File.join component_dir, "#{component_name}.yml"
         if File.exists?(config_file)
           YAML.load_file config_file
         else
+          # Nothing found? Return an empty hash
+          ahn_log.warn "No configuration found for requested component #{component_name}"
           return {}
         end
       end
@@ -92,6 +112,10 @@ module Adhearsion
         load_container ComponentDefinitionContainer.load_file(filename)
       end
 
+      def require(filename)
+        load_container ComponentDefinitionContainer.require(filename)
+      end
+
       protected
 
       def load_container(container)
@@ -116,16 +140,37 @@ module Adhearsion
 
         class << self
           def load_code(code)
-            returning(new) do |instance|
+            new.tap do |instance|
               instance.module_eval code
             end
           end
 
           def load_file(filename)
-            returning(new) do |instance|
+            new.tap do |instance|
               instance.module_eval File.read(filename), filename
             end
           end
+
+          def require(filename)
+            filename = filename + ".rb" if !(filename =~ /\.rb$/)
+            begin
+              # Try loading the exact filename first
+              load_file(filename)
+            rescue LoadError, Errno::ENOENT
+            end
+
+            # Next try Rubygems
+            filepath = get_gem_path_for(filename)
+            return load_file(filepath) if !filepath.nil?
+
+            # Finally try the system search path
+            filepath = get_system_path_for(filename)
+            return load_file(filepath) if !filepath.nil?
+
+            # Raise a LoadError exception if the file is still not found
+            raise LoadError, "File not found: #{filename}"
+          end
+
         end
 
         def initialize(&block)
@@ -170,6 +215,26 @@ module Adhearsion
             @methods ||= []
             @methods << method_name
           end
+
+          def get_gem_path_for(filename)
+            # Look for component files provided by rubygems
+            spec = Gem.searcher.find(filename)
+            return nil if spec.nil?
+            File.join(spec.full_gem_path, spec.require_path, filename)
+          rescue NameError
+            # In case Rubygems are not available
+            nil
+          end
+
+          def get_system_path_for(filename)
+            $:.each do |path|
+              filepath = File.join(path, filename)
+              return filepath if File.exists?(filepath)
+            end
+
+            # Not found? Return nil
+            return nil
+          end
         end
 
       end

data/lib/adhearsion/foundation/all.rb

@@ -1,7 +1,13 @@
 require 'English'
 require 'tmpdir'
 require 'tempfile'
-require 'active_support'
+begin
+  # Try ActiveSupport >= 2.3.0
+  require 'active_support/all'
+rescue LoadError
+  # Assume ActiveSupport < 2.3.0
+  require 'active_support'
+end
 
 # Require all other files here.
 Dir.glob File.join(File.dirname(__FILE__), "*rb") do |file|

data/lib/adhearsion/foundation/blank_slate.rb

@@ -1,5 +1,3 @@
 class BlankSlate
-  instance_methods.each do |method|
-    undef_method method unless method =~ /^__/ || method == 'instance_eval'
-  end
+  (instance_methods - %w{instance_eval object_id}).each { |m| undef_method m unless m =~ /^__/ }
 end

data/lib/adhearsion/initializer.rb

@@ -128,11 +128,10 @@ module Adhearsion
       @daemon   = options[:daemon] || ENV['DAEMON']
       @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
       @loaded_init_files  = options[:loaded_init_files]
+      self.class.ahn_root = path
     end
 
     def start
-      self.class.ahn_root = path
-
       Adhearsion.status = :starting
 
       resolve_pid_file_path

data/lib/adhearsion/initializer/asterisk.rb

@@ -35,7 +35,7 @@ module Adhearsion
         def initialize_ami
           options = ami_options
           start_ami_after_initialized
-          returning VoIP::Asterisk::Manager::ManagerInterface.new(options) do
+          VoIP::Asterisk::Manager::ManagerInterface.new(options).tap do
             class << VoIP::Asterisk
               if respond_to?(:manager_interface)
                 ahn_log.warn "Asterisk.manager_interface already initialized?"
@@ -50,7 +50,7 @@ module Adhearsion
         end
 
         def ami_options
-          %w(host port username password events).inject({}) do |options, property|
+          %w(host port username password events auto_reconnect).inject({}) do |options, property|
             options[property.to_sym] = config.ami.send property
             options
           end

data/lib/adhearsion/initializer/configuration.rb

@@ -35,11 +35,13 @@ module Adhearsion
     attr_accessor :automatically_answer_incoming_calls
     attr_accessor :end_call_on_hangup
     attr_accessor :end_call_on_error
+    attr_accessor :components_to_load
 
     def initialize
       @automatically_answer_incoming_calls = true
       @end_call_on_hangup                  = true
       @end_call_on_error                   = true
+      @components_to_load                  = []
       yield self if block_given?
     end
 
@@ -67,6 +69,10 @@ module Adhearsion
       Adhearsion::Logging.logging_level = options[:level]
     end
 
+    def add_component(*list)
+      AHN_CONFIG.components_to_load |= list
+    end
+
     ##
     # Adhearsion's .ahnrc file is used to define paths to certain parts of the framework. For example, the name dialplan.rb
     # is actually specified in .ahnrc. This file can actually be just a filename, a filename with a glob (.e.g "*.rb"), an
@@ -129,8 +135,8 @@ module Adhearsion
       end
 
       def initialize(overrides = {})
-        @listening_port = overrides.has_key?(:port) ? overrides.delete(:port) : self.class.default_listening_port
         @listening_host = overrides.has_key?(:host) ? overrides.delete(:host) : self.class.default_listening_host
+        @listening_port = overrides.has_key?(:port) ? overrides.delete(:port) : self.class.default_listening_port
         super
       end
     end
@@ -158,7 +164,7 @@ module Adhearsion
       end
 
       class AMIConfiguration < AbstractConfiguration
-        attr_accessor :port, :username, :password, :events, :host
+        attr_accessor :port, :username, :password, :events, :host, :auto_reconnect
 
         class << self
           def default_port
@@ -172,12 +178,17 @@ module Adhearsion
           def default_host
             'localhost'
           end
+
+          def default_auto_reconnect
+            true
+          end
         end
 
         def initialize(overrides = {})
-          self.host   = self.class.default_host
-          self.port   = self.class.default_port
-          self.events = self.class.default_events
+          self.host           = self.class.default_host
+          self.port           = self.class.default_port
+          self.events         = self.class.default_events
+          self.auto_reconnect = self.class.default_auto_reconnect
           super
         end
       end

data/lib/adhearsion/tasks.rb

@@ -1,5 +1,6 @@
 require 'rake/testtask'
 require 'adhearsion'
+require 'adhearsion/tasks/components'
 require 'adhearsion/tasks/database'
 require 'adhearsion/tasks/testing'
 require 'adhearsion/tasks/generating'

data/lib/adhearsion/tasks/components.rb

@@ -0,0 +1,32 @@
+namespace:components do
+  desc "Install component configuration from templates"
+  task :genconfig do
+    init = Adhearsion::Initializer.new(Rake.original_dir)
+    init.bootstrap_rc
+    init.load_all_init_files
+    Adhearsion::AHN_CONFIG.components_to_load.each do |component|
+      spec = Gem.searcher.find(component)
+      if spec.nil?
+        abort "ERROR: Required gem component #{component} not found."
+      end
+
+      yml = File.join(spec.full_gem_path, 'config', "#{component}.yml")
+      target = File.join(AHN_ROOT, 'config', 'components', "#{component}.yml")
+      Dir.mkdir(File.dirname(target)) if !File.exists?(File.dirname(target))
+      if File.exists?(target)
+        puts "Skipping existing configuration for component #{component}"
+        next
+      end
+      if File.exists?(yml)
+        begin
+          FileUtils.cp(yml, target)
+          puts "Installed default configuration for component #{component}"
+        rescue => e
+          abort "Error copying configuration for component #{component}: #{e.message}"
+        end
+      else
+        puts "No template configuration found for component #{component}"
+      end
+    end
+  end
+end

data/lib/adhearsion/version.rb

@@ -1,8 +1,8 @@
 module Adhearsion #:nodoc:
   module VERSION #:nodoc:
-    MAJOR = 0 unless defined? MAJOR
-    MINOR = 8 unless defined? MINOR
-    TINY  = 6 unless defined? TINY
+    MAJOR = 1 unless defined? MAJOR
+    MINOR = 0 unless defined? MINOR
+    TINY  = 0 unless defined? TINY
 
     STRING = [MAJOR, MINOR, TINY].join('.') unless defined? STRING
   end