eric-adhearsion 0.7.999 → 0.8.0

data/CHANGELOG

@@ -1,3 +1,9 @@
-If you depended on the method last_dial_status, the Symbols returned have been slighted changed. See the documentation for the new names.
+0.8.0 rev 2
+ - Added a few non-critical files to the .gemspec. They were ignored
 
-the :callerid option for dial has been renamed to caller_id
+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/Rakefile

@@ -2,47 +2,119 @@
 ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
 
 require 'rubygems'
-require 'hoe'
+require 'rake/gempackagetask'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  abort "You must install RSpec: sudo gem install rspec"
+end
+
+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
+
 require 'lib/adhearsion/version'
 
+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'
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |t|
-    t.test_files = Dir['spec/**/test_*.rb']
+    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."
+  STDERR.puts "Could not load rcov tasks -- rcov does not appear to be installed. Continuing anyway."
 end
 
-TestGlob = ['spec/**/test_*.rb']
+Rake::GemPackageTask.new(GEMSPEC).define
 
-task :test do
-  STDERR.puts "\nTry using \"rake spec\" for something less noisy.\n\n"
-  # The other :test task is created by Hoe below.
+# YARD::Rake::YardocTask.new do |t|
+#   t.files   = ['lib/**/*.rb']   # optional
+#   # t.options = ['--any', '--extra', '--opts'] # optional
+# end
+
+desc "Run the unit tests for Adhearsion"
+task :spec do
+  Dir[*AHN_TESTS].each do |file|
+    load file
+  end
 end
 
-# Need to migrate away from Hoe...
-Hoe.new('adhearsion', Adhearsion::VERSION::STRING) do |p|
-  p.rubyforge_name = 'adhearsion'
-  p.author = 'Jay Phillips'
-  p.email = 'Jay -at- Codemecca.com'
-  p.summary = 'Adhearsion, open-source telephony integrator.'
-  p.description = "Adhearsion is an open-source VoIP development framework written in Ruby"
-  p.url = "http://adhearsion.com"
-  p.changes = "" # Removed because History.txt is tedious.
-  p.test_globs = TestGlob
-  p.extra_deps = [['rubigen', '>=1.0.6'], ['log4r', '>=1.0.5']]
+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
 
-task :spec do
-  Dir[*TestGlob].each do |file|
-    load file
+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 "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
 end
 
-task :ragel do
-  `ragel -n -R lib/adhearsion/voip/asterisk/ami/machine.rl | rlgen-ruby -o lib/adhearsion/voip/asterisk/ami/machine.rb`
-end
+desc "Run all RSpecs for Theatre"
+Spec::Rake::SpecTask.new("theatre_specs") do |t|
+  t.spec_files = FileList[THEATRE_TESTS]
+end
+
+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
+  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 "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/ahn_generator.rb

@@ -24,18 +24,30 @@ class AhnGenerator < RubiGen::Base
 
       m.file  *[".ahnrc"]*2
       
-      m.file  *["components/simon_game/configuration.rb"]*2
-      m.file  *["components/simon_game/lib/simon_game.rb"]*2
-      m.file  *["components/simon_game/test/test_helper.rb"]*2
-      m.file  *["components/simon_game/test/test_simon_game.rb"]*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/disabled/restful_rpc/restful_rpc.rb"]*2
+      m.file  *["components/disabled/restful_rpc/config.yml"]*2
+      m.file  *["components/disabled/restful_rpc/README.markdown"]*2
+      m.file  *["components/disabled/restful_rpc/example-client.rb"]*2
+      m.file  *["components/disabled/restful_rpc/spec/restful_rpc_spec.rb"]*2
+      
+      m.file  *["components/disabled/sandbox/config.yml"]*2
+      m.file  *["components/disabled/sandbox/sandbox.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
+      # m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'], 
+      #   :shebang => options[:shebang], :collision => :force
     end
   end
 
@@ -69,8 +81,11 @@ EOS
     # Installation skeleton.  Intermediate directories are automatically
     # created so don't sweat their absence here.
     BASEDIRS = %w(
-      components/simon_game/lib
-      components/simon_game/test
+      components/simon_game
+      components/disabled/stomp_gateway
+      components/disabled/sandbox
+      components/ami_remote
+      components/disabled/restful_rpc/spec
       config
     )
-end
+end

data/app_generators/ahn/templates/.ahnrc

@@ -1,5 +1,27 @@
 # Adhearsion Runtime Configuration.
 
+# You can use the "gems" section to force Adhearsion to load a particular version of a gem.
+# This is useful when a component require()s a gem, but you don't want it to use the latest one installed on the system.
+# For example, if a component require()s activerecord, sucking in the latest on the system, and then you enable a Rails app
+# which wants a particular version of activerecord, RubyGems will raise an error saying "you cannot activate two versions of
+# the same gem". Note: specifying the version, source and require names is optional, but you must include a : after the gem name to make it a YAML key/value pair (with a nil value).
+gems:
+#  twitter:
+#  hpricot:
+#  rack:
+#    # require() one library when initializing:
+#    require: rack
+#  memcache-client:
+#    version >= 1.5.2
+#    require:
+#      # require() an Array of libraries when initializing:
+#      - memcache
+#      - memcache_util
+#  activerecord:
+#    version: >= 2.1.0
+#  aasm:
+#    source: http://gems.github.com
+
 paths:
 
   # All paths are relative to this file's directory
@@ -7,6 +29,6 @@ paths:
 
   dialplan: dialplan.rb
 
-  models:
-    directory: models
-    pattern: "*.rb"
+  events: events.rb
+
+  models: models/*.rb

data/app_generators/ahn/templates/Rakefile

@@ -1,3 +1,23 @@
 require 'rubygems'
-require 'adhearsion'
-require 'adhearsion/tasks'
+
+begin
+  require 'adhearsion'
+  require 'adhearsion/tasks'
+rescue LoadError
+  STDERR.puts "\nCannot load Adhearsion! Not all Rake tasks will be loaded!\n\n"
+end
+
+desc "Writes a .gitignore file that ignores certain SCM annoyances such as log files"
+task :gitignore do
+  ignore_file = "#{Dir.pwd}/.gitignore"
+  if File.exists? ignore_file
+    STDERR.puts "File #{ignore_file} already exists!"
+  else
+    File.open ignore_file, 'w' do |file|
+      # Add other files to the Array below
+      %w[ log ].each do |pattern|
+        file.puts pattern
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+methods_for :rpc do
+  
+  # Simply create proxy methods for the high-level AMI methods
+  
+  [:send_action, :introduce, :originate, :call_into_context, :call_and_exec].each do |method_name|
+    define_method(method_name) do |*args|
+      if VoIP::Asterisk.manager_interface
+        VoIP::Asterisk.manager_interface.send(method_name, *args)
+      else
+        ahn_log.ami_remote.error "AMI has not been enabled in startup.rb!"
+      end
+    end
+  end
+  
+end