adhearsion 0.8.3 → 0.8.4

data/CHANGELOG

@@ -1,3 +1,12 @@
+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
+ - Daemonizing no longer truncates the Adhearsion log file
+ - Add support for using ActiveLdap
+ - Misc improvements to support Asterisk 1.6 changes
+ - Escape commands sent to Asterisk via AGI
+ - Manager Events now work when daemonized
+
 0.8.3
  - The "uniqueid" call channel variable available in dialplan.rb is now *always* a String
  - Renamed interruptable_play to interruptible_play and made interruptible_play() public instead of protected.
@@ -10,7 +19,7 @@
  - Fixes an inconsequential bug when CTL-C'ing Adhearsion.
 
 0.8.1
- - The sandbox component now comes 
+ - The sandbox component now comes
  - Minor bug fixes
 
 0.8.0 rev 2
@@ -21,4 +30,4 @@ Notes from before 0.8.0:
  - Adding a deprecation warning about Fixnum#digit and Fixnum#digits
  - Removed the AMI class and replaced it with the ManagerInterface class.
  - The old AMI high-level instance methods are available in the new ManagerInterface class, but a deprecation warning will be logged each time they're used. When the SuperManager class is implemented, they'll be removed entirely.
- - Moved Theatre into Adhearsion's lib folder.
+ - Moved Theatre into Adhearsion's lib folder.

data/EVENTS

@@ -1,5 +1,5 @@
 # Below are a list of framework events:
-  
+
 - after_initialized
 - shutdown
 - asterisk:

data/Rakefile

@@ -88,13 +88,13 @@ end
 
 desc "Compares Adhearsion's files with those listed in adhearsion.gemspec"
 task :check_gemspec_files do
-  
+
   files_from_gemspec    = ADHEARSION_FILES
   files_from_filesystem = Dir.glob(File.dirname(__FILE__) + "/**/*").map do |filename|
     filename[0...Dir.pwd.length] == Dir.pwd ? filename[(Dir.pwd.length+1)..-1] : filename
   end
   files_from_filesystem.reject! { |f| File.directory? f }
-  
+
   puts
   puts 'Pipe this command to "grep -v \'spec/\' | grep -v test" to ignore test files'
   puts
@@ -102,8 +102,8 @@ task :check_gemspec_files do
   puts '## Files on filesystem not in the gemspec:'
   puts '##########################################'
   puts((files_from_filesystem - files_from_gemspec).map { |f| "  " + f })
-  
-  
+
+
   puts '##########################################'
   puts '## Files in gemspec not in the filesystem:'
   puts '##########################################'

data/adhearsion.gemspec

@@ -51,6 +51,7 @@ ADHEARSION_FILES = %w{
   lib/adhearsion/initializer/asterisk.rb
   lib/adhearsion/initializer/configuration.rb
   lib/adhearsion/initializer/database.rb
+  lib/adhearsion/initializer/ldap.rb
   lib/adhearsion/initializer/drb.rb
   lib/adhearsion/initializer/freeswitch.rb
   lib/adhearsion/initializer/rails.rb
@@ -112,18 +113,18 @@ ADHEARSION_FILES = %w{
 
 Gem::Specification.new do |s|
   s.name = "adhearsion"
-  s.version = "0.8.3"
+  s.version = "0.8.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Phillips"]
 
   s.date = "2008-08-21"
   s.description = "Adhearsion is an open-source telephony development framework"
-  s.email = "Jay -at- Codemecca.com"
+  s.email = "Jay&Adhearsion.com"
   s.executables = ["ahn", "ahnctl", "jahn"]
-  
+
   s.files = ADHEARSION_FILES
-  
+
   s.has_rdoc = false
   s.homepage = "http://adhearsion.com"
   s.require_paths = ["lib"]
@@ -138,12 +139,15 @@ Gem::Specification.new do |s|
     if current_version >= 3 then
       s.add_runtime_dependency("rubigen", [">= 1.0.6"])
       s.add_runtime_dependency("log4r", [">= 1.0.5"])
+      s.add_runtime_dependency("activesupport", [">= 2.1.0"])
     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
 end

data/app_generators/ahn/USAGE

@@ -1,5 +1,5 @@
 Description:
-  
-  
+
+
 Usage:
-  
+

data/app_generators/ahn/ahn_generator.rb

@@ -1,12 +1,12 @@
 class AhnGenerator < RubiGen::Base
-  
+
   DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
                               Config::CONFIG['ruby_install_name'])
-  
+
   default_options :author => nil
-  
+
   attr_reader :name, :component
-  
+
   def initialize(runtime_args, runtime_options = {})
     super
     usage if args.empty?
@@ -23,30 +23,30 @@ class AhnGenerator < RubiGen::Base
       BASEDIRS.each { |path| m.directory path }
 
       m.file  *[".ahnrc"]*2
-      
+
       m.file  *["components/simon_game/simon_game.rb"]*2
       m.file  *["components/ami_remote/ami_remote.rb"]*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
-      
+
       m.file  *["components/disabled/restful_rpc/restful_rpc.rb"]*2
       m.file  *["components/disabled/restful_rpc/restful_rpc.yml"]*2
       m.file  *["components/disabled/restful_rpc/README.markdown"]*2
       m.file  *["components/disabled/restful_rpc/example-client.rb"]*2
       m.file  *["components/disabled/restful_rpc/spec/restful_rpc_spec.rb"]*2
-      
+
       m.file  *["components/disabled/sandbox/sandbox.yml"]*2
       m.file  *["components/disabled/sandbox/sandbox.rb"]*2
-      
+
       m.file  *["config/startup.rb"]*2
       m.file  *["dialplan.rb"]*2
       m.file  *["events.rb"]*2
       m.file  *["README"]*2
       m.file  *["Rakefile"]*2
-      
-      # m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'], 
+
+      # m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'],
       #   :shebang => options[:shebang], :collision => :force
     end
   end
@@ -70,7 +70,7 @@ EOS
       #         "Default: none") { |options[:author]| }
       opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
     end
-    
+
     def extract_options
       # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
       # Templates can access these value via the attr_reader-generated methods, but not the

data/app_generators/ahn/templates/components/ami_remote/ami_remote.rb

@@ -1,7 +1,7 @@
 methods_for :rpc do
-  
+
   # Simply create proxy methods for the high-level AMI methods
-  
+
   [:send_action, :introduce, :originate, :call_into_context, :call_and_exec, :ping].each do |method_name|
     define_method(method_name) do |*args|
       if VoIP::Asterisk.manager_interface
@@ -11,5 +11,5 @@ methods_for :rpc do
       end
     end
   end
-  
+
 end

data/app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb

@@ -5,28 +5,28 @@ require 'json'
 # You must have the "rest-client" and "json" gems installed for this file to work.
 
 class RESTfulAdhearsion
-  
+
   DEFAULT_OPTIONS = {
     # Note: :user and :password are non-existent by default
     :host => "localhost",
     :port => "5000",
     :path_nesting => "/"
   }
-  
+
   def initialize(options={})
     @options = DEFAULT_OPTIONS.merge options
-    
+
     @path_nesting = @options.delete :path_nesting
     @host = @options.delete :host
     @port = @options.delete :port
-    
+
     @url_beginning = "http://#{@host}:#{@port}#{@path_nesting}"
   end
-  
+
   def method_missing(method_name, *args)
     JSON.parse RestClient::Resource.new(@url_beginning + method_name.to_s, @options).post(args.to_json)
   end
-  
+
 end
 
 Adhearsion = RESTfulAdhearsion.new :host => "localhost", :port => 5000, :user => "jicksta", :password => "roflcopterz"

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

@@ -6,9 +6,9 @@ VALID_IP_ADDRESS = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|\*)\.){3}(?:25[0
 
 def ip_allowed?(ip)
   raise ArgumentError, "#{ip.inspect} is not a valid IP address!" unless ip.kind_of?(String) && ip =~ VALID_IP_ADDRESS
-  
+
   octets = ip.split "."
-  
+
   case COMPONENTS.restful_rpc["access"]
     when "everyone"
       true
@@ -37,51 +37,51 @@ end
 
 RESTFUL_API_HANDLER = lambda do |env|
   json = env["rack.input"].read
-  
+
   # Return "Bad Request" HTTP error if the client forgot
   return [400, {}, "You must POST a valid JSON object!"] if json.blank?
-  
+
   json = JSON.parse json
-  
+
   nesting = COMPONENTS.restful_rpc["path_nesting"]
   path = env["PATH_INFO"]
-  
+
   return [404, {}, "This resource does not respond to #{path.inspect}"] unless path[0...nesting.size] == nesting
-  
+
   path = path[nesting.size..-1]
-  
+
   return [404, {"Content-Type" => "application/json"}, "You cannot nest method names!"] if path.include?("/")
-  
+
   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)
   [200, {"Content-Type" => "application/json"}, response_object.to_json]
-  
+
 end
 
 initialization do
   config = COMPONENTS.restful_rpc
-  
+
   api = RESTFUL_API_HANDLER
 
   port            = config["port"] || 5000
   authentication  = config["authentication"]
   show_exceptions = config["show_exceptions"]
   handler         = Rack::Handler.const_get(config["handler"] || "Mongrel")
-  
+
   if authentication
     api = Rack::Auth::Basic.new(api) do |username, password|
       authentication[username] == password
     end
     api.realm = "Adhearsion API"
   end
-  
+
   if show_exceptions
     api = Rack::ShowStatus.new(Rack::ShowExceptions.new(api))
   end
-  
+
   Thread.new do
-    handler.run api, :Port => port  
+    handler.run api, :Port => port
   end
 end

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

@@ -50,61 +50,61 @@ RESTFUL_RPC = ComponentTester.new("restful_rpc", File.dirname(__FILE__) + "/../.
 
 
 describe "The VALID_IP_ADDRESS regular expression" do
-  
+
   it "should match only valid IP addresses" do
     valid_ip_addresses   = ["192.168.1.98", "10.0.1.200", "255.255.255.0", "123.*.4.*"]
     invalid_ip_addresses = ["10.0.1.1 foo", "bar 255.255.255.0", "0*0*0*0", "1234"]
-    
+
     valid_ip_addresses.  each { |ip| RESTFUL_RPC::VALID_IP_ADDRESS.should =~ ip }
     invalid_ip_addresses.each { |ip| RESTFUL_RPC::VALID_IP_ADDRESS.should_not =~ ip }
   end
 end
 
 describe "The initialization block" do
-  
+
   it "should create a new Thread" do
     mock_component_config_with :restful_rpc => {}
     mock(Thread).new { nil }
     RESTFUL_RPC.initialize!
   end
-  
+
   it "should run the Rack adapter specified in the configuration" do
     mock(Thread).new.yields
     mock_component_config_with :restful_rpc => {"adapter" => "Mongrel"}
     mock(Rack::Handler::Mongrel).run is_a(Proc), :Port => 5000
     RESTFUL_RPC.initialize!
   end
-  
+
   it "should wrap the RESTFUL_API_HANDLER in an Rack::Auth::Basic object if authentication is enabled" do
     mock(Thread).new.yields
     mock_component_config_with :restful_rpc => {"authentication" => {"foo" => "bar"}}
-    
+
     proper_authenticator = lambda do |obj|
       request = OpenStruct.new :credentials => ["foo", "bar"]
       obj.is_a?(Rack::Auth::Basic) && obj.send(:valid?, request)
     end
-    
+
     mock(Rack::Handler::Mongrel).run(satisfy(&proper_authenticator), :Port => 5000)
     RESTFUL_RPC.initialize!
   end
-  
+
   it 'should wrap the RESTFUL_API_HANDLER in ShowStatus and ShowExceptions objects when show_exceptions is enabled' do
     mock(Thread).new.yields
     mock_component_config_with :restful_rpc => {"show_exceptions" => true}
-    
+
     mock.proxy(Rack::ShowExceptions).new(is_a(Proc))
     mock.proxy(Rack::ShowStatus).new is_a(Rack::ShowExceptions)
-    
+
     mock(Rack::Handler::Mongrel).run is_a(Rack::ShowStatus), :Port => 5000
     RESTFUL_RPC.initialize!
   end
-  
+
 end
 
 describe 'Private helper methods' do
 
   describe "the RESTFUL_API_HANDLER lambda" do
-    
+
     it "should return a 200 for requests which execute a method that has been defined in the methods_for(:rpc) context" do
       component_manager = Adhearsion::Components::ComponentManager.new('/path/shouldnt/matter')
 
@@ -116,38 +116,38 @@ describe 'Private helper methods' do
           end
         end
       RUBY
-    
+
       input = StringIO.new %w[jay phillips].to_json
-      
+
       mock_component_config_with :restful_rpc => {"path_nesting" => "/"}
-      
+
       env = {"PATH_INFO" => "/testing_123456", "rack.input" => input}
-    
+
       response = RESTFUL_RPC::RESTFUL_API_HANDLER.call(env)
       response.should be_kind_of(Array)
       response.should have(3).items
       response.first.should equal(200)
       JSON.parse(response.last).should eql(%w[jay phillips].map(&:reverse).reverse)
     end
-    
+
     it "should return a 400 when no data is POSTed" do
       env = {"rack.input" => StringIO.new(""), "REQUEST_URI" => "/foobar"}
       RESTFUL_RPC::RESTFUL_API_HANDLER.call(env).first.should equal(400)
     end
-    
+
     it "should work with a high level test of a successful method invocation" do
-      
+
       component_manager = Adhearsion::Components::ComponentManager.new('/path/shouldnt/matter')
 
       mock(Adhearsion::Components).component_manager { component_manager }
-      
+
       component_manager.load_code '
         methods_for(:rpc) do
           def rofl(one,two)
             "Hai! #{one} #{two}"
           end
         end'
-      
+
       env = {
         "CONTENT_LENGTH"       => "12",
         "CONTENT_TYPE"         => "application/x-www-form-urlencoded",
@@ -177,78 +177,78 @@ describe 'Private helper methods' do
         "SERVER_PORT"          => "5000",
         "SERVER_PROTOCOL"      => "HTTP/1.1",
         "SERVER_SOFTWARE"      => "WEBrick/1.3.1 (Ruby/1.8.6/2008-03-03)" }
-      
+
       response = RESTFUL_RPC::RESTFUL_API_HANDLER.call(env)
       JSON.parse(response.last).should == ["Hai! o hai!"]
-      
+
     end
-    
+
     it "should contain backtrace information when show_errors is enabled and an exception occurs" do
       mock_component_config_with :restful_api => {"show_errors" => true}
       pending
     end
-    
+
   end
-  
+
   describe 'the ip_allowed?() method' do
-    
+
     before :each do
       @method = RESTFUL_RPC.helper_method :ip_allowed?
     end
-    
+
     it 'should raise a ConfigurationError if "access" is not one of "everyone", "whitelist" or "blacklist"' do
       good_access_values = %w[everyone whitelist blacklist]
       bad_access_values  = %w[foo bar qaz qwerty everone blaclist whitlist]
-      
+
       good_access_values.each do |access_value|
         mock_component_config_with :restful_rpc => {"access" => access_value, "whitelist" => [], "blacklist" => []}
         lambda { @method.call("10.0.0.1") }.should_not raise_error
       end
-      
+
       bad_access_values.each do |access_value|
         mock_component_config_with :restful_rpc => {"access" => access_value, "authentication" => false}
         lambda { @method.call("10.0.0.1") }.should raise_error(Adhearsion::Components::ConfigurationError)
       end
     end
-    
+
     describe 'whitelists' do
-      
+
       it "should parse *'s as wildcards" do
         mock_component_config_with :restful_rpc => {"access" => "whitelist", "whitelist" => ["10.*.*.*"]}
         @method.call("10.1.2.3").should be_true
       end
-      
+
       it "should allow IPs which are explictly specified" do
         mock_component_config_with :restful_rpc => {"access" => "whitelist", "whitelist" => ["4.3.2.1"]}
         @method.call("4.3.2.1").should be_true
       end
-      
+
       it "should not allow IPs which are not explicitly specified" do
         mock_component_config_with :restful_rpc => {"access" => "whitelist", "whitelist" => %w[ 1.2.3.4 4.3.2.1]}
         @method.call("2.2.2.2").should be_false
       end
-      
+
     end
-    
+
     describe 'blacklists' do
-      
+
       it "should parse *'s as wildcards" do
         mock_component_config_with :restful_rpc => {"access" => "blacklist", "blacklist" => ["10.*.*.*"]}
         @method.call("10.1.2.3").should be_false
       end
-      
+
       it "should not allow IPs which are explicitly specified" do
         mock_component_config_with :restful_rpc => {"access" => "blacklist", "blacklist" => ["9.8.7.6", "9.8.7.5"]}
         @method.call("9.8.7.5").should be_false
       end
-      
+
       it "should allow IPs which are not explicitly specified" do
         mock_component_config_with :restful_rpc => {"access" => "blacklist", "blacklist" => ["10.20.30.40"]}
         @method.call("1.1.1.1").should be_true
       end
-      
+
     end
-    
+
     describe '"everyone" access' do
       it "should return true for any IP given, irrespective of the configuration" do
         ip_addresses = %w[100.200.100.200 0.0.0.0 *.0.0.*]
@@ -257,7 +257,7 @@ describe 'Private helper methods' do
         end
       end
     end
-    
+
   end
 
 end