adhearsion 2.0.0.rc4 → 2.0.0.rc5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/adhearsion)
 
+# [2.0.0.rc5](https://github.com/adhearsion/adhearsion/compare/v2.0.0.rc4...v2.0.0.rc5) - [2012-04-06](https://rubygems.org/gems/adhearsion/versions/2.0.0.rc5)
+  * Bugfix: Fix environment abuse in ahn CLI
+  * Bugfix: Celluloid log messages enter the adhearsion logger
+
 # [2.0.0.rc4](https://github.com/adhearsion/adhearsion/compare/v2.0.0.rc3...v2.0.0.rc4) - [2012-03-30](https://rubygems.org/gems/adhearsion/versions/2.0.0.rc4)
   * Feature: `Call#execute_controller` now takes a post-execution callback (proc)
   * Feature: App generator now includes directory scaffolding for call controller specs and a sample `spec_helper.rb` which loads app config and the `lib/` directory

data/adhearsion.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'girl_friday'
   s.add_runtime_dependency 'jruby-openssl' if RUBY_PLATFORM == 'java'
   s.add_runtime_dependency 'ffi', [">= 1.0.11"]
-  s.add_runtime_dependency 'celluloid', [">= 0.9.0"]
+  s.add_runtime_dependency 'celluloid', [">= 0.10.0"]
   s.add_runtime_dependency 'deep_merge'
 
   # Development dependencies

data/bin/ahn

@@ -19,9 +19,6 @@
 # with this library; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
-
-require 'rubygems'
 require 'adhearsion/cli'
 
 Adhearsion::CLI::AhnCommand.start

data/lib/adhearsion.rb

@@ -3,8 +3,6 @@
 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
@@ -36,7 +34,6 @@ module Adhearsion
   autoload :Dispatcher
   autoload :Events
   autoload :Generators
-  autoload :MenuDSL
   autoload :Initializer
   autoload :Logging
   autoload :OutboundCall
@@ -81,7 +78,7 @@ module Adhearsion
     end
 
     def active_calls
-      if @calls && @calls.alive?
+      if instance_variable_defined?(:@calls) && @calls.alive?
         @calls
       else
         @calls = Calls.new
@@ -95,3 +92,9 @@ module Adhearsion
 end
 
 Celluloid.exception_handler { |e| Adhearsion::Events.trigger :exception, e }
+
+module Celluloid
+  def self.logger
+    ::Logging.logger['Celluloid']
+  end
+end

data/lib/adhearsion/call.rb

@@ -225,7 +225,7 @@ module Adhearsion
       end
 
       command
-    rescue Timeout::Error => e
+    rescue Timeout::Error
       abort CommandTimeout.new(command.to_s)
     end
 

data/lib/adhearsion/call_controller.rb

@@ -6,6 +6,7 @@ module Adhearsion
 
     autoload :Dial
     autoload :Input
+    autoload :MenuDSL
     autoload :Output
     autoload :Record
     autoload :Utility

data/lib/adhearsion/call_controller/menu_dsl.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      extend ActiveSupport::Autoload
+
+      autoload :Exceptions
+      autoload :CalculatedMatch
+      autoload :CalculatedMatchCollection
+      autoload :MatchCalculator
+      autoload :FixnumMatchCalculator
+      autoload :RangeMatchCalculator
+      autoload :StringMatchCalculator
+      autoload :MenuBuilder
+      autoload :Menu
+    end
+  end
+end

data/lib/adhearsion/call_controller/menu_dsl/calculated_match.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      class CalculatedMatch
+
+        def self.failed_match!(pattern, query, match_payload)
+          new :pattern => pattern, :query => query, :match_payload => match_payload
+        end
+
+        attr_reader :match_payload, :potential_matches, :exact_matches, :pattern, :query, :block
+
+        def initialize(options = {})
+          @pattern, @query, @match_payload, @block = options.values_at :pattern, :query, :match_payload, :block
+          @potential_matches  = options[:potential_matches] ? Array(options[:potential_matches]) : []
+          @exact_matches      = options[:exact_matches] ? Array(options[:exact_matches]) : []
+        end
+
+        def exact_match?
+          exact_matches.any?
+        end
+
+        def potential_match?
+          potential_matches.any?
+        end
+
+        def failed_match?
+          !(potential_match? || exact_match?)
+        end
+
+        def type_of_match
+          if exact_match?
+            :exact
+          elsif potential_match?
+            :potential
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/menu_dsl/calculated_match_collection.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      class CalculatedMatchCollection
+        attr_reader :calculated_matches, :potential_matches, :exact_matches,
+          :actual_potential_matches, :actual_exact_matches
+
+        def initialize
+          @calculated_matches       = []
+          @potential_matches        = []
+          @exact_matches            = []
+          @actual_potential_matches = []
+          @actual_exact_matches     = []
+        end
+
+        def <<(calculated_match)
+          calculated_matches << calculated_match
+          actual_potential_matches.concat calculated_match.potential_matches
+          actual_exact_matches.concat calculated_match.exact_matches
+
+          potential_matches << calculated_match if calculated_match.potential_match?
+          exact_matches << calculated_match if calculated_match.exact_match?
+        end
+
+        def potential_match_count
+          actual_potential_matches.size
+        end
+
+        def exact_match_count
+          actual_exact_matches.size
+        end
+
+        def potential_match?
+          potential_match_count > 0
+        end
+
+        def exact_match?
+          exact_match_count > 0
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/menu_dsl/fixnum_match_calculator.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      class FixnumMatchCalculator < MatchCalculator
+
+        def match(query)
+          numeric_query = coerce_to_numeric query
+          exact_match, potential_match = nil
+          if pattern == numeric_query
+            exact_match = pattern
+          elsif pattern.to_s.starts_with? query.to_s
+            potential_match = pattern
+          end
+          new_calculated_match :query => query, :exact_matches => exact_match, :potential_matches => potential_match
+        end
+
+      end # class FixnumMatchCalculator
+    end
+  end
+end

data/lib/adhearsion/call_controller/menu_dsl/match_calculator.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+      class MatchCalculator
+
+        class << self
+
+          def build_with_pattern(pattern, match_payload, &block)
+            class_for_pattern(pattern).new pattern, match_payload, &block
+          end
+
+          private
+
+          def class_for_pattern(pattern)
+            MenuDSL.const_get "#{pattern.class.name.camelize}MatchCalculator"
+          end
+        end
+
+        attr_reader :pattern, :match_payload, :block
+
+        def initialize(pattern, match_payload, &block)
+          @pattern, @match_payload, @block = pattern, match_payload, block
+        end
+
+        protected
+
+        def new_calculated_match(options)
+          CalculatedMatch.new({:pattern => pattern, :match_payload => match_payload, :block => block}.merge(options))
+        end
+
+        def coerce_to_numeric(victim)
+          victim.kind_of?(Numeric) ? victim : (victim.to_s =~ /^\d+$/ ? victim.to_s.to_i : nil )
+        end
+
+      end # class MatchCalculator
+    end
+  end
+end

data/lib/adhearsion/call_controller/menu_dsl/menu.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module MenuDSL
+
+      class Menu
+
+        DEFAULT_MAX_NUMBER_OF_TRIES = 1
+        DEFAULT_TIMEOUT             = 5
+
+        InvalidStructureError = Class.new Adhearsion::Error
+
+        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) 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)
+          if other == terminator
+            @terminated = true
+          else
+            digit_buffer << other
+          end
+        end
+
+        def digit_buffer
+          @digit_buffer
+        end
+
+        def digit_buffer_string
+          digit_buffer.to_s
+        end
+        alias :result :digit_buffer_string
+
+        def digit_buffer_empty?
+          digit_buffer.empty?
+        end
+
+        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
+            first_exact_match = calculated_matches.exact_matches.first
+            if calculated_matches.potential_match_count.zero?
+              menu_result_found! first_exact_match, digit_buffer_string
+            else
+              get_another_digit_or_finish! first_exact_match.match_payload, first_exact_match.query
+            end
+          elsif calculated_matches.potential_match_count >= 1 || !@builder.has_matchers?
+            get_another_digit_or_timeout!
+          else
+            invalid!
+          end
+        end
+
+        def should_continue?
+          tries_count < max_number_of_tries
+        end
+
+        def restart!
+          @tries_count += 1
+          digit_buffer.clear!
+        end
+
+        def execute_invalid_hook
+          builder.execute_hook_for :invalid, digit_buffer_string
+        end
+
+        def execute_timeout_hook
+          builder.execute_hook_for :timeout, digit_buffer_string
+        end
+
+        def execute_failure_hook
+          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
+        # digit buffer, digit_buffer_empty, and digit_buffer_string methods
+        def initialize_digit_buffer
+          @digit_buffer = ClearableStringBuffer.new
+        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
+
+        # The superclass from which all message-like exceptions descend. It should never
+        # be instantiated directly.
+        MenuResult      = Class.new
+        MenuResultDone  = Class.new MenuResult
+
+        class MenuResultFound < MenuResult
+
+          attr_reader :match_object, :new_extension
+
+          def initialize(match_object, new_extension)
+            super()
+            @match_object = match_object
+            @new_extension = new_extension
+          end
+
+        end #class MenuResultFound < MenuResult
+
+        MenuGetAnotherDigit = Module.new
+
+        class MenuGetAnotherDigitOrFinish < MenuResultFound
+          include MenuGetAnotherDigit
+        end
+
+        class MenuGetAnotherDigitOrTimeout < MenuResult
+          include MenuGetAnotherDigit
+        end
+
+        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
+          def clear!
+            replace ""
+          end
+
+          def <<(other)
+            super other.to_s
+          end
+        end
+
+
+      end # class Menu
+
+    end
+  end
+end