adhearsion 0.8.0 → 0.8.1

data/CHANGELOG

@@ -1,6 +1,5 @@
-0.8.1
-
-
+0.8.0 rev 2
+ - Added a few non-critical files to the .gemspec. They were ignored
 
 Notes from before 0.8.0:
  - (NOTE: This is obviously not a comprehensive list of pre-0.8.0 work. 0.8.0 was a complete rewrite of the previous version)

data/README.markdown

@@ -0,0 +1,31 @@
+Adhearsion
+==========
+
+Adhearsion is an open-source voice application development framework. Adhearsion users write applications atop the framework with Ruby and **call into their code**.
+
+Adhearsion rests above a lower-level telephony platform, namely [Asterisk](http://asterisk.org), though there are experimental bindings for both [FreeSWITCH](http://freeswitch.org) and [Yate](http://yate.null.ro/pmwiki).
+
+Adhearsion has...
+
+* An elegant dialplan system for writing the code which controls a live phone call
+* A sophisticated Asterisk Manager Interface library with a lexer written in [Ragel](http://www.complang.org/ragel).
+* An events subsystem which maintains a Thread-pool for executing your namespaced callbacks. (supports AMI events too!)
+* A very useful component architecture with which you may write Adhearsion plugins and share them with the world.
+* JRuby compatibility for running atop the Java Virtual Machine and using virtually any Java library.
+* Good regression test coverage
+
+Use the public Adhearsion sandbox!
+==================================
+
+Don't want to screw with setting up a telephony system? You can test your Adhearsion applications using our public sandbox!
+
+Visit [http://adhearsion.com/getting_started](http://adhearsion.com/getting_started) for more information!
+
+Yes, in minutes you can be controlling your cell phone for free!  :)
+
+Documentation
+=============
+
+Visit [Adhearsion's website](http://adhearsion.com) for more information about the framework or visit the [wiki](http://docs.adhearsion.com) for documentation on how to use it.
+
+If you're having trouble, you may want to try asking your question on the IRC channel, [mailing list](http://groups.google.com/group/adhearsion) or, if you've found a bug, report it on the [bug tracker](http://adhearsion.lighthouseapp.com/projects/5871-adhearsion/overview).

data/adhearsion.gemspec

@@ -1,17 +1,20 @@
 ADHEARSION_FILES = %w{
+  README.markdown
   adhearsion.gemspec
   app_generators/ahn/ahn_generator.rb
   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 +109,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.1"
 
   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,14 +28,17 @@ 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/restful_rpc/restful_rpc.rb"]*2
-      m.file  *["components/restful_rpc/config.yml"]*2
-      m.file  *["components/restful_rpc/README.markdown"]*2
-      m.file  *["components/restful_rpc/example-client.rb"]*2
-      m.file  *["components/restful_rpc/spec/restful_rpc_spec.rb"]*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
@@ -80,8 +83,9 @@ EOS
     BASEDIRS = %w(
       components/simon_game
       components/disabled/stomp_gateway
+      components/disabled/sandbox
       components/ami_remote
-      components/restful_rpc/spec
+      components/disabled/restful_rpc/spec
       config
     )
 end

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

@@ -0,0 +1,109 @@
+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. Trying again in 10 seconds."
+                sleep 10
+                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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adhearsion
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - Jay Phillips
@@ -43,19 +43,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.markdown
 - adhearsion.gemspec
 - app_generators/ahn/ahn_generator.rb
 - 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
@@ -150,7 +153,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.