adhearsion 2.6.4 → 3.0.0.beta1

data/lib/adhearsion/foundation.rb

@@ -7,7 +7,6 @@
 }.each { |f| require f }
 
 %w{
-  custom_daemonizer
   exception_handler
   libc
   object

data/lib/adhearsion/foundation/object.rb

@@ -4,11 +4,6 @@ require 'adhearsion/logging'
 
 class Object
   include Adhearsion::Logging::HasLogger
-
-  undef :pb_logger
-  def pb_logger
-    logger
-  end
 end
 
 module Celluloid

data/lib/adhearsion/generators/app/app_generator.rb

@@ -5,7 +5,7 @@ module Adhearsion
     class AppGenerator < Generator
 
       BASEDIRS  = %w( config script spec )
-      EMPTYDIRS = %w( app/call_controllers lib spec/support spec/call_controllers )
+      EMPTYDIRS = %w( app/assets/audio/en app/call_controllers config/locales lib spec/support spec/call_controllers )
 
       class_option :empty, type: :boolean
 
@@ -18,13 +18,16 @@ module Adhearsion
         template "adhearsion.erb", "config/adhearsion.rb"
         template "events.erb", "config/events.rb"
         template "routes.erb", "config/routes.rb"
+        copy_file "config.ru", "config.ru"
         copy_file "gitignore", ".gitignore"
         copy_file "rspec", ".rspec"
         copy_file "Procfile"
         copy_file "Rakefile"
         copy_file "README.md"
         unless options[:empty]
+          copy_file "hello_world.wav", "app/assets/audio/en/hello_world.wav"
           copy_file "simon_game.rb", "app/call_controllers/simon_game.rb"
+          copy_file "en.yml", "config/locales/en.yml"
           copy_file "simon_game_spec.rb", "spec/call_controllers/simon_game_spec.rb"
         end
         chmod "script/ahn", 0755

data/lib/adhearsion/generators/app/templates/Gemfile.erb

@@ -2,21 +2,13 @@ source 'https://rubygems.org'
 
 gem 'adhearsion', '~> <%= Adhearsion::VERSION.split('.')[0,2].join('.') %>'
 
-# Exercise care when updating the Punchblock major version, since Adhearsion
-# apps sometimes make use of underlying features from the Punchblock API.
-# Occasionally an update of Adhearsion will necessitate an update to
-# Punchblock; in those cases update this line and test your app thoroughly.
-gem 'punchblock', '~> <%= require "punchblock/version"; Punchblock::VERSION.split('.')[0,2].join('.') %>'
-
-# This is here by default due to deprecation of #ask and #menu.
-# See http://adhearsion.com/docs/common_problems#toc_3 for details
-gem 'adhearsion-asr'
-
 #
 # Check http://ahnhub.com for a list of plugins you can use in your app.
 # To use them, simply add them here and run `bundle install`.
 #
 
+gem 'sinatra'
+
 group :development, :test do
   gem 'rspec'
 end

data/lib/adhearsion/generators/app/templates/adhearsion.erb

@@ -2,7 +2,7 @@
 
 Adhearsion.config do |config|
 <% unless options[:empty] %>
-  # Centralized way to specify any Adhearsion platform or plugin configuration
+  # Centralized way to specify any Adhearsion core or plugin configuration
   # - Execute rake config:show to view the active configuration values
   #
   # To update a plugin configuration you can write either:
@@ -18,20 +18,20 @@ Adhearsion.config do |config|
   #        end
 <% end %>
   config.development do |dev|
-    dev.platform.logging.level = :debug
+    dev.core.logging.level = :debug
   end
 
   ##
-  # Use with Rayo (eg Voxeo PRISM or FreeSWITCH mod_rayo)
+  # Use with Rayo over XMPP (eg Voxeo PRISM or FreeSWITCH mod_rayo)
   #
-  # config.punchblock.username = "usera@freeswitch.local-dev.mojolingo.com" # Your XMPP JID for use with Rayo
-  # config.punchblock.password = "1" # Your XMPP password
+  # config.core.username = "usera@freeswitch.local-dev.mojolingo.com" # Your XMPP JID for use with Rayo
+  # config.core.password = "1" # Your XMPP password
 
   ##
   # Use with Asterisk
   #
-  # config.punchblock.platform = :asterisk # Use Asterisk
-  # config.punchblock.username = "manager" # Your AMI username
-  # config.punchblock.password = "password" # Your AMI password
-  # config.punchblock.host = "asterisk.local-dev.mojolingo.com" # Your AMI host
+  # config.core.type = :asterisk # Use Asterisk
+  # config.core.username = "manager" # Your AMI username
+  # config.core.password = "password" # Your AMI password
+  # config.core.host = "asterisk.local-dev.mojolingo.com" # Your AMI host
 end

data/lib/adhearsion/generators/app/templates/config.ru

@@ -0,0 +1,7 @@
+require 'sinatra'
+
+get '/' do
+  'Hello world!'
+end
+
+run Sinatra::Application

data/lib/adhearsion/generators/app/templates/en.yml

@@ -0,0 +1,4 @@
+en:
+  hello:
+    audio: hello_world.wav
+    text: "Hello world"

data/lib/adhearsion/generators/app/templates/events.erb

@@ -4,8 +4,8 @@ Adhearsion::Events.draw do
 <% unless options[:empty] %>
   # Register global handlers for events
   #
-  # eg. Handling Punchblock events
-  # punchblock do |event|
+  # eg. Handling Rayo events
+  # rayo do |event|
   #   ...
   # end
   #

data/lib/adhearsion/generators/app/templates/simon_game.rb

@@ -7,6 +7,7 @@ class SimonGame < Adhearsion::CallController
   def run
     answer
     reset
+    say t(:hello)
     loop do
       update_number
       collect_attempt
@@ -24,7 +25,7 @@ class SimonGame < Adhearsion::CallController
 
   def collect_attempt
     result = ask @number, :limit => @number.length
-    @attempt = result.response
+    @attempt = result.utterance
   end
 
   def verify_attempt

data/lib/adhearsion/generators/app/templates/simon_game_spec.rb

@@ -5,9 +5,9 @@ require 'call_controllers/simon_game'
 
 describe SimonGame do
 
-  let(:example_response)  { OpenStruct.new(:response => "5")     }
+  let(:example_response)  { OpenStruct.new(:utterance => "5")     }
   let(:example_number)    { "5"                                  }
-  let(:long_response)     { OpenStruct.new(:response => "55555") }
+  let(:long_response)     { OpenStruct.new(:utterance => "55555") }
   let(:long_number)       { "55555"                              }
 
   let(:mock_call) { double 'Call' }

data/lib/adhearsion/has_headers.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module Adhearsion
+  module HasHeaders
+    def self.included(klass)
+      klass.attribute :headers, Hash, default: {}
+    end
+
+    def headers=(other)
+      super(other || {})
+    end
+
+    def inherit(xml_node)
+      xml_node.xpath('//ns:header', ns: Rayo::RAYO_NAMESPACES[:core]).to_a.each do |header|
+        if headers.has_key?(header[:name])
+          headers[header[:name]] = [headers[header[:name]]]
+          headers[header[:name]] << header[:value]
+        else
+          headers[header[:name]] = header[:value]
+        end
+      end
+      super
+    end
+
+    def rayo_children(root)
+      super
+      headers.each do |name, value|
+        Array(value).each do |v|
+          root.header name: name, value: v, xmlns: Rayo::RAYO_NAMESPACES[:core]
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/http_server.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'reel'
+require 'reel/rack'
+
+module Adhearsion
+  # @private
+  class HTTPServer
+    def self.start
+      config = Adhearsion.config.core.http
+
+      return unless config.enable
+
+      rackup = File.join(Adhearsion.root, config.rackup)
+      unless File.exists?(rackup)
+        logger.error "Cannot start HTTP server because the Rack configuration does not exist at #{rackup}"
+        return
+      end
+
+      app, options = ::Rack::Builder.parse_file rackup
+      options = {
+        Host: config.host,
+        Port: config.port,
+      }.merge(options)
+
+      app = Rack::CommonLogger.new(app, logger)
+
+      logger.info "Starting HTTP server listening on #{config.host}:#{config.port}"
+
+      supervisor = ::Reel::Rack::Server.supervise_as(:ahn_http_server, app, options)
+
+      Adhearsion::Events.register_callback :shutdown do
+        supervisor.terminate
+      end
+    end
+  end
+end

data/lib/adhearsion/initializer.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
-require 'adhearsion/punchblock_plugin'
 require 'adhearsion/linux_proc_name'
+require 'adhearsion/rayo/initializer'
+require 'adhearsion/http_server'
 require 'rbconfig'
 
 module Adhearsion
@@ -13,45 +14,23 @@ module Adhearsion
       end
     end
 
-    DEFAULT_PID_FILE_NAME = 'adhearsion.pid'
+    attr_reader :path
 
-    attr_reader :path, :daemon, :pid_file
-
-    # Creation of pid_files
-    #
-    #  - You may want to have Adhearsion create a process identification
-    #    file when it boots so that a crash monitoring program such as
-    #    Monit can reboot if necessary or so the init script can kill it
-    #    for system shutdowns.
-    #  - To have Adhearsion create a pid file in the default location (i.e.
-    #    AHN_INSTALL_DIR/adhearsion.pid), supply :pid_file with 'true'. Otherwise
-    #    one is not created UNLESS it is running in daemon mode, in which
-    #    case one is created. You can force Adhearsion to not create one
-    #    even in daemon mode by supplying "false".
     def initialize(options = {})
       @@started = true
       @path     = path
-      @mode     = options[:mode]
-      @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
+      @console  = options[:console]
       @loaded_init_files  = options[:loaded_init_files]
       Adhearsion.root = '.'
     end
 
     def start
       catch :boot_aborted do
-        resolve_pid_file_path
         configure_plugins
         load_lib_folder
         load_config_file
         load_events_file
         load_routes_file
-        initialize_log_paths
-
-        if should_daemonize?
-          daemonize!
-        else
-          create_pid_file
-        end
 
         Adhearsion.statistics
         start_logging
@@ -60,15 +39,18 @@ module Adhearsion
         catch_termination_signal
         set_ahn_proc_name
         initialize_exception_logger
-        update_rails_env_var
+        setup_i18n_load_path
+        Rayo::Initializer.init
+        HTTPServer.start
         init_plugins
 
+        Rayo::Initializer.run
         run_plugins
         trigger_after_initialized_hooks
 
         Adhearsion::Process.booted if Adhearsion.status == :booting
 
-        logger.info "Adhearsion v#{Adhearsion::VERSION} initialized in \"#{Adhearsion.config.platform.environment}\"!" if Adhearsion.status == :running
+        logger.info "Adhearsion v#{Adhearsion::VERSION} initialized in \"#{Adhearsion.environment}\"!" if Adhearsion.status == :running
       end
 
       # This method will block until all important threads have finished.
@@ -92,48 +74,13 @@ module Adhearsion
       end
     end
 
-    def update_rails_env_var
-      env = ENV['AHN_ENV']
-      if env && Adhearsion.config.valid_environment?(env.to_sym)
-        unless ENV['RAILS_ENV']
-          logger.info "Copying AHN_ENV (#{env}) to RAILS_ENV"
-          ENV['RAILS_ENV'] = env
-        end
-      else
-        unless ENV['RAILS_ENV']
-          env = Adhearsion.config.platform.environment.to_s
-          ENV['AHN_ENV'] = env
-          logger.info "Setting RAILS_ENV to \"#{env}\""
-          ENV['RAILS_ENV'] = env
-        end
-      end
-      logger.warn "AHN_ENV(#{ENV['AHN_ENV']}) does not match RAILS_ENV(#{ENV['RAILS_ENV']})!" unless ENV['RAILS_ENV'] == ENV['AHN_ENV']
-      env
-    end
-
-    def default_pid_path
-      File.join Adhearsion.config.root, DEFAULT_PID_FILE_NAME
-    end
-
-    def resolve_pid_file_path
-      @pid_file = if pid_file.equal?(true)
-        default_pid_path
-      elsif pid_file.equal?(false)
-        nil
-      elsif pid_file
-        File.expand_path pid_file
-      else
-        should_daemonize? ? default_pid_path : nil
+    def setup_i18n_load_path
+      Adhearsion.config.core.i18n.locale_path.each do |dir|
+        logger.debug "Adding #{dir} to the I18n load path"
+        I18n.load_path += Dir["#{dir}/**/*.yml"]
       end
     end
 
-    def resolve_log_file_path
-      _log_file = Adhearsion.config.platform.logging.outputters
-      _log_file = _log_file[0] if _log_file.is_a?(Array)
-      _log_file = File.expand_path(Adhearsion.config.root.dup.concat("/").concat(_log_file)) unless _log_file.start_with?("/")
-      _log_file
-    end
-
     def catch_termination_signal
       self_read, self_write = IO.pipe
 
@@ -162,9 +109,6 @@ module Adhearsion
       when 'INT', 'TERM'
         logger.info "Received SIG#{signal}. Shutting down."
         Adhearsion::Process.shutdown
-      when 'HUP'
-        logger.info "Received SIGHUP. Reopening logfiles."
-        Adhearsion::Logging.reopen_logs
       when 'ALRM'
         logger.info "Received SIGALRM. Toggling trace logging."
         Adhearsion::Logging.toggle_trace!
@@ -178,9 +122,9 @@ module Adhearsion
     # Loads files in application lib folder
     # @return [Boolean] if files have been loaded (lib folder is configured to not nil and actually exists)
     def load_lib_folder
-      return false if Adhearsion.config.platform.lib.nil?
+      return false if Adhearsion.config.core.lib.nil?
 
-      lib_folder = [Adhearsion.config.platform.root, Adhearsion.config.platform.lib].join '/'
+      lib_folder = [Adhearsion.config.core.root, Adhearsion.config.core.lib].join '/'
       return false unless File.directory? lib_folder
 
       $LOAD_PATH.unshift lib_folder
@@ -199,6 +143,7 @@ module Adhearsion
     end
 
     def load_events_file
+      Adhearsion::Events.init
       path = "#{Adhearsion.config.root}/config/events.rb"
       load path if File.exists?(path)
     end
@@ -208,40 +153,6 @@ module Adhearsion
       load path if File.exists?(path)
     end
 
-    def init_get_logging_appenders
-      @file_loggers ||= memoize_logging_appenders
-    end
-
-    def memoize_logging_appenders
-      appenders = Array(Adhearsion.config.platform.logging.outputters.dup)
-      # Any filename in the outputters array is mapped to a ::Logging::Appenders::File instance
-      appenders.map! do |a|
-        case a
-        when String
-          f = if a.start_with?("/")
-            a
-          else
-            File.expand_path(Adhearsion.config.root.dup.concat("/").concat(a))
-          end
-          ::Logging.appenders.file(f,
-            :layout => ::Logging.layouts.pattern(
-              Adhearsion::Logging.adhearsion_pattern_options
-            ),
-           :auto_flushing => 2,
-           :flush_period => 2
-          )
-        else
-         a
-        end
-      end
-
-      if should_daemonize?
-        appenders
-      else
-        appenders += Adhearsion::Logging.default_appenders
-      end
-    end
-
     def configure_plugins
       Plugin.configure_plugins
     end
@@ -254,19 +165,8 @@ module Adhearsion
       Plugin.run_plugins
     end
 
-    def should_daemonize?
-      @mode == :daemon
-    end
-
     def need_console?
-      @mode == :console
-    end
-
-    def daemonize!
-      logger.info "Daemonizing now!"
-      Adhearsion::CustomDaemonizer.daemonize resolve_log_file_path do |pid|
-        create_pid_file pid
-      end
+      @console == true
     end
 
     def launch_console
@@ -277,28 +177,8 @@ module Adhearsion
       end
     end
 
-    # Creates the relative paths associated to log files
-    # i.e.
-    # - log_file = "log/adhearsion.log"      => creates 'log' folder
-    # - log_file = "log/test/adhearsion.log" => creates 'log' and 'log/test' folders
-    def initialize_log_paths
-      outputters = Array(Adhearsion.config.platform.logging.outputters)
-      outputters.select{|o| o.is_a?(String)}.each do |o|
-        o = o.split("/")
-        unless o[0].empty? # only if relative path
-          o.pop # not consider filename
-          o.inject("") do |path, folder|
-            path = path.concat(folder).concat("/")
-            Dir.mkdir(path) unless File.directory? path
-            path
-          end
-        end
-      end
-    end
-
     def start_logging
-      outputters = init_get_logging_appenders
-      Adhearsion::Logging.start outputters, Adhearsion.config.platform.logging.level, Adhearsion.config.platform.logging.formatter
+      Adhearsion::Logging.start Adhearsion.config.core.logging.level, Adhearsion.config.core.logging.formatter
     end
 
     def initialize_exception_logger
@@ -307,22 +187,8 @@ module Adhearsion
       end
     end
 
-    def create_pid_file(pid = nil)
-      return unless pid_file
-
-      logger.debug "Creating PID file #{pid_file}"
-
-      File.open pid_file, 'w' do |file|
-        file.puts pid || ::Process.pid
-      end
-
-      Events.register_callback :shutdown do
-        File.delete(pid_file) if File.exists?(pid_file)
-      end
-    end
-
     def set_ahn_proc_name
-      Adhearsion::LinuxProcName.set_proc_name Adhearsion.config.platform.process_name
+      Adhearsion::LinuxProcName.set_proc_name Adhearsion.config.core.process_name
     end
 
     def trigger_after_initialized_hooks