adhearsion 1.1.1 → 1.2.0

data/.gitignore

@@ -8,3 +8,6 @@ vendor
 Gemfile.lock
 .bundle
 .rvmrc
+coverage
+spec/reports
+doc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/CHANGELOG

@@ -1,3 +1,15 @@
+1.2.0
+ - New method: #play_or_speak allows playback of an audio file with TTS fallback
+ - #input now takes :speak as a hash for TTS prompt or fallback
+ - New method: #speak provides abstracted TTS rendering for UniMRCP and Cepstral
+ - Allow leading "+" in Caller ID (E.164 format)
+ - Allow using --pid-file without "daemon" for JRuby
+ - Allow passing a block to #input to enable caller to detect when enough digits are collected.
+ - Fix some issues with starting apps outside of their directory, generally related to Bundler/gem environments
+ - Allow configuration of logging outputters/formatters
+ - Using ahn_log in a dialplan context or on a call object logs to the call's context, named after its unique identifier
+ - New method: #record_to_file with more useful return values
+
 1.1.1
  - Command#play now returns false if audio failed to play
  - Added new commands (#play!, #interruptible_play!, #input!) which raise PlaybackError if audio fails to play

data/README.markdown

@@ -16,18 +16,9 @@ Adhearsion has...
 * 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).
+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](https://github.com/adhearsion/adhearsion/issues).

data/Rakefile

@@ -2,41 +2,19 @@
 ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin spec).join(File::PATH_SEPARATOR)}"
 
 require 'rubygems'
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
+require 'bundler/setup'
 require 'date'
 require 'adhearsion/version'
 
 task :default => :spec
 task :gem => :build
 
-begin
-  gem 'rspec', '>= 2.3.0'
-  require 'rspec/core/rake_task'
-rescue LoadError
-  abort "You must install RSpec: sudo gem install rspec"
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-RSpec::Core::RakeTask.new do |t|
-end
-
-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.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
+require 'ci/reporter/rake/rspec'
+task :ci => ['ci:setup:rspec', :spec]
 
 begin
   require 'yard'

data/adhearsion.gemspec

@@ -13,48 +13,31 @@ Gem::Specification.new do |s|
   s.description = "Adhearsion is an open-source telephony development framework"
   s.date        = Date.today.to_s
 
-  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.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"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if current_version >= 3 then
-      # Runtime dependencies
-      s.add_runtime_dependency("bundler", [">= 1.0.10"])
-      s.add_runtime_dependency("log4r", [">= 1.0.5"])
-      s.add_runtime_dependency("activesupport", [">= 2.1.0"])
-      # i18n is only strictly a dependency for ActiveSupport >= 3.0.0
-      # Since it doesn't conflict with <3.0.0 we'll require it to be
-      # on the safe side.
-      s.add_runtime_dependency("i18n")
-      s.add_runtime_dependency("rubigen", [">= 1.5.6"])
-      s.add_runtime_dependency("rake")
-      s.add_runtime_dependency("pry")
+  # Runtime dependencies
+  s.add_runtime_dependency "bundler", [">= 1.0.10"]
+  s.add_runtime_dependency "log4r", [">= 1.0.5"]
+  s.add_runtime_dependency "activesupport", [">= 2.1.0"]
+  # i18n is only strictly a dependency for ActiveSupport >= 3.0.0
+  # Since it doesn't conflict with <3.0.0 we'll require it to be
+  # on the safe side.
+  s.add_runtime_dependency "i18n"
+  s.add_runtime_dependency "json"
+  s.add_runtime_dependency "rubigen", [">= 1.5.6"]
+  s.add_runtime_dependency "rake"
+  s.add_runtime_dependency "pry"
 
-      # 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
+  # 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', [">= 2.1.0"]
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'ci_reporter'
 end

data/app_generators/ahn/ahn_generator.rb

@@ -41,15 +41,14 @@ class AhnGenerator < RubiGen::Base
       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/sandbox.yml"]*2
-      m.file  *["components/disabled/sandbox/sandbox.rb"]*2
-
+      m.file  *["config/environment.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.file  *["Gemfile"]*2
+      m.file  *["script/ahn"]*2
 
       # m.dependency "install_rubigen_scripts", [destination_root, 'ahn', 'adhearsion', 'test_spec'],
       #   :shebang => options[:shebang], :collision => :force
@@ -89,9 +88,9 @@ EOS
       components/simon_game
       components/disabled/stomp_gateway
       components/disabled/xmpp_gateway
-      components/disabled/sandbox
       components/ami_remote
       components/disabled/restful_rpc/spec
       config
+      script
     )
 end

data/app_generators/ahn/templates/config/environment.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require

data/app_generators/ahn/templates/config/startup.rb

@@ -1,7 +1,4 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-Bundler.require
+require File.join(File.dirname(__FILE__), 'environment')
 
 Adhearsion::Configuration.configure do |config|
 
@@ -12,7 +9,11 @@ Adhearsion::Configuration.configure do |config|
   # List the gem names here:
   # config.add_component "ahn_test_component"
 
-  # Supported levels (in increasing severity) -- :debug < :info < :warn < :error < :fatal
+  # Log configuration
+  # :level : Supported levels (in increasing severity) -- :debug < :info < :warn < :error < :fatal
+  # :outputters : An array of log outputters to use. The default is to log to stdout and log/adhearsion.log
+  # :formatters : An array of log formatters to apply to the outputters in use
+  # :formatter : A log formatter to apply to all active outputters
   config.logging :level => :info
 
   # Whether incoming calls be automatically answered. Defaults to true.
@@ -32,6 +33,11 @@ Adhearsion::Configuration.configure do |config|
   config.enable_asterisk :argument_delimiter => '|'
   # config.asterisk.enable_ami :host => "127.0.0.1", :username => "admin", :password => "password", :events => true
 
+  # Adhearsion supports two possible speech engines with Asterisk: UniMRCP and Cepstral.
+  # Uncomment one of the below if you have it available.
+  # config.asterisk.speech_engine = :cepstral
+  # config.asterisk.speech_engine = :unimrcp
+
   # config.enable_drb
 
   # Streamlined Rails integration! The first argument should be a relative or absolute path to

data/app_generators/ahn/templates/script/ahn

@@ -0,0 +1,8 @@
+# This command will automatically be run when you run "ahn" with the Adhearsion gem installed from the root of your application.
+
+require File.expand_path('../../config/environment',  __FILE__)
+
+require 'adhearsion'
+require 'adhearsion/commands'
+
+Adhearsion::CLI::AhnCommand.execute!

data/lib/adhearsion/cli.rb

@@ -1,300 +1,7 @@
-require 'fileutils'
+require 'adhearsion/script_ahn_loader'
 
-module Adhearsion
-  module CLI
-    module AhnCommand
-      USAGE = <<USAGE
-Usage:
-   ahn create /path/to/directory
-   ahn start [console|daemon] [/path/to/directory]
-   ahn version|-v|--v|-version|--version
-   ahn help|-h|--h|--help|-help
+# If we are inside an Adhearsion application this method performs an exec and thus
+# the rest of this script is not run.
+Adhearsion::ScriptAhnLoader.exec_script_ahn!
 
-   ahn  enable component COMPONENT_NAME
-   ahn disable component COMPONENT_NAME
-   ahn  create component COMPONENT_NAME
-USAGE
-      class << self
-
-        def execute!
-          CommandHandler.send(*parse_arguments)
-        rescue CommandHandler::CLIException => error
-          fail_and_print_usage error
-        end
-
-        ##
-        # Provides a small abstraction of Kernel::abort().
-        #
-        def fail_and_print_usage(error)
-          Kernel.abort "#{error.message}\n\n#{USAGE}"
-        end
-
-        def parse_arguments(args=ARGV.clone)
-          action = args.shift
-          case action
-          when /^-?-?h(elp)?$/, nil   then [:help]
-          when /^-?-?v(ersion)?$/     then [:version]
-          when "create"
-            [:create, *args]
-          when 'start'
-            pid_file_regexp = /^--pid-file=(.+)$/
-            if args.size > 3
-              raise CommandHandler::CLIException, "Too many arguments supplied!" if args.size > 3
-            elsif args.size == 3
-              raise CommandHandler::CLIException, "Unrecognized final argument #{args.last}" unless args.last =~ pid_file_regexp
-              pid_file = args.pop[pid_file_regexp, 1]
-            else
-              pid_file = nil
-            end
-
-            if args.size == 2
-              path   = args.last
-              if args.first =~ /daemon|console/
-                mode = args.first.to_sym
-              else
-                raise CommandHandler::CLIException, "Invalid start mode requested: #{args.first}"
-              end
-            elsif args.size == 1
-              path, mode = args.first, :foreground
-            else
-              raise CommandHandler::CLIException, "Invalid format for the start CLI command!"
-            end
-            [:start, path, mode, pid_file]
-          when '-'
-            [:start, Dir.pwd]
-          when "enable", "disable"
-            if args.size == 1
-              raise CommandHandler::UnknownCommand, "Must supply an argument for what you wish to #{action}"
-            elsif args.size == 2
-              [action, *args]
-            else
-              raise CommandHandler::UnknownCommand, "Too many arguments supplied!"
-            end
-          else
-            [action, *args]
-          end
-        end
-      end
-
-      module CommandHandler
-        class << self
-
-          def create(*args)
-            if args.size.zero?
-              raise CommandHandler::UnknownCommand.new("Must specify something to create!")
-            elsif args.size == 1
-              # We're creating a project
-              path = args.first
-              require 'rubigen'
-              require 'rubigen/scripts/generate'
-              source = RubiGen::PathSource.new(:application,
-                File.join(File.dirname(__FILE__), "../../app_generators"))
-              RubiGen::Base.reset_sources
-              RubiGen::Base.append_sources source
-              RubiGen::Scripts::Generate.new.run([path], :generator => 'ahn')
-            elsif args.size == 2
-              # We're creating a feature (e.g. a component)
-              feature_type, component_name = args
-
-              if feature_type != "component"
-                # At the moment, only components can be created.
-                raise CommandHandler::UnknownCommand.new("Don't know how to create '#{feature_type}'")
-              end
-
-              if component_name !~ /^[a-z][\w_]+$/
-                raise CommandHandler::ComponentError.new("Component name must be lowercase alphanumeric characters " +
-                    "and begin with a character")
-              end
-
-              app_path = PathString.from_application_subdirectory Dir.pwd
-
-              if app_path.nil?
-                new_component_dir = File.join Dir.pwd, component_name
-              else
-                puts "Adhearsion application detected. Creating new component at components/#{component_name}"
-                new_component_dir = File.join app_path, "components", component_name
-              end
-
-              raise ComponentError.new("Component #{component_name} already exists!") if File.exists?(new_component_dir)
-
-              # Everything's good. Let's create the component
-              Dir.mkdir new_component_dir
-
-              # Initial component code file
-              Dir.mkdir File.join(new_component_dir, "lib")
-              fn = File.join("lib", "#{component_name}.rb")
-              puts "- #{fn}: Initial component code file"
-              File.open(File.join(new_component_dir, fn),"w") do |file|
-                file.puts <<-RUBY
-# See http://docs.adhearsion.com for more information on how to write components or
-# look at the examples in newly-created projects.
-                RUBY
-              end
-
-              # Component configuration
-              Dir.mkdir File.join(new_component_dir, "config")
-              fn = File.join("config", "#{component_name}.yml")
-              puts "- #{fn}: Example component configuration YAML"
-              File.open(File.join(new_component_dir, fn),"w") do |file|
-                file.puts '# You can use this file for component-specific configuration.'
-              end
-
-              # Component example gemspec
-              fn = File.join("#{component_name}.gemspec")
-              puts "- #{fn}: Example component gemspec"
-              File.open(File.join(new_component_dir, fn), "w") do |file|
-                file.puts <<-RUBY
-GEM_FILES = %w{
-  #{component_name}.gemspec
-  lib/#{component_name}.rb
-  config/#{component_name}.yml
-}
-
-Gem::Specification.new do |s|
-  s.name = "#{component_name}"
-  s.version = "0.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Your Name Here!"]
-
-  s.date = Date.today.to_s
-  s.description = "This Adhearsion component gem has not yet been described."
-  s.email = "noreply@example.com"
-
-  s.files = GEM_FILES
-
-  s.has_rdoc = false
-  s.homepage = "http://adhearsion.com"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.2.0"
-  s.summary = "This Adhearsion component gem has no summary."
-
-  s.specification_version = 2
-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'")
-            end
-          end
-
-          def start(path, mode=:foreground, pid_file=nil)
-            raise PathInvalid, path unless File.exists? path + "/.ahnrc"
-            Adhearsion::Initializer.start path, :mode => mode, :pid_file => pid_file
-          end
-
-          def version
-            puts "Adhearsion v#{Adhearsion::VERSION::STRING}"
-          end
-
-          def help
-            puts USAGE
-          end
-
-          def enable(type, name)
-            case type
-              when "component"
-                app_path = PathString.from_application_subdirectory Dir.pwd
-                if app_path
-                  disabled_component_path = File.join app_path, "components", "disabled", name
-                  disabled_components_path = File.join app_path, "components", "disabled"
-                  enabled_component_path  = File.join app_path, "components", name
-                  if File.directory? disabled_component_path
-                    FileUtils.mv disabled_component_path, enabled_component_path
-                    puts "Enabled component #{name}"
-                  elsif File.directory? enabled_component_path
-                    raise ComponentError.new("This component is already enabled.")
-                  elsif !File.directory? disabled_components_path
-                    raise ComponentError.new("There is no components/disabled directory!")
-                  else
-                    raise ComponentError.new("The requested component was not found.")
-                  end
-                else
-                  raise PathInvalid.new(Dir.pwd)
-                end
-              else
-                raise UnknownCommand.new("enable #{type}")
-            end
-          end
-
-          def disable(type, name)
-            case type
-              when "component"
-                app_path = PathString.from_application_subdirectory Dir.pwd
-                if app_path
-                  disabled_dir = File.join app_path, "components", "disabled"
-
-                  disabled_component_path = File.join disabled_dir, name
-                  enabled_component_path  = File.join app_path, "components", name
-
-                  Dir.mkdir disabled_dir unless File.directory?(disabled_dir)
-
-                  if File.directory? enabled_component_path
-                    if File.directory?(disabled_component_path)
-                      raise ComponentError.new("There is already a disabled component at #{disabled_component_path}")
-                    else
-                      FileUtils.mv enabled_component_path, disabled_component_path
-                      puts "Disabled component #{name}"
-                    end
-                  else
-                    raise ComponentError.new("Could not find component #{name} at #{enabled_component_path} !")
-                  end
-                else
-                  raise PathInvalid.new(Dir.pwd)
-                end
-              else
-                raise UnknownCommand.new("disable #{type}")
-            end
-          end
-
-          def method_missing(action, *args)
-            raise UnknownCommand, [action, *args] * " "
-          end
-
-          private
-
-        end
-
-        class CLIException < StandardError; end
-
-        class UnknownCommand < CLIException
-          def initialize(cmd)
-            super "Unknown command: #{cmd}"
-          end
-        end
-
-        class ComponentError < CLIException; end
-
-        class UnknownProject < CLIException
-          def initialize(project)
-            super "Application #{project} does not exist! Have you installed it?"
-          end
-        end
-
-        class PathInvalid < CLIException
-          def initialize(path)
-            super "Directory #{path} does not belong to an Adhearsion project!"
-          end
-        end
-      end
-    end
-  end
-end
+require 'adhearsion/commands'