rene-adhearsion 0.8.6

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

@@ -0,0 +1,104 @@
+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
+
+    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"
+
+        username, password = COMPONENTS.sandbox["username"].to_s, COMPONENTS.sandbox["password"].to_s
+
+        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
+                next
+              end
+              response.chomp!
+              case response
+                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 rescue nil
+                    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

@@ -0,0 +1,47 @@
+What is Stomp?
+==============
+
+Stomp is a very simple message-queue protocol with which two separate systems can communicate. Because the protocol is so simple, there are many Stomp server implementations from which you can choose. Some of these include
+
+ - ActiveMQ (http://activemq.com)
+ - Ruby "stompserver" gem (gem install stompserver)
+ - RabbitMQ (http://rabbitmq.com)
+
+If you wish to get up and running with a development environment, the Ruby stompserver gem is a fantastic starting point. For a critical production system, ActiveMQ should probably be used but it bears the cumbersome paradigm of many "enterprisey" Java applications.
+
+How does it work?
+=================
+
+Stomp is used when certain processes have defined responsibilities. For example, your Adhearsion application's responsibility is to communicate with your Asterisk machine. Other processes (e.g. a Rails web application) will probably need to instruct Adhearsion to do something. Instructions may include
+
+ - Start a new call between two given phone numbers
+ - Have a particular call do something based on a new event
+ - Hangup a call
+
+Below is a diagram which should give you a better idea of how it works.
+
+    Process  Process  Process (e.g. Rails)
+         \      |      /
+          \     |     /
+           Stomp Server       (e.g. ActiveMQ)
+                |
+                |
+             Process          (e.g. Adhearsion)
+
+Note: Adhearsion could also be the sender of messages through the Stomp server which are consumed by a number of handlers.
+
+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 `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
+
+    events.stomp.start_call.each do |event|
+      # The "event" variable holds a Stomp::Message object.
+      name = event.headers
+    end
+
+You a

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

@@ -0,0 +1,34 @@
+require 'stomp'
+
+# TODO: Recover from a disconnect!
+
+initialization do
+  user = COMPONENTS.stomp_gateway[:user] || ""
+  pass = COMPONENTS.stomp_gateway[:pass] || ""
+  host = COMPONENTS.stomp_gateway[:host] || "localhost"
+  port = COMPONENTS.stomp_gateway[:port] || 61613
+
+  ::StompGatewayConnection = Stomp::Client.open(user, pass, host, port)
+
+  subscriptions = COMPONENTS.stomp_gateway["subscriptions"]
+
+  ahn_log.stomp_gateway "Connection established. Subscriptions: #{subscriptions.inspect}"
+
+  Events.register_namespace_name "/stomp"
+
+  subscriptions.each do |subscription|
+    Events.register_namespace_name "/stomp/#{subscription}"
+    ::StompGatewayConnection.subscribe subscription do |event|
+      Adhearsion::Events.trigger ["stomp", subscription], event
+    end
+  end
+
+end
+
+methods_for :global do
+  def send_stomp(destination, message, headers={})
+    ::StompGatewayConnection.send(destination, message, headers)
+  end
+end
+
+# In the future, I may add a methods_for(:events) method which allows synchronous messaging.

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

@@ -0,0 +1,12 @@
+# Comment out any of these properties to use a default.
+
+user: stomp_user
+pass: secret_password
+host: localhost
+port: 61613
+
+### Add your list of subscriptions below that this gateway should proxy to events.rb
+
+# subscriptions:
+#   - start_call
+#   - hungup_call

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

@@ -0,0 +1,3 @@
+In order to use this component, you must have an XMPP connection enabled in config/startup.rb. It is recommended this be done as an XMPP component rather than a standard client.
+
+You can use all elements of the Blather DSL scoped to XMPP::Connection

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

@@ -0,0 +1,11 @@
+initialization do
+  
+  XMPP::Connection.message :body do |m|
+    XMPP::Connection.say m.from, "You said: #{m.body}"
+  end
+  
+  XMPP::Connection.subscription :request? do |s|
+    XMPP::Connection.write_to_stream s.approve!
+  end
+
+end

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

@@ -0,0 +1,56 @@
+methods_for :dialplan do
+  def simon_game
+    SimonGame.new(self).start
+  end
+end
+
+class SimonGame
+
+  def initialize(call)
+    @call = call
+    reset
+  end
+
+  def start
+    loop do
+      say_number
+      collect_attempt
+      verify_attempt
+    end
+  end
+
+  def random_number
+    rand(10).to_s
+  end
+
+  def update_number
+    @number << random_number
+  end
+
+  def say_number
+    update_number
+    @call.say_digits @number
+  end
+
+  def collect_attempt
+    @attempt = @call.input @number.length
+  end
+
+  def verify_attempt
+    if attempt_correct?
+      @call.play 'good'
+    else
+      @call.play %W[#{@number.length-1} times wrong-try-again-smarty]
+      reset
+    end
+  end
+
+  def attempt_correct?
+    @attempt == @number
+  end
+
+  def reset
+    @attempt, @number = '', ''
+  end
+
+end

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

@@ -0,0 +1,83 @@
+unless defined? Adhearsion
+  if File.exists? File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
+    # For development purposes try to load a local copy of Adhearsion here.
+    # This will not work if started using "ahn" or "jahn".  You must execute
+    # config/startup.rb directly and have a local checkout of Adhearsion in your
+    # application directory.
+    require File.dirname(__FILE__) + "/../adhearsion/lib/adhearsion.rb"
+  else
+    require 'rubygems'
+    gem 'adhearsion', '>= 0.8.2'
+    require 'adhearsion'
+  end
+end
+
+Adhearsion::Configuration.configure do |config|
+
+  # Components to load from the system.
+  # All components that are activated in components/ will be automatically
+  # loaded and made available.
+  # This configuration option allows you to load components provided by gems.
+  # List the gem names here:
+  # config.add_component "ahn_test_component"
+
+  # Supported levels (in increasing severity) -- :debug < :info < :warn < :error < :fatal
+  config.logging :level => :info
+
+  # Whether incoming calls be automatically answered. Defaults to true.
+  # config.automatically_answer_incoming_calls = false
+
+  # Whether the other end hanging up should end the call immediately. Defaults to true.
+  # config.end_call_on_hangup = false
+
+  # Whether to end the call immediately if an unrescued exception is caught. Defaults to true.
+  # config.end_call_on_error = false
+
+  # NOTE: Pay special attention to the argument_delimiter field below:
+  # For Asterisk <= 1.4, use "|" (default)
+  # 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.
+  config.enable_asterisk :argument_delimiter => '|'
+  # config.asterisk.enable_ami :host => "127.0.0.1", :username => "admin", :password => "password", :events => true
+
+  # config.enable_drb
+
+  # Streamlined Rails integration! The first argument should be a relative or absolute path to
+  # the Rails app folder with which you're integrating. The second argument must be one of the
+  # the following: :development, :production, or :test.
+
+  # config.enable_rails :path => 'gui', :env => :development
+
+  # Note: You CANNOT do enable_rails and enable_database at the same time. When you enable Rails,
+  # it will automatically connect to same database Rails does and load the Rails app's models.
+
+  # Configure a database to use ActiveRecord-backed models. See ActiveRecord::Base.establish_connection
+  # for the appropriate settings here.
+  # You can also override the default log destination by supplying an alternate
+  # logging object with :logger.  The default is ahn_log.db.
+  # config.enable_database :adapter  => 'mysql',
+  #                        :username => 'joe',
+  #                        :password => 'secret',
+  #                        :host     => 'db.example.org'
+
+  # Configure an LDAP connection using ActiveLdap.  See ActiveLdap::Base.establish_connect
+  # for the appropriate settings here.
+  # config.enable_ldap :host => 'ldap.dataspill.org',
+  #                    :port => 389,
+  #                    :base => 'dc=dataspill,dc=org',
+  #                    :logger => ahn_log.ldap,
+  #                    :bind_dn => "uid=drewry,ou=People,dc=dataspill,dc=org",
+  #                    :password => 'password12345',
+  #                    :allow_anonymous => false,
+  #                    :try_sasl => false
+  
+  # Configure XMPP call controller
+  # config.enable_xmpp :jid => 'active-calls.xmpp.example.com',
+  #                    :password => 'passwd',
+  #                    :server => 'xmpp.example.com',
+  #                    :port => 5347
+
+end
+
+Adhearsion::Initializer.start_from_init_file(__FILE__, File.dirname(__FILE__) + "/..")

data/app_generators/ahn/templates/dialplan.rb

@@ -0,0 +1,3 @@
+adhearsion {
+  simon_game
+}

data/app_generators/ahn/templates/events.rb

@@ -0,0 +1,32 @@
+##
+# In this file you can define callbacks for different aspects of the framework. Below is an example:
+##
+#
+# events.asterisk.before_call.each do |call|
+#   # This simply logs the extension for all calls going through this Adhearsion app.
+#   extension = call.variables[:extension]
+#   ahn_log "Got a new call with extension #{extension}"
+# end
+#
+##
+# Asterisk Manager Interface example:
+#
+# events.asterisk.manager_interface.each do |event|
+#   ahn_log.events event.inspect
+# end
+#
+# This assumes you gave :events => true to the config.asterisk.enable_ami method in config/startup.rb
+#
+##
+# Here is a list of the events included by default:
+#
+# - events.asterisk.manager_interface
+# - events.after_initialized
+# - events.shutdown
+# - events.asterisk.before_call
+# - events.asterisk.failed_call
+# - events.asterisk.hungup_call
+#
+#
+# Note: events are mostly for components to register and expose to you.
+##

data/bin/ahn

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# This is the main executable file.
+
+# Adhearsion, open source collaboration framework
+# Copyright (C) 2006,2007,2008 Jay Phillips
+#
+# This library is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
+# any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this library; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'adhearsion'
+require 'adhearsion/cli'
+
+Adhearsion::CLI::AhnCommand.execute!

data/bin/ahnctl

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+#
+#  ahnctl - Adhearsion daemon controller
+#
+# Adhearsion, open source collaboration framework
+# Copyright (C) 2006,2007,2008 Jay Phillips
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+USAGE = "Usage: ahnctl start|stop|restart /path/to/adhearsion/app [--pid-file=/path/to/pid_file.pid]"
+
+# Blow up if the CLI arguments are invalid
+abort USAGE unless (2..3).include?(ARGV.size) && %w[start stop restart].include?(ARGV.first)
+
+# By default, ahnctl will use the version of Adhearsion it was installed with.
+
+pid_file    = ARGV.pop if ARGV.size == 3
+ahn_command = File.expand_path File.dirname(__FILE__) + "/ahn"
+app_dir     = File.expand_path ARGV.last
+
+pid_file_path_regexp = /^--pid-file=(.+)$/
+abort USAGE if pid_file && pid_file !~ pid_file_path_regexp
+
+# If pid_file is not nil, let's extract the path specified.
+pid_file &&= File.expand_path pid_file[pid_file_path_regexp,1]
+
+# If there was no third argument and pid_file is still nil, let's use the default.
+pid_file ||= app_dir + '/adhearsion.pid'
+
+abort "Directory is not an Adhearsion application!" unless File.exists?(app_dir + "/.ahnrc")
+
+def terminate(pid) `kill -s TERM #{pid} 2> /dev/null` end
+def      kill(pid) `kill -s KILL #{pid} 2> /dev/null` end
+
+# Even if we're starting Adhearsion, we need to make sure to clean up after any stale
+# pid files. In effect, start is the same as restart.
+puts "Stopping Adhearsion app at #{app_dir}" if %w[stop restart].include? ARGV.first
+
+if File.exists?(pid_file)
+  # An Adhearsion process may still be running. Let's kill the other one as cleanly as possible
+  pid = File.read(pid_file).to_i
+
+  # Time to spend waiting for Adhearsion to exit
+  waiting_timeout = Time.now + 15
+
+  terminate pid
+  sleep 0.25 until `ps -p #{pid} | sed -e '1d'`.strip.empty? || Time.now > waiting_timeout
+  kill pid
+
+  `rm -f #{pid_file}`
+end
+
+if ['start', 'restart'].include? ARGV.first
+  puts "Starting Adhearsion app at #{app_dir}"
+  `#{ahn_command} start daemon #{app_dir} --pid-file=#{pid_file}`
+end