adhearsion 0.7.7 → 0.8.0

data/CHANGELOG

@@ -1,43 +1,10 @@
---- ADDED ---
-The "extension" dialplan variable is now handled with a special PhoneNumber class that resolves issues with extensions beginning with a zero.
-Added PBX.introduce which much more conveniently connects two endpoints.
-Can now use Asterisk dialplan methods like _('2XZNX32Z')
-Merged in the improved Micromenu GUI branch for modern browsers.
-Can now play() currency values. e.g.: play "$12.50"
-Did some preliminary work on Snom/Cisco support in Micromenus with a Snom employee at AstriDevCon.
-Broke up PhoneNumber into PhoneNumber and NumericalString. Wrote an RSpec for their functionality.
-Added the PBX.call_and_exec() method. Preliminary work on PBX.overhear()
-Implemented the redirection (~) unary operation to dialplan contexts. For example +just_dial in a dialplan executes the "just_dial" context and continues in the originating context. Doing ~just_dial executes "just_dial" and does not return to the originating context. What's more, the originating context is removed from the eval() context stack which could lead to some heavy memory use when used intensely.
-Added a super-simple dialplan method segment() which wraps code in a block so redo keywords can work for targeted dialplan segment.
-Added a patch by Bruce Williams of Five Runs who contributed some great code for generating Asterisk dialplan technology classes (i.e. IAX2/123 or SCCP/123123)
-The lookup() helper now also makes available a :name property
-Added default value of hangup_after_error to the config file.
-Adding file for making Adhearsion migrations much nicer
-Minor changes to speak()
-Minor improvement to the default migration to help people get up and running (and create new content at the end of a migration) 
-Minor enhancement which makes dial() a little more intuitive when setting the :callerid hash key argument 
-Other numerical variables received from Asterisk over AGI now use NumericalString instead of blowing up their thread.
-Added a SIP_URI constant regexp
-Can now give a Time object to play()
-Jabber events can now be handled much easier in the multi_messenger.rb helper 
-Can now call detach!() in a dialplan to let Asterisk's extensions.conf continue executing.
-Can now call size() and length() on a Fixnum. Works just like num.to_s.size. Useful when working with numerical extensions.
-Can now give a Symbol to play(). Example -- play:beep
-Can now specify whether events should be captured by Adhearsion's AMI client. 
-Can now specify whether incoming subscription requests should be automatically accepted
-Can now specify whether the Adhearsion AMI client should receive events or not by putting events: true or events:false in adhearsion.yml
-Added several new technology classes (SCCP, Local)
-Can now use sugary syntaxes like IAX/:foo/12
+0.8.1
 
---- FIXED ---
-Fixed wait_for_digit timeout
-Fixed the speak() method. Now works with Festival (which comes by default with AsteriskNOW)
-Fixed a variable name that blew up the interpreter
-Fixed a comment suggestion
-Fixed a small syntactical error that prevented a helper from running.
-Fixed syntactical issues in the test file
-The factorial method had a mathematical error in it.
-Asterisk-played error messages are more verbose
-Fixed the wait_for_digit bug reported by ernieboy
-Fixed method_missing notifier method in PBX
-I no longer live in Dallas so I'm changing the startup message. :)
+
+
+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)
+ - Adding a deprecation warning about Fixnum#digit and Fixnum#digits
+ - Removed the AMI class and replaced it with the ManagerInterface class.
+ - The old AMI high-level instance methods are available in the new ManagerInterface class, but a deprecation warning will be logged each time they're used. When the SuperManager class is implemented, they'll be removed entirely.
+ - Moved Theatre into Adhearsion's lib folder.

data/EVENTS

@@ -0,0 +1,11 @@
+# Below are a list of framework events:
+  
+- after_initialized
+- shutdown
+- asterisk:
+  - manager_interface
+  - before_call
+  - failed_call
+  - call_hangup
+
+# Note: This file is valid YAML for programatic parsing.

data/README.txt

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

data/Rakefile

@@ -1,110 +1,120 @@
+# -*- ruby -*-
+ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
+
 require 'rubygems'
-require 'rake/testtask'
-require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
-ADHEARSION_VERSION = File.read('.version').strip
-Summary = %{Adhearsion is metaprogramming framework for developing collaboration software.}
-
-#task :default => [:test]
-
-#desc "Run the Adhearsion unit tests"
-#task :test do
-#  Dir['test/*.rb'].each do |f| require f end
-#end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  abort "You must install RSpec: sudo gem install rspec"
+end
 
-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
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb'] + %w[README.markdown TODO.markdown LICENSE]
+  end
+rescue LoadError
+  STDERR.puts "\nCould not require() YARD! Install with 'gem install yard' to get the 'yardoc' task\n\n"
 end
 
-GEM_SPEC = Gem::Specification.new do |s|
-  
-  s.name     = 'adhearsion'
-  s.rubyforge_project = 'adhearsion'
-  s.author   = 'Jay Phillips'
-  s.email    = 'jay -at- codemecca dot com'
-  s.version  = ADHEARSION_VERSION
-  s.summary  = Summary
-  s.homepage = 'http://adhearsion.com'
+require 'lib/adhearsion/version'
 
-  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'
-  s.bindir = '.'
-  s.extra_rdoc_files = ['LICENSE']
+AHN_TESTS     = ['spec/**/test_*.rb']
+GEMSPEC       = eval File.read("adhearsion.gemspec")
+RAGEL_FILES   = %w[lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rl.rb]
+THEATRE_TESTS = 'theatre-spec/**/*_spec.rb'
 
-  inc = Dir['**/*'] << '.version'
-  exc = Dir['{log,pkg}/**/*']
-  
-  s.files = inc - exc
-  
-  # test_files = Dir['tests/*.rb'] # Will be added when not so buggy
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = Dir[*AHN_TESTS]
+    t.output_dir = 'coverage'
+    t.verbose = true
+    t.rcov_opts.concat %w[--sort coverage --sort-reverse -x gems -x /var --no-validator-links]
+  end
+rescue LoadError
+  STDERR.puts "Could not load rcov tasks -- rcov does not appear to be installed. Continuing anyway."
 end
 
-Rake::GemPackageTask.new GEM_SPEC do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = false
-end
+Rake::GemPackageTask.new(GEMSPEC).define
+
+# YARD::Rake::YardocTask.new do |t|
+#   t.files   = ['lib/**/*.rb']   # optional
+#   # t.options = ['--any', '--extra', '--opts'] # optional
+# end
 
-desc "Pulls down the entire wiki in HTML format"
-task :wiki => [:rm_wiki] do
-  require 'open-uri'
-  File.open "wiki.zip",'a' do |f|
-    f.write open('http://adhearsion.stikipad.com/codex/export_html').read
+desc "Run the unit tests for Adhearsion"
+task :spec do
+  Dir[*AHN_TESTS].each do |file|
+    load file
   end
-  Dir.mkdir 'docs' unless File.exists? 'docs'
-  `unzip -d docs/wiki wiki.zip`
-  File.delete 'wiki.zip'
-  puts `find docs/wiki`
 end
 
-desc "Removes all cached compiled RubyInline shared objects"
-task :purge_objects do
-  `rm -rf ~/.ruby_inline/*`
+desc "Check Ragel version"
+task :check_ragel_version do
+  ragel_version_match = `ragel --version`.match(/(\d)\.(\d)+/)
+  abort "Could not get Ragel version! Is it installed? You must have at least version 6.3" unless ragel_version_match
+  big, small = ragel_version_match.captures.map { |n| n.to_i }
+  if big < 6 || (big == 6 && small < 3)
+    abort "Please upgrade Ragel! You're on version #{ragel_version_match[0]} and must be on 6.3 or later"
+  end
 end
 
-desc "Removes the local copy of the wiki"
-task :rm_wiki do
-  `rm -rf wiki.zip docs/wiki/`
+desc "Used to regenerate the AMI source code files. Note: requires Ragel 6.3 or later be installed on your system"
+task :ragel => :check_ragel_version do
+  RAGEL_FILES.each do |ragel_file|
+    ruby_file = ragel_file.sub(".rl.rb", ".rb")
+    puts `ragel -n -R #{ragel_file} -o #{ruby_file} 2>&1`
+    raise "Failed generating code from Ragel file #{ragel_file}" if $?.to_i.nonzero?
+  end
 end
 
-desc "Prepares Adhearsion for a new release"
-task :prepare_release do
-  # Remove log files
-  Dir['log/*.log'].each do |f|
-    puts "Removing file #{f}"
-    File.delete f
+desc "Generates a GraphVis document showing the Ragel state machine"
+task :visualize_ragel => :check_ragel_version do
+  RAGEL_FILES.each do |ragel_file|
+    base_name = File.basename ragel_file, ".rl.rb"
+    puts "ragel -V #{ragel_file} -o #{base_name}.dot 2>&1"
+    puts `ragel -V #{ragel_file} -o #{base_name}.dot 2>&1`
+    raise "Failed generating code from Ragel file #{ragel_file}" if $?.to_i.nonzero?
   end
-
-  # Check for unversioned files
-  unversioned_files = `svn st | grep '^\?' | awk '{ print $2 }'`
-  puts "WARNING: These files are not under version control:
-#{unversioned_files}" unless unversioned_files.empty? 
 end
 
-desc "Simply prints the Adhearsion version."
-task :version do puts ADHEARSION_VERSION end
+desc "Run all RSpecs for Theatre"
+Spec::Rake::SpecTask.new("theatre_specs") do |t|
+  t.spec_files = FileList[THEATRE_TESTS]
+end
 
-desc 'Reinstall the gem'
-task :update => [:repackage] do
-  if `whoami`.chomp != 'root'
-    puts "Must run this as root!"
-    exit 1
+desc "Compares Adhearsion's files with those listed in adhearsion.gemspec"
+task :check_gemspec_files do
+  
+  files_from_gemspec    = ADHEARSION_FILES
+  files_from_filesystem = Dir.glob(File.dirname(__FILE__) + "/**/*").map do |filename|
+    filename[0...Dir.pwd.length] == Dir.pwd ? filename[(Dir.pwd.length+1)..-1] : filename
   end
-  puts `gem uninstall adhearsion`
-  `gem install pkg/adhearsion*.gem`
-  puts "Done."
+  files_from_filesystem.reject! { |f| File.directory? f }
+  
+  puts
+  puts 'Pipe this command to "grep -v \'spec/\' | grep -v test" to ignore test files'
+  puts
+  puts '##########################################'
+  puts '## Files on filesystem not in the gemspec:'
+  puts '##########################################'
+  puts((files_from_filesystem - files_from_gemspec).map { |f| "  " + f })
+  
+  
+  puts '##########################################'
+  puts '## Files in gemspec not in the filesystem:'
+  puts '##########################################'
+  puts((files_from_gemspec - files_from_filesystem).map { |f| "  " + f })
 end
 
-desc 'Creates the Trixbox RPM.'
-task :trixbox => [:repackage] do
-  # Coming soon
+desc "Test that the .gemspec file executes"
+task :debug_gem do
+  require 'rubygems/specification'
+  gemspec = File.read('adhearsion.gemspec')
+  spec = nil
+  Thread.new { spec = eval("$SAFE = 3\n#{gemspec}") }.join
+  puts "SUCCESS: Gemspec runs at the $SAFE level 3."
 end

data/adhearsion.gemspec

@@ -0,0 +1,148 @@
+ADHEARSION_FILES = %w{
+  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/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/simon_game/simon_game.rb
+  app_generators/ahn/templates/config/startup.rb
+  app_generators/ahn/templates/dialplan.rb
+  app_generators/ahn/templates/events.rb
+  app_generators/ahn/templates/Rakefile
+  app_generators/ahn/templates/README
+  app_generators/ahn/USAGE
+  bin/ahn
+  bin/ahnctl
+  bin/jahn
+  CHANGELOG
+  EVENTS
+  examples/asterisk_manager_interface/standalone.rb
+  lib/adhearsion.rb
+  lib/adhearsion/cli.rb
+  lib/adhearsion/component_manager.rb
+  lib/adhearsion/component_manager/component_tester.rb
+  lib/adhearsion/component_manager/spec_framework.rb
+  lib/adhearsion/events_support.rb
+  lib/adhearsion/foundation/all.rb
+  lib/adhearsion/foundation/blank_slate.rb
+  lib/adhearsion/foundation/custom_daemonizer.rb
+  lib/adhearsion/foundation/event_socket.rb
+  lib/adhearsion/foundation/future_resource.rb
+  lib/adhearsion/foundation/global.rb
+  lib/adhearsion/foundation/metaprogramming.rb
+  lib/adhearsion/foundation/numeric.rb
+  lib/adhearsion/foundation/pseudo_guid.rb
+  lib/adhearsion/foundation/relationship_properties.rb
+  lib/adhearsion/foundation/string.rb
+  lib/adhearsion/foundation/synchronized_hash.rb
+  lib/adhearsion/foundation/thread_safety.rb
+  lib/adhearsion/host_definitions.rb
+  lib/adhearsion/initializer.rb
+  lib/adhearsion/initializer/asterisk.rb
+  lib/adhearsion/initializer/configuration.rb
+  lib/adhearsion/initializer/database.rb
+  lib/adhearsion/initializer/drb.rb
+  lib/adhearsion/initializer/freeswitch.rb
+  lib/adhearsion/initializer/rails.rb
+  lib/adhearsion/logging.rb
+  lib/adhearsion/tasks.rb
+  lib/adhearsion/tasks/database.rb
+  lib/adhearsion/tasks/deprecations.rb
+  lib/adhearsion/tasks/generating.rb
+  lib/adhearsion/tasks/lint.rb
+  lib/adhearsion/tasks/testing.rb
+  lib/adhearsion/version.rb
+  lib/adhearsion/voip/asterisk.rb
+  lib/adhearsion/voip/asterisk/agi_server.rb
+  lib/adhearsion/voip/asterisk/commands.rb
+  lib/adhearsion/voip/asterisk/config_generators/agents.conf.rb
+  lib/adhearsion/voip/asterisk/config_generators/config_generator.rb
+  lib/adhearsion/voip/asterisk/config_generators/queues.conf.rb
+  lib/adhearsion/voip/asterisk/config_generators/voicemail.conf.rb
+  lib/adhearsion/voip/asterisk/config_manager.rb
+  lib/adhearsion/voip/asterisk/manager_interface.rb
+  lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rb
+  lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rl.rb
+  lib/adhearsion/voip/asterisk/manager_interface/ami_messages.rb
+  lib/adhearsion/voip/asterisk/manager_interface/ami_protocol_lexer_machine.rl
+  lib/adhearsion/voip/asterisk/special_dial_plan_managers.rb
+  lib/adhearsion/voip/asterisk/super_manager.rb
+  lib/adhearsion/voip/call.rb
+  lib/adhearsion/voip/call_routing.rb
+  lib/adhearsion/voip/commands.rb
+  lib/adhearsion/voip/constants.rb
+  lib/adhearsion/voip/conveniences.rb
+  lib/adhearsion/voip/dial_plan.rb
+  lib/adhearsion/voip/dsl/dialing_dsl.rb
+  lib/adhearsion/voip/dsl/dialing_dsl/dialing_dsl_monkey_patches.rb
+  lib/adhearsion/voip/dsl/dialplan/control_passing_exception.rb
+  lib/adhearsion/voip/dsl/dialplan/dispatcher.rb
+  lib/adhearsion/voip/dsl/dialplan/parser.rb
+  lib/adhearsion/voip/dsl/dialplan/thread_mixin.rb
+  lib/adhearsion/voip/dsl/numerical_string.rb
+  lib/adhearsion/voip/freeswitch/basic_connection_manager.rb
+  lib/adhearsion/voip/freeswitch/event_handler.rb
+  lib/adhearsion/voip/freeswitch/freeswitch_dialplan_command_factory.rb
+  lib/adhearsion/voip/freeswitch/inbound_connection_manager.rb
+  lib/adhearsion/voip/freeswitch/oes_server.rb
+  lib/adhearsion/voip/menu_state_machine/calculated_match.rb
+  lib/adhearsion/voip/menu_state_machine/matchers.rb
+  lib/adhearsion/voip/menu_state_machine/menu_builder.rb
+  lib/adhearsion/voip/menu_state_machine/menu_class.rb
+  lib/theatre.rb
+  lib/theatre/callback_definition_loader.rb
+  lib/theatre/guid.rb
+  lib/theatre/invocation.rb
+  lib/theatre/namespace_manager.rb
+  lib/theatre/README.markdown
+  lib/theatre/version.rb
+  LICENSE
+  Rakefile
+  README.txt
+}
+
+Gem::Specification.new do |s|
+  s.name = "adhearsion"
+  s.version = "0.8.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jay Phillips"]
+
+  s.date = "2008-08-21"
+  s.description = "Adhearsion is an open-source telephony development framework"
+  s.email = "Jay -at- Codemecca.com"
+  s.executables = ["ahn", "ahnctl", "jahn"]
+  
+  s.files = ADHEARSION_FILES
+  
+  s.has_rdoc = false
+  s.homepage = "http://adhearsion.com"
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "adhearsion"
+  s.rubygems_version = "1.2.0"
+  s.summary = "Adhearsion, open-source telephony development framework"
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency("rubigen", [">= 1.0.6"])
+      s.add_runtime_dependency("log4r", [">= 1.0.5"])
+    else
+      s.add_dependency("rubigen", [">= 1.0.6"])
+      s.add_dependency("log4r", [">= 1.0.5"])
+    end
+  else
+    s.add_dependency("rubigen", [">= 1.0.6"])
+    s.add_dependency("log4r", [">= 1.0.5"])
+  end
+end

data/app_generators/ahn/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/app_generators/ahn/ahn_generator.rb

@@ -0,0 +1,87 @@
+class AhnGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :author => nil
+  
+  attr_reader :name, :component
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    @component = 'simon_game'
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      m.file  *[".ahnrc"]*2
+      
+      m.file  *["components/simon_game/simon_game.rb"]*2
+      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/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  *["config/startup.rb"]*2
+      m.file  *["dialplan.rb"]*2
+      m.file  *["events.rb"]*2
+      m.file  *["README"]*2
+      m.file  *["Rakefile"]*2
+      
+      # m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'], 
+      #   :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      components/simon_game
+      components/disabled/stomp_gateway
+      components/ami_remote
+      components/restful_rpc/spec
+      config
+    )
+end