jicksta-adhearsion 0.8.0 → 0.8.2

data/EVENTS

@@ -6,6 +6,6 @@
   - manager_interface
   - before_call
   - failed_call
-  - call_hangup
+  - hungup_call
 
-# Note: This file is valid YAML for programatic parsing.
+# Note: This file is valid YAML for programatic parsing.

data/adhearsion.gemspec

@@ -4,14 +4,16 @@ ADHEARSION_FILES = %w{
   app_generators/ahn/templates/.ahnrc
   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/stomp_gateway/config.yml
+  app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.yml
   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/restful_rpc/config.yml
-  app_generators/ahn/templates/components/restful_rpc/example-client.rb
-  app_generators/ahn/templates/components/restful_rpc/README.markdown
-  app_generators/ahn/templates/components/restful_rpc/restful_rpc.rb
-  app_generators/ahn/templates/components/restful_rpc/spec/restful_rpc_spec.rb
+  app_generators/ahn/templates/components/disabled/sandbox/sandbox.rb
+  app_generators/ahn/templates/components/disabled/sandbox/sandbox.yml
+  app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.yml
+  app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb
+  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/simon_game/simon_game.rb
   app_generators/ahn/templates/config/startup.rb
   app_generators/ahn/templates/dialplan.rb
@@ -106,12 +108,11 @@ ADHEARSION_FILES = %w{
   lib/theatre/version.rb
   LICENSE
   Rakefile
-  README.txt
 }
 
 Gem::Specification.new do |s|
   s.name = "adhearsion"
-  s.version = "0.8.0"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Phillips"]

data/app_generators/ahn/ahn_generator.rb

@@ -28,15 +28,18 @@ class AhnGenerator < RubiGen::Base
       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/config.yml"]*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/config.yml"]*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
@@ -80,6 +83,7 @@ EOS
     BASEDIRS = %w(
       components/simon_game
       components/disabled/stomp_gateway
+      components/disabled/sandbox
       components/ami_remote
       components/disabled/restful_rpc/spec
       config

data/app_generators/ahn/templates/Rakefile

@@ -1,3 +1,5 @@
+# This file is for the "rake" tool which automates project-related tasks. If you need to automate things, you can create
+# a new Rake task here. See http://rake.rubyforge.org for more info.
 require 'rubygems'
 
 begin

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,48 @@
+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

@@ -0,0 +1,87 @@
+require 'rack'
+require 'json'
+
+# 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 = 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  
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,263 @@
+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.
+    require File.dirname(__FILE__) + "/../../../adhearsion/lib/adhearsion.rb"
+  elsif File.exists? File.dirname(__FILE__) + "/../../../../../../lib/adhearsion.rb"
+    # This file may be ran from the within the Adhearsion framework code (before a project has been generated)
+    require File.dirname(__FILE__) + "/../../../../../../lib/adhearsion.rb"
+  else
+    require 'rubygems'
+    gem 'adhearsion', '>= 0.7.999'
+    require 'adhearsion'
+  end
+end
+
+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

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

@@ -0,0 +1,108 @@
+require 'md5'
+require 'open-uri'
+
+SANDBOX_VERSION = 1.0
+
+initialization do
+  # We shouldn't start initializing until after the AGI server has initialized.
+  Events.register_callback(:after_initialized) do
+    ahn_log.sandbox "Fetching sandbox connection information"
+    
+    config = if COMPONENTS.sandbox.has_key? "connect_to"
+      {"connect_to" => COMPONENTS.sandbox["connect_to"]}
+    else
+      begin
+        yaml_data = open("http://sandbox.adhearsion.com/component/#{SANDBOX_VERSION}").read
+        YAML.load yaml_data
+      rescue SocketError
+        ahn_log.sandbox.error "Could not connect to the sandbox server! Skipping sandbox initialization!"
+        next
+      rescue => e
+        ahn_log.sandbox.error "COULD NOT RETRIEVE SANDBOX CONNECTION INFORMATION! Not initializing sandbox component!"
+        next
+      end
+    end
+    
+    begin
+      # The "connect_to" key is what this version supports
+      if config.kind_of?(Hash) && config.has_key?("connect_to")
+        config = config['connect_to']
+      
+        host, port = config.values_at "host", "port"
+      
+        ahn_log.sandbox "Connecting to #{host}:#{port}"
+        
+        username, password = COMPONENTS.sandbox["username"], COMPONENTS.sandbox["password"]
+        
+        if username.blank? || password.blank? || username == "user123"
+          ahn_log.sandbox.error "You must specify your username and password in this component's config file!"
+          next
+        end
+        
+        # Part of the AGI-superset protocol we use to log in.
+        identifying_hash = MD5.md5(username + ":" + password).to_s
+        
+        if host.nil? || port.nil?
+          ahn_log.sandbox.error "Invalid YAML returned from server! Skipping sandbox initialization!"
+          next
+        end
+
+        Thread.new do
+          loop do
+            begin
+              ahn_log.sandbox.debug "Establishing outbound AGI socket"
+              socket = TCPSocket.new(host, port)
+              socket.puts identifying_hash
+              response = socket.gets
+              unless response
+                ahn_log.sandbox "Communication with the sandbox ended before receiving any response. Reconnecting."
+                next
+              end
+              response.chomp!
+              case 
+                when "authentication accepted" 
+                  ahn_log.sandbox "Authentication accepted"
+                  
+                  start_signal = socket.gets
+                  next unless start_signal
+                  start_signal.chomp!
+                  
+                  if start_signal
+                    ahn_log.sandbox "Incoming call from remote sandbox server!"
+                    begin
+                      Adhearsion::Initializer::AsteriskInitializer.agi_server.server.serve(socket)
+                    rescue => e
+                      ahn_log.error "Non-fatal exception in the AGI server: #{e.inspect} \n" + e.backtrace.join("\n")
+                    ensure
+                      socket.close
+                    end
+                    ahn_log.sandbox "AGI server finished serving call. Reconnecting to sandbox."
+                  else
+                    ahn_log.sandbox "Remote Asterisk server received no call. Reconnecting..."
+                  end
+                when "authentication failed"
+                  ahn_log.sandbox.error "Your username or password is invalid! Skipping sandbox initialization..."
+                  break
+                when /^wait (\d+)$/
+                  sleep response[/^wait (\d+)$/,1].to_i
+                else
+                  ahn_log.sandbox.error "Invalid login acknowledgement! Skipping sandbox initialization!"
+                  break
+              end
+            rescue Errno::ECONNREFUSED
+              ahn_log.sandbox.error "Could not connect to the sandbox server! Sandbox component stopping..."
+              break
+            rescue => e
+              ahn_log.error "Unrecognized error: #{e.inspect} \n" + e.backtrace.join("\n")
+            end
+          end
+        end
+
+      else
+        ahn_log.sandbox.error "COULD NOT RETRIEVE SANDBOX CONNECTION INFORMATION! Not initializing sandbox component!"
+      end
+    rescue => e
+      ahn_log.sandbox.error "Encountered an error when connecting to the sandbox! #{e.message}\n" + e.backtrace.join("\n")
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+username: user123
+password: pass123

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

@@ -35,7 +35,7 @@ Setting up a Ruby Stomp server
 
 Install the pure-Ruby Stomp server by doing "gem install stompserver". This will add the "stompserver" command to your system. When running it without any parameters, it starts without requiring authentication. If you're wanting to get a quick experiment running, I recommend simply doing that.
 
-Open the config.yml file in the stomp_gateway component folder. Comment out the four settings at the top of the file named "user", "pass", "host" and "port" by prepending a "#" to their line. This will cause the component to choose defaults for those properties. The component's defaults will match the expected credentials for the experimental stompserver you're already running on your computer.
+Open the `stomp_gateway.yml` file in the stomp_gateway component folder. Comment out the four settings at the top of the file named "user", "pass", "host" and "port" by prepending a "#" to their line. This will cause the component to choose defaults for those properties. The component's defaults will match the expected credentials for the experimental stompserver you're already running on your computer.
 
 You also need specify a subscription name in 
 

data/app_generators/ahn/templates/components/disabled/stomp_gateway/{config.yml → stomp_gateway.yml}

@@ -9,4 +9,4 @@ port: 61613
 
 # subscriptions:
 #   - start_call
-#   - hangup_call
+#   - hungup_call

data/app_generators/ahn/templates/events.rb

@@ -25,7 +25,7 @@
 # - events.shutdown
 # - events.asterisk.before_call
 # - events.asterisk.failed_call
-# - events.asterisk.call_hangup
+# - events.asterisk.hungup_call
 #
 #
 # Note: events are mostly for components to register and expose to you.

data/lib/adhearsion/cli.rb

@@ -115,7 +115,7 @@ USAGE
 # look at the examples in newly-created projects.
                 RUBY
               end
-              File.open(new_component_dir + "/config.yml","w") do |file|
+              File.open(new_component_dir + "/#{component_name}.yml","w") do |file|
                 file.puts '# You can use this file for component-specific configuration.'
               end
               puts "Created blank component '#{component_name}' at components/#{component_name}"

data/lib/adhearsion/component_manager.rb

@@ -18,7 +18,6 @@ module Adhearsion
       end
       
       SCOPE_NAMES = [:dialplan, :events, :generators, :rpc, :global]
-      DEFAULT_CONFIG_NAME = "config.yml"
       
       attr_reader :scopes, :lazy_config_loader
       def initialize(path_to_container_directory)
@@ -61,7 +60,7 @@ module Adhearsion
       #
       def configuration_for_component_named(component_name)
         component_dir = File.join(@path_to_container_directory, component_name)
-        config_file = File.join component_dir, DEFAULT_CONFIG_NAME
+        config_file = File.join component_dir, "#{component_name}.yml"
         if File.exists?(config_file)
           YAML.load_file config_file
         else

data/lib/adhearsion/initializer/database.rb

@@ -11,7 +11,8 @@ module Adhearsion
           require_dependencies
           require_models
           @@config = Adhearsion::AHN_CONFIG.database
-          ActiveRecord::Base.allow_concurrency = true
+          # You may need to uncomment the following line for older versions of ActiveRecord
+          # ActiveRecord::Base.allow_concurrency = true
           establish_connection
           create_call_hook_for_connection_cleanup
         end

data/lib/adhearsion/initializer/rails.rb

@@ -17,7 +17,8 @@ module Adhearsion
                 "It's not a directory!" unless File.directory?(rails_root)
           load_rails
           if defined? ActiveRecord
-            ActiveRecord::Base.allow_concurrency = true
+            # You may need to uncomment the following line for older versions of ActiveRecord
+            # ActiveRecord::Base.allow_concurrency = true
             Events.register_callback([:asterisk, :before_call]) do
               ActiveRecord::Base.verify_active_connections!
             end

data/lib/adhearsion/version.rb

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

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

@@ -34,8 +34,8 @@ module Adhearsion
               end
             rescue HungupExtensionCallException => hungup_call
               begin
-                ahn_log.agi "Received \"h\" meta-call. Executing /asterisk/call_hangup event callbacks."
-                Events.trigger [:asterisk, :call_hangup], hungup_call.call
+                ahn_log.agi "Received \"h\" meta-call. Executing /asterisk/hungup_call event callbacks."
+                Events.trigger [:asterisk, :hungup_call], hungup_call.call
                 call.hangup!
               rescue => e
                 ahn_log.agi.error e
@@ -78,4 +78,4 @@ module Adhearsion
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jicksta-adhearsion
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors: 
 - Jay Phillips
@@ -46,14 +46,16 @@ files:
 - app_generators/ahn/templates/.ahnrc
 - 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/stomp_gateway/config.yml
+- app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.yml
 - 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/restful_rpc/config.yml
-- app_generators/ahn/templates/components/restful_rpc/example-client.rb
-- app_generators/ahn/templates/components/restful_rpc/README.markdown
-- app_generators/ahn/templates/components/restful_rpc/restful_rpc.rb
-- app_generators/ahn/templates/components/restful_rpc/spec/restful_rpc_spec.rb
+- app_generators/ahn/templates/components/disabled/sandbox/sandbox.rb
+- app_generators/ahn/templates/components/disabled/sandbox/sandbox.yml
+- app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.yml
+- app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb
+- 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/simon_game/simon_game.rb
 - app_generators/ahn/templates/config/startup.rb
 - app_generators/ahn/templates/dialplan.rb
@@ -148,7 +150,6 @@ files:
 - lib/theatre/version.rb
 - LICENSE
 - Rakefile
-- README.txt
 has_rdoc: false
 homepage: http://adhearsion.com
 post_install_message: 

data/README.txt

@@ -1,5 +0,0 @@
-Adhearsion
-    by Jay Phillips, et. al
-    http://adhearsion.com
-
-Adhearsion is an open-source framework written in Ruby designed to vastly improve Voice over IP development. It rests atop established telephony platforms (such as Asterisk and Freeswitch) and abstracts their complexity with the beauty of a well-designed, high-level suite of solutions.