adhearsion 1.2.0 → 1.2.1

data/CHANGELOG

@@ -1,3 +1,11 @@
+1.2.1
+ - Removed the restful_rpc component since it is now in a gem.
+ - Allow overriding the path to a component in the testing framework so as to support new style components (lib/)
+ - Added a GUID to the default recording filename to ensure uniqueness
+ - ECONNRESET exceptions are now handled as a call hangup
+ - Fixed escaping of TTS strings containing commas when used with Cepstral via #speak
+ - Made logging exceptions the responsibility of the framework rather than the app, so that this may not be disabled
+
 1.2.0
  - New method: #play_or_speak allows playback of an audio file with TTS fallback
  - #input now takes :speak as a hash for TTS prompt or fallback

data/app_generators/ahn/ahn_generator.rb

@@ -35,12 +35,6 @@ class AhnGenerator < RubiGen::Base
       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  *["config/environment.rb"]*2
       m.file  *["config/startup.rb"]*2
       m.file  *["dialplan.rb"]*2
@@ -89,7 +83,6 @@ EOS
       components/disabled/stomp_gateway
       components/disabled/xmpp_gateway
       components/ami_remote
-      components/disabled/restful_rpc/spec
       config
       script
     )

data/app_generators/ahn/templates/Gemfile

@@ -1,3 +1,10 @@
 source "http://rubygems.org"
 
-gem "adhearsion", ">= 1.0.1"
+gem "adhearsion", ">= 1.2.1"
+
+#
+# Here are some example components you might like to use. Simply
+# uncomment them, run `bundle install` and enable in startup.rb.
+#
+
+# gem 'ahn-restful-rpc'

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

@@ -30,6 +30,7 @@ Adhearsion::Configuration.configure do |config|
   # For Asterisk >= 1.6, use ","
   # The delimiter can also be specified in Asterisk's asterisk.conf.
   # This setting applies only to AGI.  The AMI delimiter is auto-detected.
+  # NB: The AMI user should have write access in order to execute actions, and AMI connections will fail otherwise.
   config.enable_asterisk :argument_delimiter => '|'
   # config.asterisk.enable_ami :host => "127.0.0.1", :username => "admin", :password => "password", :events => true
 

data/app_generators/ahn/templates/events.rb

@@ -31,9 +31,3 @@
 #
 # Note: events are mostly for components to register and expose to you.
 ##
-
-events.exception.each do |e|
-  ahn_log.error "#{e.class}: #{e.message}"
-  ahn_log.error e.backtrace.join("\n\t")
-end
-

data/lib/adhearsion/component_manager/component_tester.rb

@@ -7,9 +7,10 @@ module ComponentTester
     #
     # @return [Module] an anonymous module which includes the ComponentTester module.
     #
-    def new(component_name, component_directory)
+    def new(component_name, component_directory, main_file = nil)
       component_directory = File.expand_path component_directory
-      main_file = component_directory + "/#{component_name}/#{component_name}.rb"
+      main_file ||= "/#{component_name}/#{component_name}.rb"
+      main_file.insert 0, component_directory
 
       component_manager = Adhearsion::Components::ComponentManager.new(component_directory)
       component_module  = Adhearsion::Components::ComponentManager::ComponentDefinitionContainer.load_file main_file

data/lib/adhearsion/foundation/object.rb

@@ -1,6 +1,6 @@
 # Monkey patch Object to support the #tap method.
 # This method is present in Ruby 1.8.7 and later.
-if !Object.respond_to?(:tap)
+unless Object.respond_to?(:tap)
   class Object
     def tap
       yield self

data/lib/adhearsion/initializer.rb

@@ -143,6 +143,7 @@ module Adhearsion
       create_pid_file if pid_file
       bootstrap_rc
       initialize_log_file
+      initialize_exception_logger
       load_all_init_files
       init_datasources
       init_components_subsystem
@@ -355,6 +356,13 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       Logging::DefaultAdhearsionLogger.redefine_outputters
     end
 
+    def initialize_exception_logger
+      Events.register_callback :exception do |e|
+        ahn_log.error "#{e.class}: #{e.message}"
+        ahn_log.debug e.backtrace.join("\n\t")
+      end
+    end
+
     def create_pid_file
       if pid_file
         File.open pid_file, 'w' do |file|

data/lib/adhearsion/version.rb

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

data/lib/adhearsion/voip/asterisk/commands.rb

@@ -55,36 +55,40 @@ module Adhearsion
 
         # Utility method to read from pbx. Hangup if nil.
         def read
-          from_pbx.gets.tap do |message|
-            # AGI has many conditions that might indicate a hangup
-            raise Hangup if message.nil?
-
-            ahn_log.agi.debug "<<< #{message}"
-
-            code, rest = *message.split(' ', 2)
-
-            case code.to_i
-            when 510
-              # This error is non-fatal for the call
-              ahn_log.agi.warn "510: Invalid or unknown AGI command"
-            when 511
-              # 511 Command Not Permitted on a dead channel
-              ahn_log.agi.debug "511: Dead channel. Raising Hangup"
-              raise Hangup
-            when 520
-              # This error is non-fatal for the call
-              ahn_log.agi.warn "520: Invalid command syntax"
-            when (500..599)
-              # Assume this error is non-fatal for the call and try to keep running
-              ahn_log.agi.warn "#{code}: Unknown AGI protocol error."
-            end
+          begin
+            from_pbx.gets.tap do |message|
+              # AGI has many conditions that might indicate a hangup
+              raise Hangup if message.nil?
+
+              ahn_log.agi.debug "<<< #{message}"
+
+              code, rest = *message.split(' ', 2)
+
+              case code.to_i
+              when 510
+                # This error is non-fatal for the call
+                ahn_log.agi.warn "510: Invalid or unknown AGI command"
+              when 511
+                # 511 Command Not Permitted on a dead channel
+                ahn_log.agi.debug "511: Dead channel. Raising Hangup"
+                raise Hangup
+              when 520
+                # This error is non-fatal for the call
+                ahn_log.agi.warn "520: Invalid command syntax"
+              when (500..599)
+                # Assume this error is non-fatal for the call and try to keep running
+                ahn_log.agi.warn "#{code}: Unknown AGI protocol error."
+              end
 
-            # If the message starts with HANGUP it's a silly 1.6 OOB message
-            case message
-            when /^HANGUP/, /^HANGUP\n?$/i, /^HANGUP\s?\d{3}/i
-              ahn_log.agi.debug "AGI HANGUP. Raising hangup"
-              raise Hangup
+              # If the message starts with HANGUP it's a silly 1.6 OOB message
+              case message
+              when /^HANGUP/, /^HANGUP\n?$/i, /^HANGUP\s?\d{3}/i
+                ahn_log.agi.debug "AGI HANGUP. Raising hangup"
+                raise Hangup
+              end
             end
+          rescue Errno::ECONNRESET
+            raise Hangup
           end
         end
 
@@ -408,7 +412,7 @@ module Adhearsion
         #
         def base_record_to_file(*args)
           options = args.last.kind_of?(Hash) ? args.pop : {}
-          filename = args.shift || "/tmp/recording_%d"
+          filename = args.shift || "/tmp/recording_#{new_guid}_%d"
 
           if filename.index("%d")
             if @call.variables.has_key?(:recording_counter)
@@ -872,7 +876,7 @@ module Adhearsion
             def cepstral(call, text, options = {})
               # We need to aggressively escape commas so app_swift does not
               # think they are arguments.
-              text.gsub! /,/, '\\\\\\,'
+              text.gsub! /,/, '\\\\,'
               command = ['Swift', text]
 
               if options[:interrupt_digits]

data/spec/adhearsion/voip/asterisk/commands_spec.rb

@@ -274,6 +274,20 @@ describe 'hangup command' do
   end
 end
 
+describe 'receiving a hangup' do
+  include DialplanCommandTestHelpers
+
+  it "should treat a ECONNRESET as a hangup" do
+    pbx_should_respond_with_success
+    def input.gets()
+      raise Errno::ECONNRESET
+    end
+    the_following_code {
+      mock_call.read()
+    }.should raise_error(Adhearsion::Hangup)   
+  end
+end
+
 describe "writing a command" do
   include DialplanCommandTestHelpers
 
@@ -729,8 +743,10 @@ describe 'the #record method' do
 
   it 'create a default filename if no file is specifed and icrement it on subsequent calls' do
     mock_call.call.variables.delete :recording_counter
-    mock_call.should_receive(:response).once.with('RECORD FILE', '/tmp/recording_0', 'gsm', '26', -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
-    mock_call.should_receive(:response).once.with('RECORD FILE', '/tmp/recording_1', 'gsm', '26', -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
+    mock_call.should_receive(:new_guid).once.and_return('2345')
+    mock_call.should_receive(:new_guid).once.and_return('4322')
+    mock_call.should_receive(:response).once.with('RECORD FILE', '/tmp/recording_2345_0', 'gsm', '26', -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
+    mock_call.should_receive(:response).once.with('RECORD FILE', '/tmp/recording_4322_1', 'gsm', '26', -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
     mock_call.record(:beep => nil, :escapedigits => '26').should == '/tmp/recording_0.gsm'
     mock_call.record(:beep => nil, :escapedigits => '26').should == '/tmp/recording_1.gsm'
   end  
@@ -826,8 +842,10 @@ describe 'the #record_to_file method' do
   end  
 
   it 'create a default filename if no file is specifed and icrement it on subsequent calls' do
-    mock_call.should_receive(:response).once.with("RECORD FILE", "/tmp/recording_0", "gsm", "26", -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
-    mock_call.should_receive(:response).once.with("RECORD FILE", "/tmp/recording_1", "gsm", "26", -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
+    mock_call.should_receive(:new_guid).once.and_return('2345')
+    mock_call.should_receive(:new_guid).once.and_return('4322')
+    mock_call.should_receive(:response).once.with("RECORD FILE", "/tmp/recording_2345_0", "gsm", "26", -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
+    mock_call.should_receive(:response).once.with("RECORD FILE", "/tmp/recording_4322_1", "gsm", "26", -1, 0).and_return("200 result=0 (timeout) endpos=21600\n")
     mock_call.record_to_file(:beep => nil, :escapedigits => '26').should == :success_timeout
     mock_call.record_to_file(:beep => nil, :escapedigits => '26').should == :success_timeout
   end  
@@ -2723,7 +2741,7 @@ describe "speak command" do
 
     it "should properly escape commas in the TTS string" do
       pbx_should_respond_with_value 0
-      mock_call.should_receive(:execute).with('Swift', 'Once\\\\, a long\\\\, long time ago\\\\, ...')
+      mock_call.should_receive(:execute).with('Swift', 'Once\, a long\, long time ago\, ...')
       @speech_engines.cepstral(mock_call, 'Once, a long, long time ago, ...')
       @output.read.should == "GET VARIABLE \"SWIFT_DTMF\"\n"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-14 00:00:00.000000000Z
+date: 2011-09-22 00:00:00.000000000 +01:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156063620 !ruby/object:Gem::Requirement
+  requirement: &2153625640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +25,10 @@ dependencies:
         version: 1.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *2156063620
+  version_requirements: *2153625640
 - !ruby/object:Gem::Dependency
   name: log4r
-  requirement: &2156061900 !ruby/object:Gem::Requirement
+  requirement: &2153625040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +36,10 @@ dependencies:
         version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2156061900
+  version_requirements: *2153625040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156060060 !ruby/object:Gem::Requirement
+  requirement: &2153624560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +47,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156060060
+  version_requirements: *2153624560
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2156059440 !ruby/object:Gem::Requirement
+  requirement: &2153624180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +58,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156059440
+  version_requirements: *2153624180
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156058260 !ruby/object:Gem::Requirement
+  requirement: &2153623720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +69,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156058260
+  version_requirements: *2153623720
 - !ruby/object:Gem::Dependency
   name: rubigen
-  requirement: &2156057120 !ruby/object:Gem::Requirement
+  requirement: &2153621640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +80,10 @@ dependencies:
         version: 1.5.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156057120
+  version_requirements: *2153621640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156056020 !ruby/object:Gem::Requirement
+  requirement: &2153621020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +91,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156056020
+  version_requirements: *2153621020
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2156054660 !ruby/object:Gem::Requirement
+  requirement: &2153620340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +102,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156054660
+  version_requirements: *2153620340
 - !ruby/object:Gem::Dependency
   name: rubigen
-  requirement: &2156053720 !ruby/object:Gem::Requirement
+  requirement: &2153619580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +113,10 @@ dependencies:
         version: 1.5.6
   type: :development
   prerelease: false
-  version_requirements: *2156053720
+  version_requirements: *2153619580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156052900 !ruby/object:Gem::Requirement
+  requirement: &2153618960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,10 +124,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2156052900
+  version_requirements: *2153618960
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &2156052360 !ruby/object:Gem::Requirement
+  requirement: &2153618560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,10 +135,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156052360
+  version_requirements: *2153618560
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2156051460 !ruby/object:Gem::Requirement
+  requirement: &2153617980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -145,10 +146,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *2156051460
+  version_requirements: *2153617980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156050780 !ruby/object:Gem::Requirement
+  requirement: &2153617540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -156,10 +157,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156050780
+  version_requirements: *2153617540
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2156050020 !ruby/object:Gem::Requirement
+  requirement: &2153617080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -167,10 +168,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156050020
+  version_requirements: *2153617080
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
-  requirement: &2156049100 !ruby/object:Gem::Requirement
+  requirement: &2153616640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -178,10 +179,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156049100
+  version_requirements: *2153616640
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2156048440 !ruby/object:Gem::Requirement
+  requirement: &2153616220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -189,7 +190,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156048440
+  version_requirements: *2153616220
 description: Adhearsion is an open-source telephony development framework
 email: dev&Adhearsion.com
 executables:
@@ -216,11 +217,6 @@ files:
 - app_generators/ahn/templates/Rakefile
 - app_generators/ahn/templates/components/ami_remote/ami_remote.rb
 - app_generators/ahn/templates/components/disabled/HOW_TO_ENABLE
-- app_generators/ahn/templates/components/disabled/restful_rpc/README.markdown
-- app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb
-- app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.rb
-- app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.yml
-- app_generators/ahn/templates/components/disabled/restful_rpc/spec/restful_rpc_spec.rb
 - app_generators/ahn/templates/components/disabled/stomp_gateway/README.markdown
 - app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.rb
 - app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.yml
@@ -368,6 +364,7 @@ files:
 - spec/theatre/namespace_spec.rb
 - spec/theatre/spec_helper_spec.rb
 - spec/theatre/theatre_class_spec.rb
+has_rdoc: true
 homepage: http://adhearsion.com
 licenses: []
 post_install_message: 
@@ -382,7 +379,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4384860604276313482
+      hash: 3254044399957334280
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -391,10 +388,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4384860604276313482
+      hash: 3254044399957334280
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Adhearsion, open-source telephony development framework

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

@@ -1,11 +0,0 @@
-Adhearsion RESTful RPC Component
-================================
-
-This is a component for people want to integrate their telephony systems with non-Ruby systems. When enabled, this component
-will start up a HTTP server within the Adhearsion process and accept POST requests to invoke Ruby methods shared in the
-`methods_for(:rpc)` context.
-
-Protocol Notes
---------------
-
-When POSTing your data to.

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

@@ -1,48 +0,0 @@
-require 'rubygems'
-require 'rest_client'
-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"
-
-# ### Sample component code. Try doing "ahn create component testing123" and pasting this code in.
-#
-# methods_for :rpc do
-#   def i_like_hashes(options={})
-#     options.has_key?(:foo)
-#   end
-#   def i_like_arrays(*args)
-#     args.reverse
-#   end
-# end
-
-# Note: everything returned will be wrapped in an Array
-
-p Adhearsion.i_like_hashes(:foo => "bar")
-p Adhearsion.i_like_arrays(1,2,3,4,5)

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

@@ -1,91 +0,0 @@
-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]?|\*)$/
-
-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
-    when "whitelist"
-      whitelist = COMPONENTS.restful_rpc["whitelist"]
-      !! whitelist.find do |pattern|
-        pattern_octets = pattern.split "."
-        # Traverse both arrays in parallel
-        octets.zip(pattern_octets).map do |octet, octet_pattern|
-          octet_pattern == "*" ? true : (octet == octet_pattern)
-        end == [true, true, true, true]
-      end
-    when "blacklist"
-      blacklist = COMPONENTS.restful_rpc["blacklist"]
-      ! blacklist.find do |pattern|
-        pattern_octets = pattern.split "."
-        # Traverse both arrays in parallel
-        octets.zip(pattern_octets).map do |octet, octet_pattern|
-          octet_pattern == "*" ? true : (octet == octet_pattern)
-        end == [true, true, true, true]
-      end
-    else
-      raise Adhearsion::Components::ConfigurationError, 'Unrecognized "access" configuration value!'
-  end
-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 = 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
-  end
-end

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

@@ -1,34 +0,0 @@
-# Use path_nesting to specify an arbitrarily nested. Could be used for additional security or in HTTP reverse proxy server.
-path_nesting: /
-
-port: 5000
-
-# The "handler" option here can be any valid Rack::Handler constant name.
-# Other options: WEBrick, EventedMongrel.
-# If you don't know the differences between these, "Mongrel" is definitely a good choice.
-handler: Mongrel
-
-# In a production system, you should make this "false" since
-show_exceptions: true
-
-# The "authentication" config option can either be "false" or key/value pairs representing allowed usernames and passwords.
-
-#authentication: false
-authentication:
-  jicksta: roflcopterz
-  foo: bar6213671682
-
-access: everyone   # When allowing "everyone" access, no IPs are blocked.
-#access: whitelist # When using a whitelist, the "whitelist" data below will be used.
-#access: blacklist # When using a blacklist, the "blacklist" data below will be used.
-
-# This is a list of IPs which are exclusively allowed to call this web service.
-# Note: whitelists are far more secure than blacklists.
-whitelist:
-  - 127.0.0.1
-  - 192.168.*.*
-
-# This is a list of the IPs which are explicitly NOT allowed to call this web service. This will only be used if "access" is
-# set to "blacklist" above.
-blacklist:
-  - 100.200.100.200

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

@@ -1,251 +0,0 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-Bundler.require
-
-require 'adhearsion/component_manager/spec_framework'
-
-RESTFUL_RPC = ComponentTester.new("restful_rpc", File.dirname(__FILE__) + "/../..")
-
-##### This is here for a reference
-#{"CONTENT_LENGTH"       => "12",
-# "CONTENT_TYPE"         => "application/x-www-form-urlencoded",
-# "GATEWAY_INTERFACE"    => "CGI/1.1",
-# "HTTP_ACCEPT"          => "application/xml",
-# "HTTP_ACCEPT_ENCODING" => "gzip, deflate",
-# "HTTP_AUTHORIZATION"   => "Basic amlja3N0YTpyb2ZsY29wdGVyeg==",
-# "HTTP_HOST"            => "localhost:5000",
-# "HTTP_VERSION"         => "HTTP/1.1",
-# "PATH_INFO"            => "/rofl",
-# "QUERY_STRING"         => "",
-# "rack.errors"          => StringIO.new(""),
-# "rack.input"           => StringIO.new('["o","hai!"]'),
-# "rack.multiprocess"    => false,
-# "rack.multithread"     => true,
-# "rack.run_once"        => false,
-# "rack.url_scheme"      => "http",
-# "rack.version"         => [0, 1],
-# "REMOTE_ADDR"          => "::1",
-# "REMOTE_HOST"          => "localhost",
-# "REMOTE_USER"          => "jicksta",
-# "REQUEST_METHOD"       => "POST"
-# "REQUEST_PATH"         => "/",
-# "REQUEST_URI"          => "http://localhost:5000/rofl",
-# "SCRIPT_NAME"          => "",
-# "SERVER_NAME"          => "localhost",
-# "SERVER_PORT"          => "5000",
-# "SERVER_PROTOCOL"      => "HTTP/1.1",
-# "SERVER_SOFTWARE"      => "WEBrick/1.3.1 (Ruby/1.8.6/2008-03-03)"}
-
-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')
-
-      mock(Adhearsion::Components).component_manager { component_manager }
-      component_manager.load_code <<-RUBY
-        methods_for(:rpc) do
-          def testing_123456(one,two)
-            [two.reverse, one.reverse]
-          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",
-        "GATEWAY_INTERFACE"    => "CGI/1.1",
-        "HTTP_ACCEPT"          => "application/xml",
-        "HTTP_ACCEPT_ENCODING" => "gzip, deflate",
-        "HTTP_AUTHORIZATION"   => "Basic amlja3N0YTpyb2ZsY29wdGVyeg==",
-        "HTTP_HOST"            => "localhost:5000",
-        "HTTP_VERSION"         => "HTTP/1.1",
-        "PATH_INFO"            => "/rofl",
-        "QUERY_STRING"         => "",
-        "rack.errors"          => StringIO.new(""),
-        "rack.input"           => StringIO.new('["o","hai!"]'),
-        "rack.multiprocess"    => false,
-        "rack.multithread"     => true,
-        "rack.run_once"        => false,
-        "rack.url_scheme"      => "http",
-        "rack.version"         => [0, 1],
-        "REMOTE_ADDR"          => "::1",
-        "REMOTE_HOST"          => "localhost",
-        "REMOTE_USER"          => "jicksta",
-        "REQUEST_METHOD"       => "POST",
-        "REQUEST_PATH"         => "/",
-        "REQUEST_URI"          => "http://localhost:5000/rofl",
-        "SCRIPT_NAME"          => "",
-        "SERVER_NAME"          => "localhost",
-        "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.*]
-        ip_addresses.each do |address|
-          RESTFUL_RPC.helper_method(:ip_allowed?).call(address).should equal(true)
-        end
-      end
-    end
-
-  end
-
-end