adhearsion 1.0.1 → 1.0.2

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+pkg
+*~
+.*.sw?
+.yardoc
+nbproject
+vendor
+Gemfile.lock
+.bundle
+.rvmrc

data/CHANGELOG

@@ -1,3 +1,10 @@
+1.0.2
+ - Fix rcov Rake task
+ - Add Ben Langfeld as an author (Thanks, Ben!)
+ - Add "rake" as a runtime dependency
+ - Remove usage of BEGIN blocks (for Rubinius; CS)
+ - Improve component testing generators
+
 1.0.1
  NOTE for Ruby 1.9 users: The behavior of Ruby 1.9 and case statements has changed
       in a way that renders NumericalString objects incompatible with
@@ -29,6 +36,7 @@
  - New components now include RubyGems skeleton files
  - Fix support for setting Caller ID name on AGI dial() command
  - Generate new apps with Bundler support, including auto-requiring of all gems
+ - Update component testing framework to RSpec 2.x and mock with rspec
 
 1.0.0
  - Fall back to using Asterisk's context if the AGI URI context is not found

data/README.markdown

@@ -0,0 +1,33 @@
+Adhearsion
+==========
+
+Adhearsion is an open-source voice application development framework. Adhearsion users write applications atop the framework with Ruby and **call into their code**.
+
+Adhearsion rests above a lower-level telephony platform, namely [Asterisk](http://asterisk.org), and provides a framework for integrating with various resources, such as SQL, LDAP and XMPP (Jabber).
+
+Adhearsion has...
+
+* An elegant dialplan system for writing the code which controls a live phone call
+* A sophisticated Asterisk Manager Interface library with a lexer written in [Ragel](http://www.complang.org/ragel).
+* An events subsystem which maintains a Thread-pool for executing your namespaced callbacks. (supports AMI events too!)
+* A very useful component architecture with which you may write Adhearsion plugins and share them with the world via RubyGems.
+* JRuby compatibility for running atop the Java Virtual Machine and using virtually any Java library.
+* Ability to re-use existing Ruby on Rails database models with ActiveRecord/ActiveLDAP
+* Easy interactive communication via XMPP instant messages using the Blather library
+* Good regression test coverage
+
+Use the public Adhearsion sandbox!
+==================================
+
+Don't want to screw with setting up a telephony system? You can test your Adhearsion applications using our public sandbox!
+
+Visit [http://adhearsion.com/getting_started](http://adhearsion.com/getting_started) for more information!
+
+Yes, in minutes you can be controlling your cell phone for free!  :)
+
+Documentation
+=============
+
+Visit [Adhearsion's website](http://adhearsion.com) for code examples and more information about the project.  Also checkout the [Adhearsion wiki on Github](http://github.com/adhearsion/adhearsion/wiki) for community documentation.
+
+If you're having trouble, you may want to try asking your question on the IRC channel (#adhearsion on irc.freenode.net), [mailing list](http://groups.google.com/group/adhearsion) or, if you've found a bug, report it on the [bug tracker](http://adhearsion.lighthouseapp.com/projects/5871-adhearsion/overview).

data/Rakefile

@@ -1,11 +1,14 @@
 # -*- ruby -*-
-ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
+ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin spec).join(File::PATH_SEPARATOR)}"
 
 require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks
-require 'rake/testtask'
 require 'date'
+require 'adhearsion/version'
+
+task :default => :spec
+task :gem => :build
 
 begin
   gem 'rspec', '>= 2.3.0'
@@ -14,59 +17,41 @@ 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"
+RSpec::Core::RakeTask.new do |t|
 end
 
-require 'adhearsion/version'
-
-AHN_TESTS     = ['spec/**/test_*.rb']
-#AHN_TESTS     = ['spec/test_ahn_command.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'
+desc "Run all RSpecs for Theatre"
+RSpec::Core::RakeTask.new(:theatre_specs) do |t|
+  t.pattern = 'theatre-spec/**/*_spec.rb'
+end
 
 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]
+    t.libs       << "spec"
+    t.test_files  = Dir['spec/**/*_spec.rb']
+    t.output_dir  = 'coverage'
+    t.verbose     = true
+    t.rcov_opts.concat %w[--sort coverage --sort-reverse -x gems -x /var]
   end
 rescue LoadError
   STDERR.puts "Could not load rcov tasks -- rcov does not appear to be installed. Continuing anyway."
 end
 
-task :gem => :build
-
-# YARD::Rake::YardocTask.new do |t|
-#   t.files   = ['lib/**/*.rb']   # optional
-#   # t.options = ['--any', '--extra', '--opts'] # optional
-# end
-
-#Rake::TestTask.new('spec') do |t|
-#  t.libs << File.dirname(__FILE__)
-#  t.verbose = true
-#  t.pattern = AHN_TESTS
-#end
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = AHN_TESTS
+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
 
-task :default => :spec
-
 desc "Check Ragel version"
 task :check_ragel_version do
-  ragel_version_match = `ragel --version`.match(/(\d)\.(\d)+/)
+  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 }
+  big, small = ragel_version_match.captures.map &: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
@@ -78,10 +63,12 @@ task :check_ragel_version do
   end
 end
 
+RAGEL_FILES = %w[lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rl.rb]
+
 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")
+    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
@@ -97,37 +84,10 @@ task :visualize_ragel => :check_ragel_version do
   end
 end
 
-desc "Run all RSpecs for Theatre"
-RSpec::Core::RakeTask.new(:theatre_specs) do |t|
-  t.pattern = 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')
+  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."

data/adhearsion.gemspec

@@ -3,143 +3,25 @@ $:.push File.expand_path("../lib", __FILE__)
 require "adhearsion/version"
 
 Gem::Specification.new do |s|
-  s.name = "adhearsion"
-  s.version = Adhearsion::VERSION::STRING
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jay Phillips", "Jason Goecke", "Ben Klang"]
-
-  s.date = Date.today.to_s
+  s.name        = "adhearsion"
+  s.version     = Adhearsion::VERSION::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jay Phillips", "Jason Goecke", "Ben Klang", "Ben Langfeld"]
+  s.email       = "dev&Adhearsion.com"
+  s.homepage    = "http://adhearsion.com"
+  s.summary     = "Adhearsion, open-source telephony development framework"
   s.description = "Adhearsion is an open-source telephony development framework"
-  s.email = "dev&Adhearsion.com"
-  s.executables = ["ahn", "ahnctl", "jahn"]
+  s.date        = Date.today.to_s
 
-  s.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/stomp_gateway.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/disabled/sandbox/sandbox.rb
-    app_generators/ahn/templates/components/disabled/sandbox/sandbox.yml
-    app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.yml
-    app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb
-    app_generators/ahn/templates/components/disabled/restful_rpc/README.markdown
-    app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.rb
-    app_generators/ahn/templates/components/disabled/restful_rpc/spec/restful_rpc_spec.rb
-    app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.rb
-    app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.yml
-    app_generators/ahn/templates/components/disabled/xmpp_gateway/README.markdown
-    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/Gemfile
-    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/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/ldap.rb
-    lib/adhearsion/initializer/drb.rb
-    lib/adhearsion/initializer/freeswitch.rb
-    lib/adhearsion/initializer/rails.rb
-    lib/adhearsion/initializer/xmpp.rb
-    lib/adhearsion/logging.rb
-    lib/adhearsion/tasks.rb
-    lib/adhearsion/tasks/components.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/adhearsion/xmpp/connection.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
-    Gemfile
-  }
+  s.rubyforge_project         = "adhearsion"
+  s.rubygems_version          = "1.2.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
-  s.has_rdoc = true
-  s.homepage = "http://adhearsion.com"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubyforge_project = "adhearsion"
-  s.rubygems_version = "1.2.0"
-  s.summary = "Adhearsion, open-source telephony development framework"
+  s.has_rdoc      = true
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -155,20 +37,24 @@ Gem::Specification.new do |s|
       # on the safe side.
       s.add_runtime_dependency("i18n")
       s.add_runtime_dependency("rubigen", [">= 1.5.6"])
+      s.add_runtime_dependency("rake")
 
       # Development dependencies
       s.add_development_dependency('rubigen', [">= 1.5.6"])
       s.add_development_dependency('rspec', [">= 2.4.0"])
       s.add_development_dependency('flexmock')
       s.add_development_dependency('activerecord')
+      s.add_development_dependency('rake')
     else
       s.add_dependency("bundler", [">= 1.0.10"])
       s.add_dependency("log4r", [">= 1.0.5"])
       s.add_dependency("activesupport", [">= 2.1.0"])
+      s.add_dependency("rake")
     end
   else
     s.add_dependency("bundler", [">= 1.0.10"])
     s.add_dependency("log4r", [">= 1.0.5"])
     s.add_dependency("activesupport", [">= 2.1.0"])
+    s.add_dependency("rake")
   end
 end

data/app_generators/ahn/templates/Gemfile

@@ -1,7 +1,3 @@
 source "http://rubygems.org"
 
-gem "rake"
-gem "rubigen", ">= 1.0.6"
-gem "log4r", ">= 1.0.5"
-gem "activesupport", ">= 2.1.0"
 gem "adhearsion", ">= 1.0.1"

data/app_generators/ahn/templates/components/disabled/restful_rpc/spec/restful_rpc_spec.rb

@@ -1,17 +1,7 @@
-unless defined? Adhearsion
-  if File.exists? File.dirname(__FILE__) + "/../../../adhearsion/lib/adhearsion.rb"
-    # If you wish to freeze a copy of Adhearsion to this app, simply place a copy of Adhearsion
-    # into a folder named "adhearsion" within this app's main directory.
-    require File.dirname(__FILE__) + "/../../../adhearsion/lib/adhearsion.rb"
-  elsif File.exists? File.dirname(__FILE__) + "/../../../../../../lib/adhearsion.rb"
-    # This file may be ran from the within the Adhearsion framework code (before a project has been generated)
-    require File.dirname(__FILE__) + "/../../../../../../lib/adhearsion.rb"
-  else
-    require 'rubygems'
-    gem 'adhearsion', '>= 0.7.999'
-    require 'adhearsion'
-  end
-end
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
 
 require 'adhearsion/component_manager/spec_framework'
 
@@ -47,8 +37,6 @@ RESTFUL_RPC = ComponentTester.new("restful_rpc", File.dirname(__FILE__) + "/../.
 # "SERVER_PROTOCOL"      => "HTTP/1.1",
 # "SERVER_SOFTWARE"      => "WEBrick/1.3.1 (Ruby/1.8.6/2008-03-03)"}
 
-
-
 describe "The VALID_IP_ADDRESS regular expression" do
 
   it "should match only valid IP addresses" do

data/lib/adhearsion/cli.rb

@@ -169,6 +169,23 @@ Gem::Specification.new do |s|
 end
                 RUBY
               end
+
+              # Component example spec
+              Dir.mkdir File.join(new_component_dir, "spec")
+              fn = File.join("spec", "#{component_name}_spec.rb")
+              puts "- #{fn}: Example component spec"
+              File.open(File.join(new_component_dir, fn), "w") do |file|
+                file.puts <<-RUBY
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'adhearsion/component_manager/spec_framework'
+
+component_name.upcase = ComponentTester.new("#{component_name}", File.dirname(__FILE__) + "/../..")
+                RUBY
+              end
               puts "Created blank component '#{component_name}' at #{new_component_dir}"
             else
               raise CommandHandler::UnknownCommand.new("Provided too many arguments to 'create'")