adhearsion 2.0.0.beta1 → 2.0.0.rc1

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

@@ -1,27 +1,28 @@
-# Centralized way to overwrite any Adhearsion platform or plugin configuration
-# - Execute rake adhearsion:config:desc to get the configuration options
-# - Execute rake adhearsion:config:show to get the configuration values
-#
-# To update a plugin configuration you can write either:
-#
-#    * Option 1
-#        Adhearsion.config.<plugin-name> do |config|
-#          config.<key> = <value>
-#        end
-#
-#    * Option 2
-#        Adhearsion.config do |config|
-#          config.<plugin-name>.<key> = <value>
-#        end
+# encoding: utf-8
 
 Adhearsion.config do |config|
 
+  # Centralized way to specify any Adhearsion platform or plugin configuration
+  # - Execute rake config:show to view the active configuration values
+  #
+  # To update a plugin configuration you can write either:
+  #
+  #    * Option 1
+  #        Adhearsion.config.<plugin-name> do |config|
+  #          config.<key> = <value>
+  #        end
+  #
+  #    * Option 2
+  #        Adhearsion.config do |config|
+  #          config.<plugin-name>.<key> = <value>
+  #        end
+
   config.development do |dev|
     dev.platform.logging.level = :debug
   end
 
   ##
-  # Use with Voxeo PRISM or other Rayo installation
+  # Use with Rayo (eg Voxeo PRISM)
   #
   # config.punchblock.username = "" # Your XMPP JID for use with Rayo
   # config.punchblock.password = "" # Your XMPP password
@@ -36,6 +37,27 @@ Adhearsion.config do |config|
   # config.punchblock.port = 5038 # Your AMI port
 end
 
+Adhearsion::Events.draw do
+
+  # Register global handlers for events
+  #
+  # eg. Handling Punchblock events
+  # punchblock do |event|
+  #   ...
+  # end
+  #
+  # eg Handling PeerStatus AMI events
+  # ami :name => 'PeerStatus' do |event|
+  #   ...
+  # end
+  #
+end
+
 Adhearsion.router do
+
+  #
+  # Specify your call routes, directing calls with particular attributes to a controller
+  #
+
   route 'default', SimonGame
 end

data/lib/adhearsion/generators/app/templates/config/environment.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rubygems'
 require 'bundler'
 Bundler.setup

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class SimonGame < Adhearsion::CallController
   def run
     answer
@@ -19,7 +21,7 @@ class SimonGame < Adhearsion::CallController
 
   def say_number
     update_number
-    speak @number
+    say @number
   end
 
   def collect_attempt
@@ -28,9 +30,9 @@ class SimonGame < Adhearsion::CallController
 
   def verify_attempt
     if attempt_correct?
-      speak 'good'
+      say 'good'
     else
-      speak "#{@number.length - 1} times wrong, try again smarty"
+      say "#{@number.length - 1} times wrong, try again smarty"
       reset
     end
   end

data/lib/adhearsion/generators/controller/controller_generator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module Generators
     class ControllerGenerator < Generator

data/lib/adhearsion/generators/controller/templates/lib/controller.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class <%= @controller_name %> < Adhearsion::CallController
   def run
   end

data/lib/adhearsion/generators/controller/templates/spec/controller_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 describe <%= @controller_name %> do
 
 end

data/lib/adhearsion/generators/generator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 begin
   require 'thor/group'
 rescue LoadError
@@ -66,7 +68,7 @@ module Adhearsion
       def self.generator_name
         @generator_name ||= begin
           if generator = name.to_s.split('::').last
-            generator.sub! /Generator$/, ''
+            generator.sub!(/Generator$/, '')
             generator.underscore
           end
         end

data/lib/adhearsion/generators/plugin/plugin_generator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module Generators
     class PluginGenerator < Generator

data/lib/adhearsion/initializer.rb

@@ -1,5 +1,8 @@
+# encoding: utf-8
+
 require 'adhearsion/punchblock_plugin'
 require 'adhearsion/linux_proc_name'
+require 'rbconfig'
 
 module Adhearsion
   class Initializer
@@ -41,6 +44,7 @@ module Adhearsion
       initialize_log_paths
       daemonize! if should_daemonize?
       start_logging
+      debugging_log
       launch_console if need_console?
       catch_termination_signal
       create_pid_file
@@ -52,10 +56,9 @@ module Adhearsion
       run_plugins
       trigger_after_initialized_hooks
 
-      if Adhearsion.status == :booting
-        Adhearsion::Process.booted
-        logger.info "Adhearsion v#{Adhearsion::VERSION} initialized with environment <#{Adhearsion.config.platform.environment}>!"
-      end
+      Adhearsion::Process.booted if Adhearsion.status == :booting
+
+      logger.info "Adhearsion v#{Adhearsion::VERSION} initialized in \"#{Adhearsion.config.platform.environment}\"!" if Adhearsion.status == :running
 
       # This method will block until all important threads have finished.
       # When it does, the process will exit.
@@ -63,25 +66,37 @@ module Adhearsion
       self
     end
 
+    def debugging_items
+      [
+        "OS: #{RbConfig::CONFIG['host_os']} - RUBY: #{RUBY_ENGINE} #{RUBY_VERSION}",
+        "Environment: #{ENV.inspect}",
+        Adhearsion.config.description(:all),
+        "Gem versions: #{Gem.loaded_specs.inject([]) { |c,g| c << "#{g[0]} #{g[1].version}" }}"
+      ]
+    end
+
+    def debugging_log
+      debugging_items.each do |item|
+        logger.trace item
+      end
+    end
+
     def update_rails_env_var
       env = ENV['AHN_ENV']
       if env && Adhearsion.config.valid_environment?(env.to_sym)
-        if ENV['RAILS_ENV']
-          logger.info "Using provided RAILS_ENV value of <#{ENV['RAILS_ENV']}>"
-        else
-          logger.warn "Setting RAILS_ENV variable to <#{env}>"
+        unless ENV['RAILS_ENV']
+          logger.info "Copying AHN_ENV (#{env}) to RAILS_ENV"
           ENV['RAILS_ENV'] = env
         end
       else
-        env = ENV['RAILS_ENV']
-        if env
-          logger.info "Using the configured value for RAILS_ENV : <#{env}>"
-        else
+        unless ENV['RAILS_ENV']
           env = Adhearsion.config.platform.environment.to_s
-          logger.info "Defining RAILS_ENV variable to <#{env}>"
+          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
 
@@ -202,7 +217,7 @@ module Adhearsion
 
     def daemonize!
       logger.info "Daemonizing now!"
-      logger.info "Creating PID file #{pid_file}"
+      logger.debug "Creating PID file #{pid_file}"
       extend Adhearsion::CustomDaemonizer
       daemonize resolve_log_file_path
     end
@@ -211,7 +226,6 @@ module Adhearsion
       Adhearsion::Process.important_threads << Thread.new do
         catching_standard_errors do
           Adhearsion::Console.run
-          Adhearsion::Process.shutdown
         end
       end
     end
@@ -241,8 +255,8 @@ module Adhearsion
     end
 
     def initialize_exception_logger
-      Events.register_handler :exception do |e|
-        logger.error e
+      Events.register_handler :exception do |e, l|
+        (l || logger).error e
       end
     end
 

data/lib/adhearsion/linux_proc_name.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
 
   # https://gist.github.com/1350729

data/lib/adhearsion/logging.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'logging'
 
 module Adhearsion
@@ -11,14 +13,14 @@ module Adhearsion
 
       ::Logging.color_scheme 'bright',
         :levels => {
+          :debug => :magenta,
           :info  => :green,
           :warn  => :yellow,
           :error => :red,
           :fatal => [:white, :on_red]
         },
-        :date     => :blue,
-        :logger   => :cyan,
-        :message  => :magenta
+        :date     => [:bold, :blue],
+        :logger   => :cyan
 
       def adhearsion_pattern
         '[%d] %-5l %c: %m\n'

data/lib/adhearsion/menu_dsl.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
     extend ActiveSupport::Autoload

data/lib/adhearsion/menu_dsl/calculated_match.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
     class CalculatedMatch

data/lib/adhearsion/menu_dsl/calculated_match_collection.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
     class CalculatedMatchCollection

data/lib/adhearsion/menu_dsl/fixnum_match_calculator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
     class FixnumMatchCalculator < MatchCalculator

data/lib/adhearsion/menu_dsl/match_calculator.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
     class MatchCalculator

data/lib/adhearsion/menu_dsl/menu.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Adhearsion
   module MenuDSL
 
@@ -6,21 +8,40 @@ module Adhearsion
       DEFAULT_MAX_NUMBER_OF_TRIES = 1
       DEFAULT_TIMEOUT             = 5
 
-      attr_reader :builder, :timeout, :tries_count, :max_number_of_tries
+      InvalidStructureError = Class.new StandardError
+
+      attr_reader :builder, :timeout, :tries_count, :max_number_of_tries, :terminator, :limit, :interruptible, :status
 
       def initialize(options = {}, &block)
         @tries_count          = 0 # Counts the number of tries the menu's been executed
         @timeout              = options[:timeout] || DEFAULT_TIMEOUT
         @max_number_of_tries  = options[:tries]   || DEFAULT_MAX_NUMBER_OF_TRIES
+        @terminator           = options[:terminator].to_s
+        @limit                = options[:limit]
+        @interruptible        = options.has_key?(:interruptible) ? options[:interruptible] : true
         @builder              = MenuDSL::MenuBuilder.new
+        @terminated           = false
 
-        @builder.build &block
+        @builder.build(&block) if block
 
         initialize_digit_buffer
       end
 
+      def validate(mode = nil)
+        case mode
+        when :basic
+          @terminator.present? || !!@limit || raise(InvalidStructureError, "You must specify at least one of limit or terminator")
+        else
+          @builder.has_matchers? || raise(InvalidStructureError, "You must specify one or more matchers")
+        end
+      end
+
       def <<(other)
-        digit_buffer << other
+        if other == terminator
+          @terminated = true
+        else
+          digit_buffer << other
+        end
       end
 
       def digit_buffer
@@ -30,6 +51,7 @@ module Adhearsion
       def digit_buffer_string
         digit_buffer.to_s
       end
+      alias :result :digit_buffer_string
 
       def digit_buffer_empty?
         digit_buffer.empty?
@@ -38,6 +60,11 @@ module Adhearsion
       def continue
         return get_another_digit_or_timeout! if digit_buffer_empty?
 
+        return menu_terminated! if @terminated
+        return menu_limit_reached! if limit && digit_buffer.size >= limit
+
+        return menu_validator_terminated! if execute_validator_hook
+
         calculated_matches = builder.calculate_matches_for digit_buffer_string
 
         if calculated_matches.exact_match_count >= 1
@@ -47,7 +74,7 @@ module Adhearsion
           else
             get_another_digit_or_finish! first_exact_match.match_payload, first_exact_match.query
           end
-        elsif calculated_matches.potential_match_count >= 1
+        elsif calculated_matches.potential_match_count >= 1 || !@builder.has_matchers?
           get_another_digit_or_timeout!
         else
           invalid!
@@ -75,6 +102,10 @@ module Adhearsion
         builder.execute_hook_for :failure, digit_buffer_string
       end
 
+      def execute_validator_hook
+        builder.execute_hook_for :validator, digit_buffer_string
+      end
+
       protected
 
       # If you're using a more complex class in subclasses, you may want to override this method in addition to the
@@ -84,18 +115,37 @@ module Adhearsion
       end
 
       def invalid!
+        @status = :invalid
         MenuResultInvalid.new
       end
 
       def menu_result_found!(match_object, new_extension)
+        @status = :matched
         MenuResultFound.new(match_object, new_extension)
       end
 
+      def menu_terminated!
+        @status = :terminated
+        MenuTerminated.new
+      end
+
+      def menu_validator_terminated!
+        @status = :validator_terminated
+        MenuValidatorTerminated.new
+      end
+
+      def menu_limit_reached!
+        @status = :limited
+        MenuLimitReached.new
+      end
+
       def get_another_digit_or_finish!(match_payload, new_extension)
+        @status = :multi_matched
         MenuGetAnotherDigitOrFinish.new(match_payload, new_extension)
       end
 
       def get_another_digit_or_timeout!
+        @status = :potential
         MenuGetAnotherDigitOrTimeout.new
       end
 
@@ -128,6 +178,10 @@ module Adhearsion
 
       MenuResultInvalid = Class.new MenuResult
 
+      MenuTerminated = Class.new MenuResultDone
+      MenuValidatorTerminated = Class.new MenuResultDone
+      MenuLimitReached = Class.new MenuResultDone
+
       # For our default purpose, we need the digit_buffer to behave much like a normal String except that it should
       # handle its own resetting (clearing)
       class ClearableStringBuffer < String