adhearsion 0.7.5 → 0.7.6

data/Rakefile

@@ -4,8 +4,7 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
 ADHEARSION_VERSION = File.read('.version').strip
-Summary = %{Adhearsion is a professional integration system for
-integrating anything and everything.}
+Summary = %{Adhearsion is metaprogramming framework for developing collaboration software.}
 
 #task :default => [:test]
 
@@ -27,14 +26,15 @@ GEM_SPEC = Gem::Specification.new do |s|
   s.name     = 'adhearsion'
   s.rubyforge_project = 'adhearsion'
   s.author   = 'Jay Phillips'
-  s.email    = 'admin -at- jicksta dot com'
+  s.email    = 'jay -at- codemecca dot com'
   s.version  = ADHEARSION_VERSION
   s.summary  = Summary
   s.homepage = 'http://adhearsion.com'
 
   s.add_dependency 'activerecord', '>= 1.14.4'
   s.add_dependency 'rake', '>= 0.7.1'
-
+  s.add_dependency 'daemons', '>= 1.0.5'
+  
   s.platform = Gem::Platform::RUBY
   s.require_path = 'lib'
   s.executables = 'ahn'

data/TODO

@@ -0,0 +1,22 @@
+Port Jason's T2S work into trunk when stable. Jason?
+
+Port in new Micromenus browser GUI
+
+Support ITAD routing using ENUM lookups.
+Major file structure refactoring!
+
+Port in RAI's AMI work.
+
+Port in RAI's Rails app initialization and routing integration.
+
+Develop a reasonable RSpec testing framework for Adhearsion.
+
+Have AGI server optionally powered by mongrel
+
+Port Micromenus server over to Camping
+
+Adhearsion CLI. Should use the 'breakpoint' library's DRb extension to run an irb session in an external Ruby interpreter (Adhearsion's)
+
+Let record() take a block of functionality to record. This feature will probably only be available when an AMI connection is present.
+
+Build in hunt-group support into dial()

data/ahn

@@ -1,25 +1,24 @@
 #!/usr/bin/env ruby
 
-# This is the main executable file of Adhearsion.
-
-# Copyright (c) 2006 Jay Phillips
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy of
-# this software and associated documentation files (the "Software"), to deal in
-# the Software without restriction, including without limitation the rights to
-# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-# of the Software, and to permit persons to whom the Software is furnished to do
-# so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# This is the main executable file.
+
+# Adhearsion, open source technology integrator
+# Copyright (C) 2006,2007 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
+require 'rubygems'
 
 usage = "Usage:
    ahn create /path/to/directory
@@ -33,9 +32,9 @@ Under development:
     ahn search keyword
     ahn uninstall/remove helpername"
 
-$: << File.join(File.dirname(__FILE__), 'lib')
+$: << File.join(File.expand_path(File.dirname(__FILE__)), 'lib')
 ADHEARSION_VERSION = File.read(File.join(File.dirname(__FILE__), '.version')).strip
-ARGV.unshift 'start'  if ARGV.empty? # Set the default operation
+ARGV.unshift 'start' if ARGV.empty? # Set the default operation
 
 require 'yaml'
 
@@ -103,15 +102,17 @@ Adhearsion project generated!
 
 Start your new app with "ahn start #{dest_dir_relative}"
 
-For dial plan management, change the appropriate contexts
-in your /etc/asterisk/extensions.conf file to the following:
+If you wish to use Adhearsion to control Asterisk's dialplan,
+change the contexts you wish to be affected in your
+/etc/asterisk/extensions.conf file to the following:
 
 [your_context_name]
 exten => _X.,1,AGI(agi://1.2.3.4) ; This IP here
 
-To use databases edit config/database.yml for the
+To use databases, edit config/database.yml for the
 connection information and, optionally, config/database.rb
-to change the default database object models.
+to change the default database object models. To create your
+tables, you may wish to use config/migration.rb.
 
 Asterisk Manager interface integration is highly recommended.
 Edit your /etc/asterisk/manager.conf file and enable the
@@ -131,12 +132,23 @@ when 'start'
   target = Dir.pwd
   
   arg = ARGV.shift
-  if arg =~ /daemon(ize)?/
+  if arg =~ /daemon(ized)?/
     $DAEMON = true
     arg = ARGV.shift
   end
   target = File.expand_path(arg || target)
   
+  puts %{\nStarting Adhearsion v#{ADHEARSION_VERSION}
+  Written by Jay Phillips of Codemecca LLC, et al.
+  http://adhearsion.com\n\n}
+  
+  if $DAEMON
+    require 'rubygems'
+    require 'daemons'
+    puts "Daemonizing now!"
+    Daemons.daemonize
+  end
+  
   Dir.chdir target
   
   adhearsion_config = File.join('config', 'adhearsion.yml')
@@ -146,10 +158,7 @@ when 'start'
   register_logger StandardLogger.new(STDOUT)
   
   register_logger StandardLogger.new('logs/adhearsion.log')
-  
-  puts %{\nStarting Adhearsion v#{ADHEARSION_VERSION}
-  Written by Jay Phillips of Codemecca LLC, et al.
-  http://adhearsion.com\n\n}
+
   
   %w(rubygems uri open-uri abbrev thread).each { |lib| require lib }
  
@@ -158,45 +167,52 @@ when 'start'
   require 'adhearsion'
   require 'database' if CONFIG['enable_database']
   require 'servlet_container'
-  require "constants"
+  require 'constants'
+  
+  if CONFIG['drb'] && CONFIG['drb']['enabled']
+    require 'drb_server'
+    DRbServerManager.start
+  end
   
   # Load appropriate helpers
   $HELPERS = {}
   Contexts::Container.new.run_inside do
     # Start with compiled helpers
-    class << Object
-      aliens = Dir[File.join('helpers', '*.alien.*')]
-      aliens.each do |f|
-        f = File.basename f
-        config_file = File.join %W(config helpers #{f}.yml)
-        config = File.readable?(config_file) ? YAML.load_file(config_file) : {}
-        if config.delete('enabled') != false
-          require 'inline'
-          lang = f[f.rindex('.')+1..-1]
-    	    log "Loading helper #{f} as #{lang.upcase}" 
+    class Object
+      class << self
+        aliens = Dir[File.join('helpers', '*.alien.*')]
+        aliens.each do |f|
+          f = File.basename f
+          config_file = File.join %W(config helpers #{f}.yml)
+          config = File.readable?(config_file) ? YAML.load_file(config_file) : {}
+          if config.delete('enabled') != false
+            require 'inline'
+            lang = f[f.rindex('.') + 1..-1]
+      	    log "Loading helper #{f} as #{lang.upcase}" 
         
-          $HELPERS[f] = config
-          inline do |builder|
-            builder.send lang, File.read(File.join('helpers', f))
+            $HELPERS[f] = config
+            inline do |builder|
+              builder.send lang, File.read(File.join('helpers', f))
+            end
           end
         end
       end
-    end
   
-    # Load Ruby helpers
-    Dir[File.join('helpers', '*.rb')].each do |f|
-      name = File.basename(f)[/^[^.]+/]
-      config_file = File.join %W(config helpers #{name}.yml)
-      config = File.readable?(config_file) ? YAML.load_file(config_file) : {}
-      if config.delete('enabled') != false
-    	  log "Parsing helper #{name}"  
-        $HELPERS[name] = config
-        eval File.read(f)
+      # Load Ruby helpers
+      Dir[File.join('helpers', '*.rb')].each do |f|
+        name = File.basename(f)[/^[^.]+/]
+        config_file = File.join %W(config helpers #{name}.yml)
+        config = File.readable?(config_file) ? YAML.load_file(config_file) : {}
+        if config.delete('enabled') != false
+      	  log "Parsing helper #{name}"  
+          $HELPERS[name] = config
+          eval File.read(f)
+        end
       end
     end
   end
   
-  sc = ServletContainer.new(CONFIG['port'] || 4573)
+  sc = ServletContainer.new((CONFIG['port'] || 4573), (CONFIG['host'] || '0.0.0.0'))
   $HUTDOWN.hook { sc.shutdown }
   
   log "Dallas, we have liftoff!"

data/apps/default/config/adhearsion.yml

@@ -1,6 +1,7 @@
 answer_before_call: true
 hangup_after_call: true
 enable_database: false
+host: 0.0.0.0
 port: 4573
 
 # This information is completely optional. It may be the
@@ -17,7 +18,57 @@ port: 4573
 #   zip: 77777
 #   country: United States
 
+
+# If you wish to use named conferences in your dial plan,
+# uncomment the lines below. To use, pass the name to 
+# the join() method as a Symbol. e.g. join :management
+# 
 # conferences:
 #   management: 1000
 #   marketing: 1001
-#   development: 1002
+#   development: 1002
+
+drb:
+  enabled: false
+  host: 127.0.0.1
+  port: 9050
+
+  deny: all
+  allow:
+   - 127.0.0.1
+   - 192.168.1.*
+
+  # Set your access control permissions above.
+  # Values for deny and allow can be several
+  # things:
+  #
+  #  * The 'all' keyword can be used to match
+  #    everything.
+  #  * A single IP can be given right after
+  #    the colon.
+  #  * A single IP with wildcards can be given
+  #  * Or, combining all of these, a YAML list
+  #    can be used to specify many policies.
+  #    See the comments below for more examples.
+  #
+  # Also note, the "host" field above may also
+  # affect the ability for DRb clients to connect
+  # to the server. If you wish you receive
+  # connections from the 192.168.1.*, listen on
+  # the IP associated with this machine on that
+  # subnet.
+  #
+  #
+  # USING YAML LISTS
+  #
+  # YAML allows lists of items to be created by
+  # prepending a hyphen to each list element.
+  # These lists can be used to refine your
+  # access control list better. Example:
+  #
+  # deny: all
+  # allow:
+  #   - 192.168.1.123
+  #   - 192.168.1.99
+  #   - 66.199.34.44
+  

data/apps/default/config/helpers/growler.yml

@@ -0,0 +1,21 @@
+enabled: false
+
+# This is how growl identifies this client.
+app_name: Adhearsion
+
+# When dealing with only a single machine, set this
+# to your desktop's IP. If you want multiple servers,
+# you can manually pass the IP address as the second
+# argument to growl() and password as the third.
+
+# Leave ip empty if you intend to specify it manually
+ip: localhost
+password: # Leave as-is if none
+
+# This is a list of the different types of notifications
+# Growl should expect from this client. These can be
+# anything you want. Names are case sensitive. Note: At
+# least one must exist!
+notifications:
+  - Standard Notification
+  - Incoming Call

data/apps/default/config/migration.rb

@@ -5,7 +5,8 @@ require 'active_record'
 
 # A migration script uses a database configuration and creates tables
 # very conveniently in a database-agnostic way. Below, add any customizations
-# to the sample schema or leave it as-is. When done, execute this script.
+# to the sample schema or leave it as-is. When done, type "rake migrate" to
+# have this schema generated.
 
 ActiveRecord::Base.establish_connection YAML.load_file('config/database.yml')
 
@@ -15,15 +16,14 @@ class CreateUsers < ActiveRecord::Migration
   def self.up
     create_table :users do |t|
       t.column :name, :string
-      t.column :callerid_name, :string
-      t.column :callerid_num, :string
       t.column :group_id, :integer # Foreign key
-      t.column :ivr_extension, :string
       t.column :extension, :string
-      t.column :email, :string
-      t.column :im_username, :string
-      t.column :im_provider, :string
       # t.column :billed_time, :integer, :null => false
+      
+      # Feel free to remove or change this to "email". Gmail offers email,
+      # instant messaging, calendars, and so forth -- all of which you
+      # can integrate with using one simple username.
+      t.column :gmail, :string
     end
   end
 
@@ -47,7 +47,3 @@ class CreateGroups < ActiveRecord::Migration
     drop_table :groups
   end
 end
-
-# Run "rake migrate" to run this script properly.
-# CreateUsers.up
-# CreateGroups.up

data/apps/default/helpers/growler.rb

@@ -0,0 +1,53 @@
+=begin Adhearsion metadata
+name: Adhearsion Growler
+  author:
+    name: Phil Kates
+    email: hawk684 -at- gmail.com
+    modified-by: Jay Phillips
+  gems:
+    - ruby-growl
+=end
+
+require 'ruby-growl'
+
+GROWL_SERVER = unless $HELPERS['growler']['ip'] then nil else
+  Growl.new $HELPERS['growler']['ip'] || 'localhost',
+            $HELPERS['growler']['app_name'] || "Adhearsion",
+            $HELPERS['growler']['notifications'],
+            nil, $HELPERS['growler']['password']
+end
+
+# Sends a message to an OSX desktop's Growl notification server. If you
+# intend to only notify a single machine, you can specify the parameters
+# in growler.yml.
+#
+# == Usage:
+#
+# - message: The notification or message you wish to send!
+# - type (optional): The type of notification as specified in the growler.yml
+#   config file. This defaults to the first "notifications" entry. If you want
+#   growl() to automatically set this for you, simply send it nil.
+# - ip (optional): The desktop's IP address you wish to notify. This
+#   by default uses what's in growler.yml or, if unavailable, "localhost".
+# - password (optional): a password if one is needed. Defaults to nothing.
+#
+# == Examples:
+#  - growl "Isn't it about time you debugged me?"
+#  - growl "Call from #{callerid}!", "Incoming Call"
+#  - growl "The caller queue size is #{queue.size}", nil, "192.168.1.133"
+#  - growl "Join conference 1234!", nil, "192.168.50.151", "Secretz!"
+def growl message, type=nil, ip=nil, password=nil
+  type = $HELPERS['growler']['notifications'].first unless type
+  
+  # Create a new Growl client if an IP was specified, otherwise use
+  # our server created when Adhearsion booted.
+  svr = unless ip then GROWL_SERVER else
+    Growl.new ip, $HELPERS['growler']['app_name'] || "Adhearsion",
+              $HELPERS['growler']['notifications'], nil,
+              $HELPERS['growler']['password']
+  end
+  
+  # TODO support priorities and stickies. May need to use hash-key argments?
+  # TODO handle unreachable desktops
+  svr.notify type, type, message
+end

data/apps/default/helpers/lookup.rb

@@ -10,25 +10,34 @@ def lookup number
   hash = {}
   url = "http://www.whitepages.com/9901/search/ReversePhone?phone=#{number}"
   doc = Hpricot open(url)
+
+  # This div contains all the information we need, unless it's an unlisted number
+  if (results = doc.at "#results_single_listing") then
+    # This div's h3 contains the name of the caller
+    hash[:first_name], hash[:last_name] = results.at('h3').inner_html.split(/,\s*/).reverse
+
+    # Now we just need the rest of the information contained in p's.
+    meta = results/'p'
+    meta.pop # Discard the useless p element
+
+    hash[:number] = meta.pop.inner_html
+    city_info = meta.pop.inner_html
+    city_info = city_info.match /(.+), ([A-Za-z]{2}) (\d{5})/
+    hash[:city]  = city_info[1]
+    hash[:state] = city_info[2]
+    hash[:zip]   = city_info[3]
+
+    hash[:address] = meta.map(&:inner_html) * " "
+  elsif (results = doc.at "#results_single_phone_info") then
+    meta = results/'span'
+    hash[:location] = (meta.pop.inner_html.match /Location: (.*)/)[1]
+  end
   
-  # This div contains all the information we need
-  results = doc.at "#results_single_listing"
-  
-  # This div's h3 contains the name of the caller
-  hash[:first_name], hash[:last_name] = results.at('h3').inner_html.split(/,\s*/).reverse
-  
-  # Now we just need the rest of the information contained in p's.
-  meta = results/'p'
-  meta.pop # Discard the useless p element
-  
-  hash[:number] = meta.pop.inner_html
-  city_info = meta.pop.inner_html
-  city_info = city_info.match /(.+), ([A-Za-z]{2}) (\d{5})/
-  hash[:city]  = city_info[1]
-  hash[:state] = city_info[2]
-  hash[:zip]   = city_info[3]
-  
-  hash[:address] = meta.map(&:inner_html) * " "
+  if hash[:first_name] or hash[:last_name] then
+    hash[:composite] = "#{hash[:first_name]} #{hash[:last_name]}"
+  else
+    hash[:composite] = hash[:location]
+  end
   
   hash
 end