adhearsion 2.6.4 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12846db5416ee9cd8650e5b5c79f49feff15a594
-  data.tar.gz: 1d7ded9c961eddba674c21cc6719369dda6cf4de
+  metadata.gz: d7c56e8ead6437f2554eea0fba508eaea1971133
+  data.tar.gz: 00795ee77e30cfb4ec49e5214c6a84cd82ac164f
 SHA512:
-  metadata.gz: aeb3d7c2323bea5277ba08249b1be74fe3e35db5bebcb8f200ab80881ad679cef819bb18ba99ae180d68b0ccfe978918129f8f6c742b309c97113e5d00e26a07
-  data.tar.gz: 06e41a0c792c651c70dbf7562c4aa2237a9c9f58a312dad6b1c72128b8cb400502e0a316b00b4c0029b10beb2931a886037d1c8cc2aefe9e8e3840096ac1ca41
+  metadata.gz: 65d347d4f9141f0e99643c69b8df7e0d2008ca6ac51fa936641ffa27b9e848defe7435f45482593b12b21020677fa46707b4b4b9a259ee02d27c6d78d8b21944
+  data.tar.gz: fd7ae40b068100dfeab3b2ddc5aa22cec816076bb30ac719800eddd8b558fa227b401e1cb7f47c00c5054eb25a1f6593624759ba747bdbca78434e3029be4033

data/.travis.yml

@@ -1,18 +1,15 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby
-  - rbx-2.1.1
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+  - jruby-9.0.0.0.pre2
   - ruby-head
 jdk:
   - openjdk7 # for jruby
 before_script: export JRUBY_OPTS="--server -J-Xss1024k -J-Xmx652m -J-XX:+UseConcMarkSweepGC"
 matrix:
   allow_failures:
-    - rvm: rbx-2.1.1
     - rvm: ruby-head
-env: ARUBA_TIMEOUT=120 RAILS_ENV=development AHN_ENV=development
-notifications:
-  irc: "irc.freenode.org#adhearsion"
+env: ARUBA_TIMEOUT=120 AHN_ENV=development
+sudo: false

data/CHANGELOG.md

@@ -1,13 +1,28 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
-# [2.6.3](https://github.com/adhearsion/adhearsion/compare/v2.6.3...v2.6.4) - [2017-01-14](https://rubygems.org/gems/adhearsion/versions/2.6.4)
-  * Bugfix: Upgrade logging gem for compat with other libraries' dependencies  [#619](https://github.com/adhearsion/adhearsion/pull/#619).
-
-# [2.6.3](https://github.com/adhearsion/adhearsion/compare/v2.6.2...v2.6.3) - [2017-01-14](https://rubygems.org/gems/adhearsion/versions/2.6.3)
-  * Feature: CallController execution does not continue after hangup during play, speak, record or ask  [#614](https://github.com/adhearsion/adhearsion/pull/#614).
-
-# [2.6.2](https://github.com/adhearsion/adhearsion/compare/v2.6.1...v2.6.2) - [2015-06-16](https://rubygems.org/gems/adhearsion/versions/2.6.2)
+# [3.0.0.beta1](https://github.com/adhearsion/adhearsion/compare/v2.6.1...v3.0.0.beta1) - [2015-06-24](https://rubygems.org/gems/adhearsion/versions/3.0.0.beta1)
+  * Change: Removed `Adhearsion.ahn_root=` which was deprecated in favour of `Adhearsion.root=`
+  * Change: Remove integration with `RAILS_ENV`
+  * Change: Merge `#dial_and_confirm` into `#dial` such that `#dial` has parallel confirmation behaviour. Remove the old broken confirmation behaviour.
+  * Merge adhearsion-asr in to core to replace the original `#menu` and `#ask` methods
+  * Change: Removed `#interruptible_play` and `#stream_file`, both leftovers from Adhearsion 1.x which are replaced by `#ask`
   * Bugfix: Properly load application bundle. This requires the spawning removed in [#534](https://github.com/adhearsion/adhearsion/pull/534).
+  * Change: Removed daemonisation (`ahn daemon`, `ahn stop`, `ahn restart`, PID files) and persistent logging in favour of 12factor compliant deployment, which pushes these responsibilities up to a process manager or PaaS
+  * Change: Merge Punchblock into Adhearsion core
+    * `Punchblock::Event::*` becomes `Adhearsion::Event`
+    * `Punchblock::Component::*` and `Punchblock::Command::*` become `Adhearsion::Rayo::Component::*` and `Adhearsion::Rayo::Command::*` respectively
+    * `Adhearsion::Events.punchblock` callback becomes `Adhearsion::Events.rayo`
+    * `config.punchblock.*` becomes `config.platform.*`
+    * No longer any dependency on Punchblock, or any mention of that name
+  * Change: No longer supporting FreeSWITCH via IES (Rayo only) or Asterisk < 11
+  * Change: Ruby 1.9 is no longer supported. Minimum supported versions are Ruby 2.2.0 and JRuby 9.0.0.0
+  * Change: Rename "platform" to "core" relating to the config system, because "platform" is overloaded. Settings are now `config.core.*` or `AHN_CORE_*`.
+  * Change: Permit application environment to be set only by AHN_ENV. The config system depends on the environment, and the previous dependency was circular.
+  * Feature: Add i18n support via `CallController#t`
+  * Feature: Integrate a Rack-based HTTP server from the Virginia plugin
+  * Feature: Permit timing out when calling `Call#wait_for_end`
+  * Upgrade to Celluloid 0.16
+  * Move events system to Celluloid and do away with GirlFriday
 
 # [2.6.1](https://github.com/adhearsion/adhearsion/compare/v2.6.0...v2.6.1) - [2015-06-15](https://rubygems.org/gems/adhearsion/versions/2.6.1)
   * Bugfix: Improve Call initialization performance. Use an ActorProxy (subclass) instead of a method_missing definition on every Call.new. This considerably improves Call.new performance; benchmarks show approximately a 30-40% improvement: https://gist.github.com/kares/3576e272250204eb66d1

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'sinatra', require: nil

data/README.markdown

@@ -9,7 +9,7 @@
 
 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, for example [Asterisk](http://asterisk.org), [FreeSWTICH](http://freeswitch.org) or [Voxeo PRISM](http://voxeolabs.com/prism/), and provides a framework for integrating with various resources, such as SQL, LDAP and XMPP (Jabber).
+Adhearsion rests above a lower-level telephony platform, for example [Asterisk](http://asterisk.org), [FreeSWITCH](http://freeswitch.org) or [Voxeo PRISM](http://voxeolabs.com/prism/), and provides a framework for integrating with various resources, such as SQL, LDAP and XMPP (Jabber).
 
 ## Features
 
@@ -24,15 +24,14 @@ Adhearsion rests above a lower-level telephony platform, for example [Asterisk](
 
 ## Requirements
 
-* Ruby 1.9.3+ or JRuby 1.7.0+
+* Ruby 2.2.0+ or JRuby 9.0.0.0+
 * [ruby_speech dependencies](https://github.com/benlangfeld/ruby_speech#dependencies)
 * A VoIP platform:
-  * Asterisk 1.8+
-  * FreeSWITCH
+  * Asterisk 11+
   * A Rayo server (Prism 11+ with rayo-server, or FreeSWITCH with mod_rayo)
 * An interest in building cool new things
 
-**Ruby 1.9.2 is no longer supported by Adhearsion or the Ruby core team. You should upgrade to Ruby 1.9.3 or Ruby 2 as a matter of urgency in order to continue receiving security fixes.**
+**Ruby 1.9 is no longer supported by Adhearsion or the Ruby core team. You should upgrade to Ruby 2.2 as a matter of urgency in order to continue receiving security fixes.**
 
 ## Install
 

data/Rakefile

@@ -14,7 +14,6 @@ end
 require 'cucumber'
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = %w{--tags ~@skip_jruby} if defined?(JRUBY_VERSION)
 end
 
 Cucumber::Rake::Task.new(:wip) do |t|
@@ -31,7 +30,7 @@ rescue LoadError
 end
 
 task :stats do
-  system 'scripts/cloc-1.64.pl . --exclude-dir=.git,vendor,coverage,doc,scripts,tmp,.bundle,pkg'
+  system 'doc/cloc-1.55.pl . --exclude-dir=.git,vendor,coverage,doc'
 end
 
 task :encodeify do

data/adhearsion.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.2.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -23,26 +23,37 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'activesupport', [">= 3.0.0", "< 5.0.0"]
   s.add_runtime_dependency 'adhearsion-loquacious', ["~> 1.9"]
+  s.add_runtime_dependency 'blather', ["~> 1.0"]
   s.add_runtime_dependency 'bundler', ["~> 1.0"]
-  s.add_runtime_dependency 'celluloid', ["~> 0.14"]
+  s.add_runtime_dependency 'celluloid', ["~> 0.16"]
   s.add_runtime_dependency 'countdownlatch'
   s.add_runtime_dependency 'deep_merge'
   s.add_runtime_dependency 'ffi', ["~> 1.0"]
-  s.add_runtime_dependency 'girl_friday'
-  s.add_runtime_dependency 'has-guarded-handlers', ["~> 1.6"]
-  s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
-  s.add_runtime_dependency 'logging', ["~> 2.0"]
+  s.add_runtime_dependency 'future-resource', ["~> 1.0"]
+  s.add_runtime_dependency 'has-guarded-handlers', ["~> 1.6", ">= 1.6.3"]
+  s.add_runtime_dependency 'i18n', ["~> 0.6"]
+  s.add_runtime_dependency 'logging', ["~> 1.8"]
+  s.add_runtime_dependency 'nokogiri', ["~> 1.5", ">= 1.5.6"]
   s.add_runtime_dependency 'pry'
-  s.add_runtime_dependency 'punchblock', ["~> 2.6"]
   s.add_runtime_dependency 'rake'
-  s.add_runtime_dependency 'ruby_speech', ["~> 2.0"]
+  s.add_runtime_dependency 'reel', ["~> 0.5.0"]
+  s.add_runtime_dependency 'reel-rack', ["~> 0.2.0"]
+  s.add_runtime_dependency 'ruby_ami', ["~> 2.2"]
+  s.add_runtime_dependency 'ruby_jid', ["~> 1.0"]
+  s.add_runtime_dependency 'ruby_speech', ["~> 2.3"]
+  s.add_runtime_dependency 'state_machine', ["~> 1.0"]
   s.add_runtime_dependency 'thor', "~> 0.18.0"
+  s.add_runtime_dependency 'virtus', ["~> 1.0"]
 
   s.add_development_dependency 'aruba', "~> 0.5"
+  s.add_development_dependency 'ci_reporter_rspec'
+  s.add_development_dependency 'ci_reporter_cucumber'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'guard-cucumber'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'rspec', ["~> 3.0"]
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'guard-yard'
   s.add_development_dependency 'coveralls'

data/features/cli_create.feature

@@ -7,9 +7,12 @@ Feature: Adhearsion Ahn CLI (Create)
     When I run `ahn create path/somewhere`
     And I cd to "path/somewhere"
     Then the following directories should exist:
+      | app/assets/audio      |
+      | app/assets/audio/en   |
       | app/call_controllers  |
       | lib                   |
       | config                |
+      | config/locales        |
       | script                |
       | spec                  |
       | spec/call_controllers |
@@ -18,11 +21,14 @@ Feature: Adhearsion Ahn CLI (Create)
     And the following files should exist:
       | .gitignore                                |
       | .rspec                                    |
+      | app/assets/audio/en/hello_world.wav       |
       | app/call_controllers/simon_game.rb        |
       | config/adhearsion.rb                      |
       | config/environment.rb                     |
       | config/events.rb                          |
       | config/routes.rb                          |
+      | config/locales/en.yml                     |
+      | config.ru                                 |
       | Gemfile                                   |
       | script/ahn                                |
       | spec/spec_helper.rb                       |
@@ -35,7 +41,7 @@ Feature: Adhearsion Ahn CLI (Create)
     """
     Adhearsion.config
     logging.level
-    config.punchblock
+    config.core.username
     """
     And the file "config/events.rb" should contain each of these content parts:
     """
@@ -45,6 +51,10 @@ Feature: Adhearsion Ahn CLI (Create)
     """
     Adhearsion.router
     """
+    And the file "config.ru" should contain each of these content parts:
+    """
+    run Sinatra::Application
+    """
     And the file "README.md" should contain each of these content parts:
     """
     Start your new app with
@@ -53,19 +63,22 @@ Feature: Adhearsion Ahn CLI (Create)
     And the file "Rakefile" should contain "adhearsion/tasks"
     And the file "Gemfile" should contain each of these content parts:
     """
-    source 'https://rubygems.org
-    gem 'adhearsion-asr'
+    source 'https://rubygems.org'
+    gem 'adhearsion'
     """
     And the file "app/call_controllers/simon_game.rb" should contain "class SimonGame"
     And the file "script/ahn" should contain "require 'adhearsion'"
+    And the file "config/locales/en.yml" should contain "en:"
 
   Scenario: Generate application --empty
     When I run `ahn create path/somewhere --empty`
     And I cd to "path/somewhere"
     Then the following directories should exist:
+      | app/assets/audio      |
       | app/call_controllers  |
       | lib                   |
       | config                |
+      | config/locales        |
       | script                |
       | spec                  |
       | spec/call_controllers |
@@ -78,6 +91,7 @@ Feature: Adhearsion Ahn CLI (Create)
       | config/environment.rb |
       | config/events.rb      |
       | config/routes.rb      |
+      | config.ru             |
       | Gemfile               |
       | script/ahn            |
       | spec/spec_helper.rb   |
@@ -86,7 +100,9 @@ Feature: Adhearsion Ahn CLI (Create)
       | Procfile              |
 
     And the following files should not exist:
+      | app/assets/audio/en/hello_world.wav       |
       | app/call_controllers/simon_game.rb        |
+      | config/locales/en.yml                     |
       | spec/call_controllers/simon_game_spec.rb  |
 
     And the file "config/events.rb" should not contain each of these content parts:

data/features/step_definitions/cli_steps.rb

@@ -4,7 +4,6 @@ Then /^I should see the usage message$/ do
   steps %Q{
     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 plugin"
     Then the output should contain "ahn help"
@@ -57,13 +56,3 @@ Then /^there should be a valid adhearsion directory named "([^"]*)"$/ do |path|
   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
-  end
-end
-

data/features/support/env.rb

@@ -9,16 +9,15 @@ require 'adhearsion'
 
 Before do
   @aruba_timeout_seconds = ENV.has_key?('ARUBA_TIMEOUT') ? ENV['ARUBA_TIMEOUT'].to_i : (RUBY_PLATFORM == 'java' ? 60 : 30)
-  ENV['AHN_PUNCHBLOCK_RECONNECT_ATTEMPTS'] = '0'
-  ENV['AHN_PUNCHBLOCK_PORT'] = '1'
+  ENV['AHN_CORE_RECONNECT_ATTEMPTS'] = '0'
+  ENV['AHN_CORE_PORT'] = '1'
 end
 
 Before '@reconnect' do
-  ENV['AHN_PUNCHBLOCK_RECONNECT_ATTEMPTS'] = '100'
+  ENV['AHN_CORE_RECONNECT_ATTEMPTS'] = '100'
 end
 
 # TODO: check for name space / run issues
-# NOTE: this will not stop a forked process (eg. daemon mode)
 After do
   terminate_processes!
 end

data/lib/adhearsion.rb

@@ -1,24 +1,23 @@
 # encoding: utf-8
 
-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.3, JRuby 1.7.0 or Rubinius 2.0." if RUBY_VERSION < "1.9.3"
+abort "ERROR: You are running Adhearsion on an unsupported version of Ruby (Ruby #{RUBY_VERSION} #{RUBY_RELEASE_DATE})! Please upgrade to at least Ruby v2.2.0 or JRuby 9.0.0.0." if RUBY_VERSION < "2.2"
 
 %w(
-  punchblock
+  adhearsion/rayo
   celluloid
+  active_support/inflector
 ).each { |r| require r }
 
-
 module Adhearsion
-  Error = Class.new StandardError
-
   class << self
+    delegate :client, to: Rayo::Initializer
 
     #
     # Sets the application path
     # @param[String|Pathname] The application path to set
     #
     def root=(path)
-      Adhearsion.config[:platform].root = path.nil? ? nil : File.expand_path(path)
+      Adhearsion.config[:core].root = path.nil? ? nil : File.expand_path(path)
     end
 
     #
@@ -26,19 +25,11 @@ module Adhearsion
     # @return [Pathname] The application path
     #
     def root
-      Adhearsion.config[:platform].root
-    end
-
-    #
-    # @deprecated Use #root= instead
-    #
-    def ahn_root=(path)
-      Adhearsion.deprecated "#Adhearsion.root="
-      Adhearsion.root = path
+      Adhearsion.config[:core].root
     end
 
     def config(&block)
-      @config ||= initialize_config
+      @config ||= Configuration.new(environment)
       block_given? and yield @config
       @config
     end
@@ -48,19 +39,12 @@ module Adhearsion
       logger.warn caller.join("\n")
     end
 
-    def initialize_config
-      _config = Configuration.new
-      env = environment.to_sym if environment.respond_to? :to_sym
-      unless _config.valid_environment? env
-        puts  "You tried to initialize with an invalid environment name #{env}; environment-specific config may not load successfully. Valid values are #{_config.valid_environments}."
-        env = nil
-      end
-      _config.platform.environment = env if env
-      _config
+    def environment
+      @environment ||= (ENV['AHN_ENV'] || :development).to_sym
     end
 
-    def environment
-      ENV['AHN_ENV'] || ENV['RAILS_ENV'] || :development
+    def environment=(other)
+      @environment = other ? other.to_sym : other
     end
 
     def environments
@@ -83,6 +67,10 @@ module Adhearsion
       @active_calls ||= Calls.new
     end
 
+    def active_calls=(other)
+      @active_calls = other
+    end
+
     #
     # @return [Adhearsion::Statistics] a statistics aggregator object capable of producing stats dumps
     def statistics
@@ -96,6 +84,36 @@ module Adhearsion
     def status
       Adhearsion::Process.state_name
     end
+
+    def new_uuid
+      SecureRandom.uuid
+    end
+
+    def new_request_id
+      SecureRandom.uuid
+    end
+
+    #
+    # Get a new client with a connection attached
+    #
+    # @param [Symbol] type the connection type (eg :XMPP, :asterisk)
+    # @param [Hash] options the options to pass to the connection (credentials, etc
+    #
+    # @return [Adhearsion::Rayo::Client] a client object
+    #
+    def client_with_connection(type, options)
+      connection = Rayo::Connection.const_get(type == :xmpp ? 'XMPP' : type.to_s.classify).new options
+      Rayo::Client.new :connection => connection
+    rescue NameError
+      raise ArgumentError, "Connection type #{type.inspect} is not valid."
+    end
+
+    def execute_component(command, timeout = 60)
+      client.execute_command command, :async => true
+      response = command.response timeout
+      raise response if response.is_a? Exception
+      command
+    end
   end
 end
 
@@ -118,6 +136,8 @@ end
   calls
   configuration
   console
+  error
+  event
   events
   generators
   initializer
@@ -125,6 +145,7 @@ end
   outbound_call
   plugin
   process
+  protocol_error
   router
   statistics
 ).each { |f| require "adhearsion/#{f}" }