adhearsion 0.7.3 → 0.7.4

data/.version

@@ -1 +1 @@
-0.7.3
+0.7.4

data/Rakefile

@@ -14,7 +14,15 @@ integrating anything and everything.}
 #  Dir['test/*.rb'].each do |f| require f end
 #end
 
-gem_spec = Gem::Specification.new do |s|
+desc "Generate RDoc documentation for Adhearsion"
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "Generated Adhearsion API Documentation"
+  rdoc.rdoc_dir = File.join('docs', 'rdoc')
+  rdoc.main = "lib/adhearsion.rb"
+  rdoc.options << '-N' # For line numbers
+end
+
+GEM_SPEC = Gem::Specification.new do |s|
   
   s.name     = 'adhearsion'
   s.rubyforge_project = 'adhearsion'
@@ -25,14 +33,13 @@ gem_spec = Gem::Specification.new do |s|
   s.homepage = 'http://adhearsion.com'
 
   s.add_dependency 'activerecord', '>= 1.14.4'
-  s.add_dependency 'activesupport', '>= 1.3.1'
   s.add_dependency 'rake', '>= 0.7.1'
 
   s.platform = Gem::Platform::RUBY
   s.require_path = 'lib'
   s.executables = 'ahn'
   s.bindir = '.'
-  #s.extra_rdoc_files = ['LICENSE']
+  s.extra_rdoc_files = ['LICENSE']
 
   inc = Dir['**/*'] << '.version'
   exc = Dir['{log,pkg}/**/*']
@@ -42,16 +49,11 @@ gem_spec = Gem::Specification.new do |s|
   # test_files = Dir['tests/*.rb'] # Will be added when not so buggy
 end
 
-Rake::GemPackageTask.new gem_spec do |pkg|
+Rake::GemPackageTask.new GEM_SPEC do |pkg|
   pkg.need_zip = false
   pkg.need_tar = false
 end
 
-#desc "Generate documentation for Adhearsion"
-#Rake::RDocTask.new do |rdoc|
-#  rdoc.rdoc_dir 'doc'
-#end
-
 desc "Pulls down the entire wiki in HTML format"
 task :wiki => [:rm_wiki] do
   require 'open-uri'
@@ -107,7 +109,7 @@ task :update => [:repackage] do
   puts "Done."
 end
 
-desc 'Create both the gem and the Trixbox RPM. Called "d" for "distribute"'
-task :d => [:repackage] do
+desc 'Creates the Trixbox RPM.'
+task :trixbox => [:repackage] do
   # Coming soon
 end

data/ahn

@@ -21,43 +21,66 @@
 # 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.
 
-usage = %"Usage:
+usage = "Usage:
    ahn create /path/to/directory
    ahn start [daemon] [directory]
    ahn version
    ahn help|-h|--h|--help|-help
-   ahn install helpername
-   ahn system install systemname
-   ahn search keyword
-   ahn uninstall/remove helpername
 
-The helper management system is still under development. Not all of these
-commands will work. It's coming soon, though!  :)"
+Under development:
+    ahn install helpername
+    ahn system install systemname
+    ahn search keyword
+    ahn uninstall/remove helpername"
 
+$: << File.join(File.dirname(__FILE__), 'lib')
 ADHEARSION_VERSION = File.read(File.join(File.dirname(__FILE__), '.version')).strip
-ARGV.unshift 'start' if ARGV.empty?
+ARGV.unshift 'start'  if ARGV.empty? # Set the default operation
+
+require 'yaml'
+adhearsion_config = File.join('config', 'adhearsion.yml')
+CONFIG = File.readable?(adhearsion_config) ? YAML.load_file(adhearsion_config) : {}
+
+$HUTDOWN = []
+class << $HUTDOWN
+  def hook(&block) self << block end
+  def now!
+    log "Shutting down gracefully."
+    $HUTDOWN.each { |hook| hook.call }
+    exit
+  end
+end
+['INT','TERM'].each do |sig|
+  trap sig do $HUTDOWN.now! end
+end
+
+require 'logging'
+register_logger StandardLogger.new(STDOUT)
 
 case ARGV.shift
-when /help|-h|--h|-help|--help/ then puts usage
+when 'help', '-h', '--h', '-help', '--help' then puts usage
 when 'version' then puts "Adhearsion v#{ADHEARSION_VERSION}"
-when 'create'
+when /^create(:[\w_.]+)?$/
   require 'fileutils'
   include FileUtils
   
   dest_dir_relative = ARGV.shift || Dir.pwd
   dest_dir = File.expand_path dest_dir_relative
   base_dir = File.expand_path File.dirname(__FILE__)
+  App = $&.index(':') ? $&.split(':')[1..-1] * ':' : "default"
+  
+  abort %'No app "#{App}" found!' unless File.directory? "#{base_dir}/apps/#{App}"
   
   from, to = [], []
-  (Dir["#{base_dir}/{new_projects,docs}/**/*"] + ["#{base_dir}/LICENSE"]).each do |key|
+  (Dir["{#{base_dir}/apps/#{App},docs}/**/*"] + ["#{base_dir}/LICENSE"]).each do |key|
     value = key[base_dir.length..-1]
-    value.sub! 'new_projects/', '' if value.index 'new_projects/'
+    value.sub! "apps/#{App}/", '' if value.index "apps/#{App}/"
     
     to   << dest_dir + value
     from << key
   end
   
-  #from.each_index { |i| puts "#{from[i]} => #{to[i]}" }
+  #from.each_index { |i| debug "#{from[i]} => #{to[i]}" }
   
   # Check overwriting. Abort, Overwrite, Skip
   
@@ -105,46 +128,31 @@ If you would like a local copy of the Adhearsion wiki, run
 by contributing documentation improvements by visiting the
 online, editable version at http://docs.adhearsion.com!
 MESSAGE
-  
+
 when 'start'
 
   $DAEMON = false
-  app = Dir.pwd
+  target = Dir.pwd
   
   arg = ARGV.shift
   if arg =~ /daemon(ize)?/
     $DAEMON = true
     arg = ARGV.shift
   end
-  app = File.expand_path(arg || app)
+  target = File.expand_path(arg || target)
   
-  Dir.chdir app
+  Dir.chdir target
+  
+  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 yaml uri open-uri abbrev thread).each do |lib| require lib end
+  %w(rubygems uri open-uri abbrev thread).each { |lib| require lib }
  
-  $: << File.join(File.dirname(__FILE__), 'lib')
   $: << 'config'
   
-  adhearsion_config = File.join('config', 'adhearsion.yml')
-  CONFIG = File.readable?(adhearsion_config) ? YAML.load_file(adhearsion_config) : {}
-  
-  $HUTDOWN = []
-  class << $HUTDOWN
-    def hook(&block) self << block end
-    def now!
-      puts "Shutting down gracefully."
-      $HUTDOWN.each { |hook| hook.call }
-      exit
-    end
-  end
-  ['INT','TERM'].each do |sig|
-    trap sig do $HUTDOWN.now! end
-  end
-  
   require 'adhearsion'
   require 'database' if CONFIG['enable_database']
   require 'servlet_container'
@@ -162,7 +170,7 @@ when 'start'
         if config.delete('enabled') != false
           require 'inline'
           lang = f[f.rindex('.')+1..-1]
-    	    puts "Loading helper #{f} as #{lang.upcase}" 
+    	    log "Loading helper #{f} as #{lang.upcase}" 
         
           $HELPERS[f] = config
           inline do |builder|
@@ -178,17 +186,17 @@ when 'start'
       config_file = File.join %W(config helpers #{name}.yml)
       config = File.readable?(config_file) ? YAML.load_file(config_file) : {}
       if config.delete('enabled') != false
-    	  puts "Parsing helper #{name}"  
+    	  log "Parsing helper #{name}"  
         $HELPERS[name] = config
         eval File.read(f)
       end
     end
   end
   
-  sc = ServletContainer.new
+  sc = ServletContainer.new(CONFIG['port'] || 4573)
   $HUTDOWN.hook { sc.shutdown }
   
-  puts "Dallas, we have liftoff!"
+  log "Dallas, we have liftoff!"
   sc.server.join
 
 else puts "Unrecognized command!", usage

data/{new_projects → apps/default}/Rakefile

@@ -5,10 +5,11 @@ require 'rake/rdoctask'
 Summary = 'Adhearsion is a professional integration system for
 integrating anything and everything.'
 
-#desc "Generate documentation for Adhearsion"
-#Rake::RDocTask.new do |rdoc|
-#  rdoc.rdoc_dir 'doc'
-#end
+desc "Generate RDoc documentation for Adhearsion"
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "Generated Adhearsion Application-specific Documentation"
+  rdoc.rdoc_dir = File.join('doc', 'rdoc')
+end
 
 desc "Pulls down the entire wiki in HTML format"
 task :wiki => [:rm_wiki] do

data/{new_projects → apps/default}/config/adhearsion.yml

@@ -1,6 +1,7 @@
 answer_before_call: true
 hangup_after_call: true
 enable_database: false
+port: 4573
 
 # This information is completely optional. It may be the
 # case that a particular helper you're using will need

data/{new_projects → apps/default}/config/helpers/micromenus/collab.rb

@@ -1,7 +1,7 @@
 heading "Adhearsion Micromenus Home"
 
-# A simple example of a helper used in a Micromenu.
-item oscar_wilde_quote + ' - Oscar Wilde'
+# Below is a simple example of a helper used in a Micromenu.
+# item oscar_wilde_quote + ' - Oscar Wilde'
 
 # Use dial plan logic here in the Micromenu!
 call "Check your voicemail!" do
@@ -49,7 +49,12 @@ end
 
 item 'View Users' do
   item 'Select a user to call below.'
-  User.find(:all).each { |user| call user.ivr_extension, user.name }
+  begin
+    User.find(:all).each { |user| call user.extension, user.name }
+  rescue
+    item "Tried to use an ActiveRecord User class, but one didn't exist!"
+    item "Have you configured your database?"
+  end
 end
 
 image 'tux'

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

@@ -0,0 +1,5 @@
+# Feel free to use your Gmail account here! Can also
+# be any Jabber/XMPP account.
+username: test@adhearsion.com
+password: password
+enabled: false

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

@@ -0,0 +1,2 @@
+enabled: false
+ip: 192.168.1.136:80

data/{new_projects → apps/default}/helpers/drb_server.rb

@@ -21,10 +21,10 @@ host = config['host'] || 'localhost'
 port = config['port'] || 9050
 DRb.start_service "druby://#{host}:#{port}", PBX
 
-puts "Started DRb server on #{DRb.uri}."
-puts "DRb Server Access Control List:"
+log "Started DRb server on #{DRb.uri}."
+log "DRb Server Access Control List:"
 0.step permissions.length-1, 2 do |i|
-  puts "   #{permissions[i].upcase} #{permissions[i+1]}"
+  log "   #{permissions[i].upcase} #{permissions[i+1]}"
 end
 
 $HUTDOWN.hook do

data/{new_projects → apps/default}/helpers/micromenus.rb

@@ -307,9 +307,8 @@ class MicromenusServlet < WEBrick::HTTPServlet::AbstractServlet
   }
   
   def do_GET(request, response)
-    puts 'trying do'
     response.status = 200
-    puts "Request from: " + request['User-Agent']
+    log "Request from: " + request['User-Agent']
     
     route = request.path[1..-1].split '/'
     if route.first == 'images'
@@ -344,9 +343,9 @@ class MicromenusServlet < WEBrick::HTTPServlet::AbstractServlet
   end
 end
 
-$MICROMENU_THREAD = Thread.new do
+$MICROMENUS_SERVER = Thread.new do
   micromenu_server = WEBrick::HTTPServer.new :Port => ($HELPERS.micromenus.port || 1337)
-  micromenu_server.logger = Logger.new 'logs/database.log', 10, 1.megabyte
+
   micromenu_server.mount '/', MicromenusServlet
   $HUTDOWN.hook {
     micromenu_server.stop
@@ -354,7 +353,6 @@ $MICROMENU_THREAD = Thread.new do
   micromenu_server.start
 end
 
-
 # This before_call hook is the magic behind the call() method in the micromenus.
 before_call :low do
   # PSEUDOCODE

data/apps/default/helpers/multi_messenger.rb

@@ -0,0 +1,36 @@
+=begin Adhearsion metadata
+
+=end
+
+require 'xmpp4r-simple'
+
+class MultiMessenger
+  
+  Format = /\A[\w\._%-]+@[\w\.-]+\.[a-zA-Z]{2,4}\z/
+  
+  def initialize username, password
+    @username, @password = username, password
+    @connection = Jabber::Simple.new username, password
+  end
+  
+  def connected?() @connection.connected? end
+  def your_username?(un) @username.downcase == un.downcase end
+  def your_service?(s) %w'xmpp jabber gtalk'.include? s.to_s.downcase end
+  def may_be_yours?(sn) true end
+  def im username, message
+    #debug "Connection #{@connection.inspect}, UN: #{username}, MSG: #{message}"
+    @connection.deliver(username, message)
+  end
+  attr_reader :connection
+end
+
+config = $HELPERS['multi_messenger']
+
+username = config['username']||''
+password = config['password']||''
+
+log "MultiMessenger: Connecting to #{username}"
+jabber = MultiMessenger.new username, password
+
+InstantMessenger.use_service jabber
+$HUTDOWN.hook { jabber.connection.disconnect }

data/{new_projects → apps/default}/helpers/weather.rb

@@ -42,9 +42,9 @@ class Weather
   end
   
   def self.weather where
-    puts "Resolving ID"
+    debug "Resolving ID"
     id = where.simplify.is_a?(Fixnum) ? where : get_id(where)
-    puts "Getting Yahoo Data"
+    debug "Getting Yahoo Data"
     url = "http://xml.weather.yahoo.com/forecastrss/#{id}_#{($HELPERS['weather'].units || 'fahrenheit')[0].chr}.xml"
     begin xml = REXML::Document.new open(url).read rescue return nil end
     xml2hash xml.elements
@@ -74,7 +74,7 @@ class Weather
     doc = REXML::Document.new response
     results = doc.elements.to_a('/search/loc')
     if results.size.zero?
-      puts "Couldn't resolve weather information for #{where}"
+      warn "Couldn't resolve weather information for #{where}"
       nil
     else results[0].attributes['id']
     end

data/lib/adhearsion.rb

@@ -23,13 +23,19 @@ module Asterisk
   # within Adhearsion. The first argument should be the case-insensitive name
   # of the application and any arguments needed by the application can simply
   # by trailed onto the end of the method. For a full list of Asterisk's
-  # applications, see "this":http://www.voip-info.org/wiki/index.php?page=Asterisk+-+documentation+of+application+commands
+  # applications, see
+  # "this":http://www.voip-info.org/wiki/index.php?page=Asterisk+-+documentation+of+application+commands
 	def exec(app, *options)
 		result = rawr "EXEC #{app} " + (options * '|')
 		result = result[/-?\d+$/]
 		result == "-2" ? false : result
 	end
   
+  # If this method is invoked during a call, the Call Detail Records (the logs
+  # Asterisk keeps on its calls) will not be written when the call completes.
+  def no_cdr() rawr :NoCDR end
+  alias do_not_bill no_cdr
+  
 	# This method of receiving user input uses the fantastic Asterisk
   # Read() application, but its results are pretty inconsitent over
   # AGI. This code has been kept here in case these bugs are fixed.
@@ -45,7 +51,7 @@ module Asterisk
 		exec :read, args
 		$OSCAR[:VARS] << args.first
 		x = get_variable(args.first).gsub(/[\(\)]/, "")
-		puts "RETURN: #{x.inspect}"
+		debug "RETURN: #{x.inspect}"
 		x.simplify
 	end
 	
@@ -105,8 +111,16 @@ module Asterisk
   end
   
   # An abstracted remote mutator for setting Asterisk variables.
-	def set_variable(key,value) rawr "SET VARIABLE #{key} #{value}" end
-
+  # You may optionally pass as a third argument ":normally" to
+  # have the variable set with Set() instead of AGI.
+	def set_variable(key,value,mode=:abnormally)
+	  case mode
+	    when :abnormally then rawr "SET VARIABLE #{key} #{value}"
+	    when :normally then exec :Set, "#{key}=#{value}"
+	    else raise "Invalid mode when setting variable!"
+    end
+  end
+  
 	# An abstracted remote accessor for retrieving Asterisk variables.
 	def get_variable(key, default=nil)
 		result = rawr "GET VARIABLE #{key}"
@@ -225,20 +239,38 @@ module Asterisk
     end
   end
 
-  # Simply print()s the command over the AGI IO socket.
-  def putc(what) PBX.io.print what end
+  # Very simply sends the command over the AGI IO socket and forgets about it.
+  def putc(what) PBX.io.print "#{what}" end
   
   # The magical method that handles how objects passed to dial() are converted to their
-  # corresponding Asterisk-recognizable technology/extension identifier. Likely wouldn't
-  # be used much outside of dial().
+  # corresponding Asterisk-recognizable technology/extension identifier. This likely
+  # wouldn't be used much outside of dial(), but you may find it useful.
 	def properize who
-		possible_methods = [:users, :members, :user, :member].select { |pm| who.respond_to? pm } # These are the convention methods for Group-like objects
-		who = who.send possible_methods.first if possible_methods.any? # If 'who' has any of the possible_methods, replace 'who' with the return value of that method
-		return unless who
-		who = [who] unless who.kind_of?(Enumerable) && !who.kind_of?(String) # In case we can't perform collection algorithms on 'who', let's encapsulate it in an Array
-		# If the first thing in the Enumerable responds to a User-like convention, then set 'who' equal to the extension accessor of those objects
-		who.map! { |p| p.send possible_methods.first }.compact! if (possible_methods = [:extension, :extensions].select { |pm| who.first.respond_to? pm }).any? 
-		# Now replace each item in the Enumerable with its form converted to extension (assuming it's not already in that format)
+	  # These are the convention methods for Group-like objects
+		possible_methods = [:users, :members, :user, :member].select do |pm|
+		  who.respond_to? pm
+		end
+		
+		# If 'who' has any of the possible_methods, replace 'who' with the return value
+		# of that method
+		who = who.send possible_methods.first if possible_methods.any?
+		return nil unless who
+		
+		# In case we can't perform collection algorithms on 'who', let's encapsulate it in
+		# an Array
+		who = [who] unless who.kind_of?(Enumerable) && !who.kind_of?(String)
+		
+		# If the first thing in the Enumerable responds to a User-like convention, then 
+	  #	set 'who' equal to the extension accessor of those objects. We refine the "who"
+	  # argument more and more in this way until it's finally in a way Asterisk can read.
+		who.map! do |p|
+		  p.send possible_methods.first
+		end.compact! if (possible_methods = [:extension, :extensions].select do |pm|
+		  who.first.respond_to? pm
+		end).any?
+		
+		# Now replace each item in the Enumerable with its form converted to
+		# extension (assuming it's not already in that format)
 		who.map! do |ext|
       if ext.kind_of?(String) && ext.index(?/) then ext
       else
@@ -246,7 +278,7 @@ module Asterisk
         "SIP/#{ext}"
       end
     end
-		who *= '&' # Finally, join() anything left in the Array with an '&'
+		who * '&' # Finally, join() anything left in the Array with an '&'
 	end
 
 	# Returns the status of the last dial(). Possible dial
@@ -268,39 +300,30 @@ module Asterisk
 	def hangup() rawr 'HANGUP' end
 	# Direct translation of the Asterisk NoOp() application. Used primarily for
 	# viewing debug information in the Asterisk CLI.
-	def noop(*options) rawr "NOOP #{options}" end
+	def noop(*options) rawr "NOOP #{options}" end	
 
-  # The SIP/ZAP/IAX/IAX2/Zap methods allow for cleaner addressing of particular
-	# extensions, abstracting Asterisk's representation. If not given any
-	# argument, this methods simply return a symbol identifying their
-	# appropriate protocol.
-	
-	# See the SIP class
-	def SIP(ext=nil) ext ?  "SIP/#{ext}" : :SIP end
-	# See the ZAP class
-	def ZAP(ext=nil) ext ? "Zap/#{ext}"  : :ZAP end
-	# See the IAX class
-	def IAX(ext=nil) ext ? "IAX2/#{ext}" : :IAX end
-	alias IAX2 IAX
-	alias Zap ZAP
-	
-	# For the completely selfish purpose of sugaring the syntax, two tiny holder classes
-	# are created to allow the synonym of SIP(1404) to be SIP[1404]. Both functions,
-	# when given an argument, return a String that Asterisk understands representing that
-	# particular channel.
-	
-	# Syntax sugar for declaring SIP devices. Use: SIP/123 or SIP[123]
+  # This SIP class abstracts several SIP-related functions. In your dialplan,
+  # if you should want to set a SIP header specifically, simply use the class
+  # []= operator. For example, you may want to do SIP['Alert-Info'] = 'Ring-Answer'
+  # which will affect the next SIP call placed. Additionally, you can use this
+  # class's division operator to naturally represent "technology/channel"
+  # endpoints (e.g. SIP/1550 or SIP/:tweedledum)
 	class SIP
-		def self.[](arg=nil) SIP(arg) end
-		def self./(arg=nil) SIP(arg) end
+	  def self.[](header)
+	    exec 
+    end
+		def self.[]=(header, value)
+		  exec :SipAddHeader, "#{header}: #{value}"
+		end
+		def self./(ext) "SIP/#{ext}" end
 	end
-  # Syntax sugar for declaring IAX devices. Use: IAX/123 or IAX[123]
+  
   class IAX
     def self.[](arg=nil) IAX(arg) end
     def self./(arg=nil) IAX(arg) end
   end
 
-  # Syntax sugar for declaring ZAP devices. Use: ZAP/123 or ZAP[123]
+  
   class ZAP
     def self.[](arg=nil) ZAP(arg) end
     def self./(arg=nil) ZAP(arg) end
@@ -379,24 +402,115 @@ class InvalidRailsDirectory < Exception;end
 # When instantiated with an absolute location to a Rails app, the new RailsApp will perform
 # a number of useful observations about the files and directories available, such as loading
 # the database configuration and listing all of the models. All observations are made accessible
-# through attribute accessors. 
-class RailsApp
-  def initialize path=Dir.pwd
-    update! path
-  end
+# through attribute accessors. Note: This implementation is experimental.
+class RailsApp                                                                                                                                                                                                                      
+  def initialize path=Dir.pwd                                                                                                                                                                                                       
+    update! path                                                                                                                                                                                                                    
+  end                                                                                                                                                                                                                               
+                                                                                                                                                                                                                                    
+  # Performs the observations on the Rails app once more.                                                                                                                                                                           
+  def update! path                                                                                                                                                                                                                  
+    @path = path                                                                                                                                                                                                                    
+    @database_config_file = File.join @path, 'config', 'database.yml'                                                                                                                                                               
+    if File.readable? @database_config_file                                                                                                                                                                                         
+      @database_config = YAML.load_file @database_config_file                                                                                                                                                                       
+    else raise InvalidRailsDirectory.new("Database config file #{@database_config_file} not found!")                                                                                                                                
+    end                                                                                                                                                                                                                             
+    @models_folder = File.join path, 'app', 'models'                                                                                                                                                                                
+    @models_files  = Dir[ File.join(@models_folder, '*.rb') ]                                                                                                                                                                       
+    @time_updated = Time.now                                                                                                                                                                                                        
+  end                                                                                                                                                                                                                               
+  attr_reader :database_config_file, :database_config, :path, :models_folder, :models_files,                                                                                                                                        
+              :models_names, :time_updated                                                                                                                                                                                          
+end
 
-  # Performs the observations on the Rails app once more.
-  def update! path
-    @path = path
-    @database_config_file = File.join @path, 'config', 'database.yml'
-    if File.readable? @database_config_file
-      @database_config = YAML.load_file @database_config_file
-    else raise InvalidRailsDirectory.new("Database config file #{@database_config_file} not found!")
+# This class is the subsystem for anything that may facilitate instant messaging with Adhearsion.
+# If you've seen the im() method used in Adhearsion before, its features can be attributed to
+# the way the InstantMessenger class handles any number of helpers wanting to provide IM
+# functionality.
+#
+# If you're wanting to write your own instant messaging helper, you simply need to create some
+# kind of object that has all of the InstantMessenger::MANDATORY_METHODS. Calling
+# InstantMessenger.use_service(your_instance) and passing this conforming object will keep it
+# referenced internally and potentially used when im() is called. 
+class InstantMessenger
+  
+  # Here is a synopsis of what the MANDATORY_METHODS do:
+  #  * your_username?(screenname) takes a screenname and checks whether its own instance
+  #    uses it.
+  #  * may_be_yours?(screename) takes a screenname account and returns a boolean
+  #    for whether the screen name *could* belong to the instance. For example, in the
+  #    MultiMessenger helper, this argument is checked against a regular expression for
+  #    email addresses because all Jabber accounts use this format.
+  #  * im(sn,msg) is a method all instances ultimately receive to send a message.
+  #    The Hash argument can be :through (for service) and :with (for username)
+  MANDATORY_METHODS = [:your_username?, :may_be_yours?, :im, :your_service?, :connected?]
+  @@messengers ||= []
+  
+  # If you're writing your own instant messaging system, you would call this method
+  # method on the object that conforms to InstantMessenger::MANDATORY_METHODS. It's
+  # placed in a class Array variable and available to the im() method throughout Adhearsion.
+  def InstantMessenger.use_service instance
+    MANDATORY_METHODS.each do |m|
+      raise ArgumentError, "#{instance} must implement '#{m}'!" unless instance.respond_to? m
+    end
+    @@messengers << instance
+  end
+  
+  cattr_reader :messengers
+  
+  def InstantMessenger.im sn, msg, hash={}
+    if hash[:through] && hash[:with]
+      candidates = @@messengers.select do |c|
+        # Find the service that both matches the service name and the username.
+        c.your_service?(hash[:through]) && c.your_username?(hash[:with]) && c.connected?
+      end
+    elsif hash[:through] || hash[:with]
+      candidates = @@messengers.select(&:connected?)
+      if hash[:through]
+        candidates += @@messengers.select do |c|
+          c.your_service?(hash[:through]) && c.connected?
+        end
+      end
+      if hash[:with]
+        candidates += @@messengers.select do |c|
+          c.your_username?(hash[:with]) && c.connected?
+        end
+      end
+    else
+      candidates = @@messengers.select { |x| x.may_be_yours? sn }
+    end
+    
+    if candidates.size == 1
+      # We've found our match!
+      candidates.first.im sn, msg
+    elsif candidates.empty?
+      # The app creator probably didn't enable their IMing helper
+      raise ArgumentError, "No instant messaging services found! Did you enable your helper?"
+    else
+      raise ArgumentError, "Too ambiguous! " +
+      "Please pass a :with => 'screenname' or :through => :your_service argument to clarify!"
     end
-    @models_folder = File.join path, 'app', 'models'
-    @models_files  = Dir[ File.join(@models_folder, '*.rb') ]
-    @time_updated = Time.now
   end
-  attr_reader :database_config_file, :database_config, :path, :models_folder, :models_files,
-              :models_names, :time_updated
 end
+
+# Send a message to anyone, provided a proper instant messaging helper has been installed
+# and configured. Simply pass the screen name and message of the user. If you're using
+# multiple helpers for different services, you may need to pass in Hash-key arguments to
+# clarify.
+#
+# Understood Hash-key arguments include:
+# * :through => The service name (as a symbol or string) for the instant message.
+# * :with => The username with which the account is signed on
+#
+# It is sometimes unnecessary to provide Hash-key arguments when your helper can intelligently
+# distinguish its format from others'. For example, if you have both an AIM IM helper and a
+# GTalk/Jabber/XMPP helper registered, then the latter knows its screen names take the format
+# of email addresses, thus im("Jicksta", "AIM!!!") and im("x@Gmail.com", "GTalk!!!") both
+# work without having to do im("Jicksta", "AIM!!!", :through => :AIM) 
+# or im(x@Gmail.com,"GTalk!!!", :through => :GTalk). If multiple AIM users were logged on, you
+# would *need* to do im("Jicksta","Was gibt's?", :with => "RegisteredUser") where "RegisteredUser"
+# is one of the names you're signed into AIM with. Note: this example doesn't use the :through
+# Hash-key argument because it assumes no other helpers are installed with this same format.
+# If you had a MSN or Yahoo helper installed too, you'd need to do specify :through because
+def im(sn, msg, hash={}) InstantMessenger.im(sn,msg,hash) end

data/lib/logging.rb

@@ -0,0 +1,68 @@
+require 'logger'
+
+LOGGERS = []
+*LOGGING_METHODS = :fatal, :error, :warn, :info, :debug
+#*LOGGING_METHODS = :debug, :log, :warn, :error, :fatal
+$LOGGING_SEVERITY ||= CONFIG['logging_severity'] || LOGGING_METHODS.size-1
+
+$HUTDOWN.hook do
+  LOGGERS.each { |l| l.close if l.respond_to?(:close) }
+end
+
+# Lets helper authors and Adhearsion developers specify a logging endpoint.
+# The only requirement of a logger is that it implements each of the
+# methods defined in LOGGING_METHODS. A logging endpoint could be STDOUT,
+# a log file, Jabber screen name, IRC channel, or a dispatched email.
+def register_logger logger
+  deviance = LOGGING_METHODS.reject {|x| logger.respond_to? x }
+  raise "Logger must implement the #{deviance.to_sentence} method(s)" if deviance.any?
+  LOGGERS << logger
+end
+
+# Provides a safe setter for the logging severity. Its one argument should
+# be a symbol matching something in the LOGGING_METHODS array. The symbol
+# provided corresponds to the *minimum* logging level. For example, if
+# this method were invoked as such
+#
+#     logging_severity = :warn
+# 
+# Then only calls to fatal(), error(), and warn() would be processed.
+# Calls to log() or debug() would both be ignored.
+def set_logging_severity sym
+  i = LOGGING_METHODS.index sym
+  raise "Specified severity #{sym} not valid!" unless i
+  $LOGGING_SEVERITY = i
+end
+
+# Simply returns the current logging severity
+def logging_severity() LOGGING_METHODS[$LOGGING_SEVERITY] end
+
+# Used in development phases to log developer-related information.
+def  debug(msg) __log__ msg, 4, :debug end
+
+# The standard logging method. Give it a message to log.
+def    info(msg) __log__ msg, 3, :info end
+alias log info
+
+# For reporting messages about potentially hazardous issues.
+def   warn(msg) __log__ msg, 2, :warn end
+
+# Will Robinson, we've had an error! Let's report it!  You may
+# wish to have these errors emailed to the administrator when
+# they occur.
+def  error(msg) __log__ msg, 1, :error end
+
+# This is for seriously bad errors. You may wish to have
+# these errors emailed to the administrator when they occur.
+def  fatal(msg) __log__ msg, 0, :fatal end
+
+def __log__ msg, severity, method
+  LOGGERS.each { |x|  x.__send__ method, msg if $LOGGING_SEVERITY >= severity }
+end
+
+class StandardLogger < Logger
+  def initialize *args
+    super *args
+    formatter = lambda {}
+  end
+end

data/lib/rami.rb

@@ -366,12 +366,12 @@ end
 
 
 def connect
-  puts "Connecting to Asterisk Manager Interface at #{@host}:#{@port}"
+  log "Connecting to Asterisk Manager Interface at #{@host}:#{@port}"
   @sock = nil
   begin
     @sock = TCPSocket.new(@host,@port)
   rescue => e
-    $stderr.puts <<-MSG
+    warn <<-MSG
 
     * Adhearsion First Time Setup
     *
@@ -409,7 +409,7 @@ def connect
   return true
   end
 rescue Timeout::Error => e
-  puts "LOGIN TIMEOUT"
+  error "LOGIN TIMEOUT"
   return false
 end
 
@@ -467,7 +467,7 @@ def mainloop
       end
     end
     rescue IOError => e
-      puts "Socket disconnected #{e}"
+      error "Socket disconnected #{e}"
     end
   end
 end
@@ -504,9 +504,9 @@ public
 # Starts the server and connects to asterisk.
 def run
   if connect
-    puts "#{Time.now} MSG: LOGGED IN"
+    log "#{Time.now} MSG: LOGGED IN"
   else
-    puts "#{Time.now} MSG: LOGIN FAILED"
+    error "#{Time.now} MSG: LOGIN FAILED"
     exit
   end
   mainloop
@@ -811,12 +811,12 @@ def send_action(action=nil,t=10)
   end
   return result
 rescue Exception => e
-  puts "#{e}: TIMEOUT #{t} #{sent_id}"
-  puts e.backtrace
+  warn "#{e}: TIMEOUT #{t} #{sent_id}"
+  debug e.backtrace
   return result
 end
 
 end
   rescue Exception => e
-  puts e
+  error e
 end

data/lib/servlet_container.rb

@@ -104,7 +104,7 @@ class ServletContainer
                 begin
                   +send(target_context.to_s.to_sym)
                 rescue => e
-                  STDERR.puts e.inspect
+                  error e.inspect
                   +lambda {
                     play 'were-sorry'
                     hangup

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: adhearsion
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
-date: 2006-12-29 00:00:00 -06:00
+  version: 0.7.4
+date: 2007-01-20 00:00:00 -06:00
 summary: Adhearsion is a professional integration system for integrating anything and everything.
 require_paths: 
 - lib
@@ -30,60 +30,66 @@ authors:
 - Jay Phillips
 files: 
 - ahn
+- apps
 - docs
 - lib
 - LICENSE
-- new_projects
 - pkg
 - Rakefile
 - test
+- apps/codemeccollab
+- apps/default
+- apps/default/config
+- apps/default/extensions.rb
+- apps/default/helpers
+- apps/default/logs
+- apps/default/Rakefile
+- apps/default/config/adhearsion.sqlite3
+- apps/default/config/adhearsion.yml
+- apps/default/config/database.rb
+- apps/default/config/database.yml
+- apps/default/config/helpers
+- apps/default/config/migration.rb
+- apps/default/config/helpers/drb_server.yml
+- apps/default/config/helpers/factorial.alien.c.yml
+- apps/default/config/helpers/manager_proxy.yml
+- apps/default/config/helpers/micromenus
+- apps/default/config/helpers/micromenus.yml
+- apps/default/config/helpers/multi_messenger.yml
+- apps/default/config/helpers/weather.yml
+- apps/default/config/helpers/xbmc.yml
+- apps/default/config/helpers/micromenus/collab.rb
+- apps/default/config/helpers/micromenus/images
+- apps/default/config/helpers/micromenus/javascripts
+- apps/default/config/helpers/micromenus/stylesheets
+- apps/default/config/helpers/micromenus/images/tux.bmp
+- apps/default/config/helpers/micromenus/javascripts/builder.js
+- apps/default/config/helpers/micromenus/javascripts/controls.js
+- apps/default/config/helpers/micromenus/javascripts/dragdrop.js
+- apps/default/config/helpers/micromenus/javascripts/effects.js
+- apps/default/config/helpers/micromenus/javascripts/prototype.js
+- apps/default/config/helpers/micromenus/javascripts/scriptaculous.js
+- apps/default/config/helpers/micromenus/javascripts/slider.js
+- apps/default/config/helpers/micromenus/javascripts/unittest.js
+- apps/default/config/helpers/micromenus/stylesheets/firefox.css
+- apps/default/config/helpers/micromenus/stylesheets/firefox.xul.css
+- apps/default/helpers/drb_server.rb
+- apps/default/helpers/factorial.alien.c
+- apps/default/helpers/manager_proxy.rb
+- apps/default/helpers/micromenus.rb
+- apps/default/helpers/multi_messenger.rb
+- apps/default/helpers/oscar_wilde_quotes.rb
+- apps/default/helpers/weather.rb
+- apps/default/helpers/xbmc.rb
+- apps/default/logs/adhearsion.log
+- apps/default/logs/database.log
 - lib/adhearsion.rb
 - lib/constants.rb
 - lib/core_extensions.rb
 - lib/database_functions.rb
+- lib/logging.rb
 - lib/rami.rb
 - lib/servlet_container.rb
-- new_projects/config
-- new_projects/extensions.rb
-- new_projects/helpers
-- new_projects/logs
-- new_projects/Rakefile
-- new_projects/config/adhearsion.sqlite3
-- new_projects/config/adhearsion.yml
-- new_projects/config/database.rb
-- new_projects/config/database.yml
-- new_projects/config/helpers
-- new_projects/config/migration.rb
-- new_projects/config/helpers/drb_server.yml
-- new_projects/config/helpers/factorial.alien.c.yml
-- new_projects/config/helpers/manager_proxy.yml
-- new_projects/config/helpers/micromenus
-- new_projects/config/helpers/micromenus.yml
-- new_projects/config/helpers/weather.yml
-- new_projects/config/helpers/xbmc.yml
-- new_projects/config/helpers/micromenus/collab.rb
-- new_projects/config/helpers/micromenus/images
-- new_projects/config/helpers/micromenus/javascripts
-- new_projects/config/helpers/micromenus/stylesheets
-- new_projects/config/helpers/micromenus/images/tux.bmp
-- new_projects/config/helpers/micromenus/javascripts/builder.js
-- new_projects/config/helpers/micromenus/javascripts/controls.js
-- new_projects/config/helpers/micromenus/javascripts/dragdrop.js
-- new_projects/config/helpers/micromenus/javascripts/effects.js
-- new_projects/config/helpers/micromenus/javascripts/prototype.js
-- new_projects/config/helpers/micromenus/javascripts/scriptaculous.js
-- new_projects/config/helpers/micromenus/javascripts/slider.js
-- new_projects/config/helpers/micromenus/javascripts/unittest.js
-- new_projects/config/helpers/micromenus/stylesheets/firefox.css
-- new_projects/config/helpers/micromenus/stylesheets/firefox.xul.css
-- new_projects/helpers/drb_server.rb
-- new_projects/helpers/factorial.alien.c
-- new_projects/helpers/manager_proxy.rb
-- new_projects/helpers/micromenus.rb
-- new_projects/helpers/oscar_wilde_quotes.rb
-- new_projects/helpers/weather.rb
-- new_projects/helpers/xbmc.rb
-- new_projects/logs/database.log
 - test/core_extensions_test.rb
 - test/dial_test.rb
 - test/test_micromenus.rb
@@ -92,8 +98,8 @@ test_files: []
 
 rdoc_options: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
 executables: 
 - ahn
 extensions: []
@@ -110,15 +116,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.14.4
     version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: rake
   version_requirement: 

data/new_projects/config/helpers/xbmc.yml

@@ -1 +0,0 @@
-ip: 192.168.1.136:80