adhearsion 1.2.6 → 2.0.0.alpha1

data/adhearsion.gemspec

@@ -4,7 +4,7 @@ require "adhearsion/version"
 
 Gem::Specification.new do |s|
   s.name        = "adhearsion"
-  s.version     = Adhearsion::VERSION::STRING
+  s.version     = Adhearsion::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jay Phillips", "Jason Goecke", "Ben Klang", "Ben Langfeld"]
   s.email       = "dev&Adhearsion.com"
@@ -20,23 +20,37 @@ Gem::Specification.new do |s|
 
   # 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"]
+  s.add_runtime_dependency 'punchblock', [">= 0.8.3"]
+  s.add_runtime_dependency "logging", [">= 1.6.1"]
+  s.add_runtime_dependency "loquacious", [">= 1.9.0"]
+  s.add_runtime_dependency "activesupport", [">= 3.0.10"]
   # 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 "i18n", ">= 0.5.0"
   s.add_runtime_dependency "json"
   s.add_runtime_dependency "thor"
   s.add_runtime_dependency "rake"
   s.add_runtime_dependency "pry"
+  s.add_runtime_dependency "uuid"
+  s.add_runtime_dependency "future-resource", [">= 0.0.2"]
+  s.add_runtime_dependency "ruby_speech", [">= 0.4.0"]
+  s.add_runtime_dependency 'countdownlatch'
+  s.add_runtime_dependency 'has-guarded-handlers', [">= 0.1.1"]
+  s.add_runtime_dependency 'girl_friday'
+  s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
 
   # Development dependencies
-  s.add_development_dependency 'rspec', [">= 2.4.0", '< 2.8.0']
+  s.add_development_dependency 'rspec', ["~> 2.7.0"]
   s.add_development_dependency 'flexmock'
-  s.add_development_dependency 'activerecord', [">= 2.1.0"]
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'activerecord', [">= 3.0.10"]
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'
   s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'guard-cucumber'
+  s.add_development_dependency 'ruby_gntp'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
 end

data/bin/ahn

@@ -22,6 +22,8 @@
 $:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
 
 require 'rubygems'
+require 'bundler/setup'
+require 'adhearsion'
 require 'adhearsion/cli'
 
-Adhearsion::CLI::AhnCommand.execute!
+Adhearsion::CLI::AhnCommand.start

data/cucumber.yml

@@ -0,0 +1,4 @@
+default: --tags ~@wip
+wip: --wip --tags @wip
+cli: --tags @cli
+guard: --format pretty --strict --tags ~@wip

data/features/app_generator.feature

@@ -0,0 +1,42 @@
+Feature: Adhearsion App Generator
+  In order to do development on new Adhearsion apps
+  As a Adhearsiohn developer
+  I want to generate an Adhearsion app
+
+  Scenario: Generate application with valid layout
+    When I run `ahn create path/somewhere`
+    And I cd to "path/somewhere"
+    Then the following directories should exist:
+      | lib                   |
+      | config                |
+      | script                |
+
+    And the following files should exist:
+      | config/adhearsion.rb  |
+      | config/environment.rb |
+      | Gemfile               |
+      | lib/simon_game.rb     |
+      | script/ahn            |
+      | README.md             |
+      | Rakefile              |
+
+    And the file "config/adhearsion.rb" should contain each of these content parts:
+    """
+    Adhearsion.router
+    Adhearsion.config
+    logging.level
+    config.punchblock
+    """
+    And the file "README.md" should contain each of these content parts:
+    """
+    Start your new app with
+    AGI(agi
+    """
+    And the file "Rakefile" should contain "adhearsion/tasks"
+    And the file "Gemfile" should contain each of these content parts:
+    """
+    source :rubygems
+    gem 'adhearsion-asterisk'
+    """
+    And the file "lib/simon_game.rb" should contain "class SimonGame"
+    And the file "script/ahn" should contain "require 'adhearsion'"

data/features/cli.feature

@@ -0,0 +1,108 @@
+Feature: Adhearsion Ahn CLI
+  As a Adhearsion user
+  I want a cli command (ahn)
+  So that I can create and interact with adhearsion apps
+
+  Scenario: No arguments given
+    When I run `ahn`
+    Then I should see the usage message
+    And the exit status should be 0
+
+  Scenario: Unrecognized commands
+    When I run `ahn alpha beta`
+    Then the output should contain:
+    """
+    Unknown command: alpha beta
+    """
+    And the exit status should be 1
+
+  Scenario: Command create with correct arguments
+    When I run `ahn create path/somewhere`
+    And I cd to "path/somewhere"
+    Then the following files should exist:
+      | Gemfile               |
+      | README.md             |
+      | Rakefile              |
+      | config/adhearsion.rb  |
+      | config/environment.rb |
+    And the file "config/adhearsion.rb" should contain "Adhearsion.router"
+    Then the exit status should be 0
+
+  Scenario: Running create with no arguments
+    When I run `ahn create`
+    Then the output should contain:
+    """
+    "create" was called incorrectly. Call as "ahn create /path/to/directory".
+    """
+    And the exit status should be 1
+
+  Scenario: Command start with no path outside of the app directory
+    When I run `ahn start`
+    Then the output should contain:
+    """
+    A valid path is required for start, unless run from an Adhearson app directory
+    """
+    And the exit status should be 1
+
+  Scenario: Command start with no path inside of the app directory
+    Given that I create a valid app under "path/somewhere"
+    When I cd to "path/somewhere"
+    And I run `ahn start` interactively
+    And I wait for output to contain "Transitioning from booting to running"
+    And I terminate the interactive process
+    Then the output should contain "Loaded config"
+    And the output should contain "Adhearsion::Console: Starting up..."
+    And the output should contain "AHN>"
+    And the output should contain "Starting connection"
+    And the output should contain "Transitioning from running to stopping"
+
+  Scenario: Command start with only path works properly
+    Given that I create a valid app under "path/somewhere"
+    When I run `ahn start path/somewhere` interactively
+    And I wait for output to contain "Transitioning from booting to running"
+    And I terminate the interactive process
+    Then the output should contain "Loaded config"
+    And the output should contain "Adhearsion::Console: Starting up..."
+    And the output should contain "AHN>"
+    And the output should contain "Starting connection"
+    And the output should contain "Transitioning from running to stopping"
+
+  Scenario: Command daemon with path works correctly
+    Given JRuby skip test
+    Given that I create a valid app under "path/somewhere"
+    When I run `ahn daemon path/somewhere`
+    And I cd to "path/somewhere"
+    And I terminate the process using the pid file "adhearsion.pid"
+    Then the output should contain "Daemonizing now"
+    And the exit status should be 0
+
+  Scenario: Command start with daemon and pid option
+    Given JRuby skip test
+    Given that I create a valid app under "path/somewhere"
+    When I run `ahn daemon path/somewhere --pid-file=ahn.pid`
+    And I cd to "path/somewhere"
+    And I terminate the process using the pid file "ahn.pid"
+    Then the output should contain "Daemonizing now"
+
+  Scenario: Command stop with valid path and pid option
+    Given JRuby skip test
+    Given that I create a valid app under "path/somewhere"
+    When I run `ahn daemon path/somewhere --pid-file=ahn.pid`
+    And I run `ahn stop path/somewhere --pid-file=ahn.pid`
+    Then the output should contain:
+    """
+    Stopping Adhearsion
+    """
+
+  Scenario: Command version should print the version
+    When I run `ahn version`
+    Then the output should contain:
+    """
+    Adhearsion v
+    """
+    And the exit status should be 0
+
+  Scenario: Command help
+    When I run `ahn help`
+    Then I should see the usage message
+    And the exit status should be 0

data/features/step_definitions/app_generator_steps.rb

@@ -0,0 +1,6 @@
+Then /^the file "([^"]*)" should contain each of these content parts:$/ do |file, content_parts|
+  parts = content_parts.split
+  parts.each do |p|
+    steps %Q{Then the file "#{file}" should contain "#{p}"}
+  end
+end

data/features/step_definitions/cli_steps.rb

@@ -0,0 +1,74 @@
+require 'timeout'
+
+Then /^I should see the usage message$/ do
+  steps %Q{
+    Then the output should contain "Tasks:"
+    Then the output should contain "ahn create"
+    Then the output should contain "ahn start"
+    Then the output should contain "ahn daemon"
+    Then the output should contain "ahn version"
+    Then the output should contain "ahn help"
+  }
+end
+
+# TODO: Remove after pull request is merged in cucumber.rb from Aruba
+When /^I terminate the interactive process$/ do
+  terminate_processes!
+end
+
+When /^I wait (\d+) seconds?$/ do |arg1|
+  sleep arg1.to_i
+end
+
+# TODO: Remove after pull request is merged in cucumber.rb from Aruba
+When /^I wait for (?:output|stdout) to contain "([^"]*)"$/ do |expected|
+  Timeout::timeout(exit_timeout) do
+    loop do
+      break if assert_partial_output_interactive(expected)
+      sleep 0.1
+    end
+  end
+end
+
+Given /^that I create a valid app under "([^"]*)"$/ do |path|
+  steps %Q{
+    When I run `ahn create #{path}`
+    Then there should be a valid adhearsion directory named "#{path}"
+  }
+end
+
+Then /^there should be a valid adhearsion directory named "([^"]*)"$/ do |path|
+  steps %Q{
+    Then a directory named "#{path}" should exist
+  }
+
+  cd(path)
+  steps %Q{
+    Then the following directories should exist:
+      | lib |
+      | config |
+    Then the following files should exist:
+      | Gemfile |
+      | README.md |
+      | Rakefile |
+      | config/adhearsion.rb |
+      | config/environment.rb |
+  }
+
+  ## NOTE: Aruba's cd method is not really changing directories
+  ## Either we use cd or we need absolute path... could not figure out cleaner
+  ## way to get back to previous dir.
+  dotsback=1.upto(path.split(File::SEPARATOR)[0..-1].count).collect {|x| ".."}.join(File::SEPARATOR)
+  dotsback.shift if dotsback[0].is_a?(String) and dotsback[0].empty?
+  cd(dotsback)
+end
+
+When /^I terminate the process using the pid file "([^"]*)"$/ do |pidfile|
+  check_file_presence([pidfile], true)
+  prep_for_fs_check do
+    pid = File.read(pidfile).to_i
+    Process.kill("TERM", pid)
+    sleep 1
+    Process.kill("KILL", pid)
+  end
+end

data/features/support/aruba_helper.rb

@@ -0,0 +1,22 @@
+module Aruba
+  module Api
+    # output() blocks for stderr and stdout it seems
+    def assert_partial_output_interactive(expected)
+      unescape(_read_interactive).include?(unescape(expected)) ? true : false
+    end
+
+    def _read_interactive
+      @interactive.read_stdout(@aruba_keep_ansi)
+    end
+  end
+
+  class Process
+    def read_stdout(keep_ansi)
+      wait_for_io do
+        @process.io.stdout.flush
+        content = filter_ansi(open(@out.path).read, keep_ansi)
+      end
+    end
+  end
+end
+

data/features/support/env.rb

@@ -0,0 +1,37 @@
+require 'simplecov'
+require 'simplecov-rcov'
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+     SimpleCov::Formatter::HTMLFormatter.new.format(result)
+     SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "/vendor/"
+end
+
+JRUBY_OPTS_SAVED=ENV['JRUBY_OPTS']
+JAVA_OPTS_SAVED=ENV['JAVA_OPTS']
+
+require 'cucumber'
+require 'aruba/cucumber'
+require 'adhearsion'
+
+Before do
+  @aruba_timeout_seconds = ENV['ARUBA_TIMEOUT'] || RUBY_PLATFORM == 'java' ? 60 : 30
+end
+
+# TODO: check for name space / run issues
+# NOTE: this will not stop a forked process (eg. daemon mode)
+After do
+  terminate_processes!
+end
+
+# Aruba upstream overwrites these variables so set them here until it is fixed.
+Aruba.configure do |config|
+  config.before_cmd do |cmd|
+    set_env('JRUBY_OPTS', "#{ENV['JRUBY_OPTS']} #{JRUBY_OPTS_SAVED}")
+    set_env('JAVA_OPTS', "#{ENV['JAVA_OPTS']} #{JAVA_OPTS_SAVED}")
+  end
+end if RUBY_PLATFORM == 'java'

data/features/support/utils.rb

@@ -0,0 +1,8 @@
+Given /^PENDING/ do
+  pending
+end
+
+
+Given /^JRuby skip test/ do
+  pending "Daemonize not supported under JRuby" if RUBY_PLATFORM == 'java'
+end

data/lib/adhearsion.rb

@@ -1,46 +1,90 @@
-# Check the Ruby version
-STDERR.puts "WARNING: You are running Adhearsion in an unsupported
-version of Ruby (Ruby #{RUBY_VERSION} #{RUBY_RELEASE_DATE})!
-Please upgrade to at least Ruby v1.8.5." if RUBY_VERSION < "1.8.5"
-
-$: << File.expand_path(File.dirname(__FILE__))
-
-require 'rubygems'
-require 'bundler/setup'
-
-require 'adhearsion/version'
-require 'adhearsion/voip/call'
-require 'adhearsion/voip/dial_plan'
-require 'adhearsion/voip/asterisk/special_dial_plan_managers'
-require 'adhearsion/foundation/all'
-require 'adhearsion/events_support'
-require 'adhearsion/logging'
-require 'adhearsion/component_manager'
-require 'adhearsion/initializer/configuration'
-require 'adhearsion/initializer'
-require 'adhearsion/voip/dsl/numerical_string'
-require 'adhearsion/voip/dsl/dialplan/parser'
-require 'adhearsion/voip/commands'
-require 'adhearsion/voip/asterisk/commands'
-require 'adhearsion/voip/dsl/dialing_dsl'
-require 'adhearsion/voip/call_routing'
-
-begin
-  # Try ActiveSupport >= 2.3.0
-  require 'active_support/all'
-rescue LoadError
-  # Assume ActiveSupport < 2.3.0
-  require 'active_support'
-end
+abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby #{RUBY_VERSION} #{RUBY_RELEASE_DATE})! Please upgrade to at least Ruby v1.9.2, JRuby 1.6.5 or Rubinius 2.0." if RUBY_VERSION < "1.9.2"
+
+%w{
+  bundler/setup
+
+  active_support/all
+  uuid
+  future-resource
+  punchblock
+  ostruct
+  ruby_speech
+  countdownlatch
+  has_guarded_handlers
+  girl_friday
+  loquacious
+
+  adhearsion/foundation/all
+}.each { |f| require f }
 
 module Adhearsion
-  # Sets up the Gem require path.
-  AHN_INSTALL_DIR = File.expand_path(File.dirname(__FILE__) + "/..")
-  AHN_CONFIG = Configuration.new
+  extend ActiveSupport::Autoload
+
+  autoload :Process
+  autoload :Call
+  autoload :CallController
+  autoload :Calls
+  autoload :Configuration
+  autoload :Console
+  autoload :Conveniences
+  autoload :DialplanController
+  autoload :Dispatcher
+  autoload :Events
+  autoload :MenuDSL
+  autoload :Initializer
+  autoload :Logging
+  autoload :OutboundCall
+  autoload :Plugin
+  autoload :Router
+  autoload :Version
+
+  class << self
+
+    def ahn_root=(path)
+      Adhearsion.config[:platform].root = path.nil? ? nil : File.expand_path(path)
+    end
+
+    def config(&block)
+      @config ||= initialize_config
+      block_given? and yield @config
+      @config
+    end
+
+    def initialize_config
+      _config = Configuration.new
+      env = ENV['AHN_ENV']
+      env = nil unless _config.valid_environment? env
+      _config.platform.environment = env if env
+      _config
+    end
+
+    def environments
+      config.valid_environments
+    end
+
+    def config=(config)
+      @config = config
+    end
+
+    def router(&block)
+      @router ||= Router.new(&block || Proc.new {})
+    end
+
+    def router=(other)
+      @router = other
+    end
+
+    def active_calls
+      @calls ||= Calls.new
+    end
 
-  ##
-  # This Array holds all the Threads whose life matters. Adhearsion will not exit until all of these have died.
-  #
-  IMPORTANT_THREADS = []
+    def status
+      Adhearsion::Process.state_name
+    end
+  end
 
+  Hangup             = Class.new StandardError # At the moment, we'll just use this to end a call-handling Thread
+  PlaybackError      = Class.new StandardError # Represents failure to play audio, such as when the sound file cannot be found
+  RecordError        = Class.new StandardError # Represents failure to record such as when a file cannot be written.
+  ConfigurationError = Class.new StandardError # Error raised while trying to configure a non existent plugin
 end