sant0sk1-adhearsion 0.7.999

data/lib/adhearsion/voip/menu_state_machine/matchers.rb

@@ -0,0 +1,123 @@
+require File.join(File.dirname(__FILE__), 'calculated_match')
+
+module Adhearsion
+  module VoIP
+    class MatchCalculator
+
+      class << self
+
+        def build_with_pattern(pattern, match_payload, &block)
+          class_for_pattern_type(pattern.class.name).new(pattern, match_payload, &block)
+        end
+
+        def inherited(klass)
+          subclasses << klass
+        end
+
+        private
+
+        def class_for_pattern_type(pattern_type)
+          sought_class_name = "Adhearsion::VoIP::#{pattern_type.camelize}MatchCalculator"
+          subclasses.find { |klass| klass.name == sought_class_name }
+        end
+
+        def subclasses
+          @@subclasses ||= []
+        end
+
+      end
+
+      attr_reader :pattern, :match_payload
+      def initialize(pattern, match_payload)
+        @pattern, @match_payload = pattern, match_payload
+      end
+
+      protected
+
+      def new_calculated_match(options)
+        CalculatedMatch.new({:pattern => pattern, :match_payload => match_payload}.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 RangeMatchCalculator < MatchCalculator
+
+      def initialize(pattern, match_payload)
+        raise unless pattern.first.kind_of?(Numeric) && pattern.last.kind_of?(Numeric)
+        super
+      end
+
+      def match(query)
+        numerical_query = coerce_to_numeric query
+        if numerical_query      
+          exact_match = pattern.include?(numerical_query) ? query : nil
+          potential_matches = numbers_in_range_like numerical_query
+          potential_matches.reject! { |m| m.to_s == exact_match.to_s } if exact_match
+    
+          new_calculated_match :query => query, :exact_matches => exact_match,
+                               :potential_matches => potential_matches
+        else
+          CalculatedMatch.failed_match!(pattern, query, match_payload)
+        end
+      end
+
+      private
+
+      # Returns all numbers in the range (@pattern) that +begin with+ the number given
+      # as the first argument.
+      #
+      # NOTE! If you're having trouble reading what this method is actually doing, it's
+      # effectively a much more efficient version of this:
+      #
+      # pattern.to_a.select { |x| x.to_s.starts_with? num.to_s }.flatten
+      #
+      # Huge thanks to Dave Troy (http://davetroy.blogspot.com) for this awesomely
+      # efficient code!
+      def numbers_in_range_like(num)
+        return (pattern === 0 ? [0] : nil) if num == 0
+        raise ArgumentError unless num.kind_of?(Numeric)
+        returning Array.new do |matches|
+          first, last = pattern.first, pattern.last
+          power = 0
+          while num < last
+            ones_count = 10**power - 1
+            matches.concat((([num, first].max)..[(num+ones_count), last].min).to_a)
+            num *= 10
+            power += 1
+          end
+        end
+      end
+    end
+
+    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 StringMatchCalculator < MatchCalculator
+      def match(query)
+        args = { :query => query, :exact_matches => nil,
+                 :potential_matches => nil }
+
+        if pattern == query.to_s
+          args[:exact_matches] = [pattern]
+        elsif pattern.starts_with? query.to_s
+          args[:potential_matches] = [pattern]
+        end
+
+        new_calculated_match args
+      end
+    end
+  end
+end

data/lib/adhearsion/voip/menu_state_machine/menu_builder.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'matchers.rb')
+
+module Adhearsion
+  module VoIP
+    class MenuBuilder
+
+      def initialize
+        @patterns = []
+        @menu_callbacks = {}
+      end
+
+      def method_missing(match_payload, *patterns, &block)
+        name_string = match_payload.to_s
+        if patterns.any?
+          patterns.each do |pattern|
+            @patterns << MatchCalculator.build_with_pattern(pattern, match_payload)
+          end
+        else
+          raise ArgumentError, "You cannot call this method without patterns!"
+        end
+        nil
+      end
+
+      def weighted_match_calculators
+        @patterns
+      end
+
+      def execute_hook_for(symbol, input)
+        callback = @menu_callbacks[symbol]
+        callback.call input if callback
+      end
+
+      def on_invalid(&block)
+        raise LocalJumpError, "Must supply a block!" unless block_given?
+        @menu_callbacks[:invalid] = block
+      end
+
+      def on_premature_timeout(&block)
+        raise LocalJumpError, "Must supply a block!" unless block_given?
+        @menu_callbacks[:premature_timeout] = block
+      end
+
+      def on_failure(&block)
+        raise LocalJumpError, "Must supply a block!" unless block_given?
+        @menu_callbacks[:failure] = block
+      end
+
+      def calculate_matches_for(result)
+        returning CalculatedMatchCollection.new do |collection|
+          weighted_match_calculators.each do |pattern|
+            collection << pattern.match(result)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/adhearsion/voip/menu_state_machine/menu_class.rb

@@ -0,0 +1,149 @@
+require 'adhearsion/voip/menu_state_machine/menu_builder'
+module Adhearsion
+  module VoIP
+    class Menu
+
+      DEFAULT_MAX_NUMBER_OF_TRIES = 1
+      DEFAULT_TIMEOUT             = 5 # seconds
+
+      relationships :menu_builder => MenuBuilder
+
+      attr_reader :builder, :timeout, :tries_count, :max_number_of_tries
+      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
+
+        @builder = menu_builder.new
+        yield @builder
+
+        initialize_digit_buffer
+      end
+
+      def <<(other)
+        digit_buffer << other
+      end
+      
+      def digit_buffer
+        @digit_buffer
+      end
+      
+      def digit_buffer_string
+        digit_buffer.to_s
+      end
+      
+      def digit_buffer_empty?
+        digit_buffer.empty?
+      end
+
+      def continue
+        raise MenuGetAnotherDigitOrTimeout if digit_buffer_empty?
+
+        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?
+            # Match found with no extenuating ambiguities! Go with the first exact match
+            menu_result_found! first_exact_match.match_payload, 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
+          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(:premature_timeout, digit_buffer_string)
+      end
+
+      def execute_failure_hook
+        builder.execute_hook_for(:failure, 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!
+        raise MenuResultInvalid
+      end
+
+      def menu_result_found!(match_payload, new_extension)
+        raise MenuResultFound.new(match_payload, new_extension)
+      end
+
+      def get_another_digit_or_finish!(match_payload, new_extension)
+        raise MenuGetAnotherDigitOrFinish.new(match_payload, new_extension)
+      end
+
+      def get_another_digit_or_timeout!
+        raise MenuGetAnotherDigitOrTimeout
+      end
+
+      # The superclass from which all message-like exceptions decend. It should never
+      # be instantiated directly.
+      class MenuResult < Exception; end
+
+      # Raised when the user's input matches
+      class MenuResultFound < MenuResult
+        attr_reader :match_payload, :new_extension
+        def initialize(match_payload, new_extension)
+          super()
+          @match_payload  = match_payload
+          @new_extension = new_extension
+        end
+      end
+
+      module MenuGetAnotherDigit; end
+
+      class MenuGetAnotherDigitOrFinish < MenuResultFound
+        include MenuGetAnotherDigit
+      end
+
+      class MenuGetAnotherDigitOrTimeout < MenuResult
+        include MenuGetAnotherDigit
+      end
+
+      class MenuResultFound < MenuResult; end
+
+      # Raised when the user's input matches no patterns
+      class MenuResultInvalid < MenuResult; end
+
+      # For our default purposes, 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
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: sant0sk1-adhearsion
+version: !ruby/object:Gem::Version 
+  version: 0.7.999
+platform: ruby
+authors: 
+- Jay Phillips
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+description: Adhearsion is an open-source telephony development framework
+email: Jay -at- Codemecca.com
+executables: 
+- ahn
+- ahnctl
+- jahn
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- adhearsion.gemspec
+- LICENSE
+- README.txt
+- Rakefile
+- app_generators/ahn/USAGE
+- app_generators/ahn/ahn_generator.rb
+- app_generators/ahn/templates/.ahnrc
+- app_generators/ahn/templates/README
+- app_generators/ahn/templates/Rakefile
+- app_generators/ahn/templates/components/simon_game/configuration.rb
+- app_generators/ahn/templates/components/simon_game/lib/simon_game.rb
+- app_generators/ahn/templates/components/simon_game/test/test_helper.rb
+- app_generators/ahn/templates/components/simon_game/test/test_simon_game.rb
+- app_generators/ahn/templates/config/startup.rb
+- app_generators/ahn/templates/dialplan.rb
+- bin/ahn
+- bin/ahnctl
+- bin/jahn
+- lib/adhearsion.rb
+- lib/adhearsion/blank_slate.rb
+- lib/adhearsion/cli.rb
+- lib/adhearsion/events_support.rb
+- lib/adhearsion/component_manager.rb
+- lib/adhearsion/core_extensions/all.rb
+- lib/adhearsion/core_extensions/array.rb
+- lib/adhearsion/core_extensions/custom_daemonizer.rb
+- lib/adhearsion/core_extensions/global.rb
+- lib/adhearsion/core_extensions/hash.rb
+- lib/adhearsion/core_extensions/metaprogramming.rb
+- lib/adhearsion/core_extensions/numeric.rb
+- lib/adhearsion/core_extensions/proc.rb
+- lib/adhearsion/core_extensions/publishable.rb
+- lib/adhearsion/core_extensions/relationship_properties.rb
+- lib/adhearsion/core_extensions/string.rb
+- lib/adhearsion/core_extensions/thread.rb
+- lib/adhearsion/core_extensions/thread_safety.rb
+- lib/adhearsion/core_extensions/time.rb
+- lib/adhearsion/distributed/gateways/dbus_gateway.rb
+- lib/adhearsion/distributed/gateways/osa_gateway.rb
+- lib/adhearsion/distributed/gateways/rest_gateway.rb
+- lib/adhearsion/distributed/gateways/soap_gateway.rb
+- lib/adhearsion/distributed/gateways/xmlrpc_gateway.rb
+- lib/adhearsion/distributed/peer_finder.rb
+- lib/adhearsion/distributed/remote_cli.rb
+- lib/adhearsion/hooks.rb
+- lib/adhearsion/host_definitions.rb
+- lib/adhearsion/initializer.rb
+- lib/adhearsion/initializer/asterisk.rb
+- lib/adhearsion/initializer/configuration.rb
+- lib/adhearsion/initializer/database.rb
+- lib/adhearsion/initializer/drb.rb
+- lib/adhearsion/initializer/freeswitch.rb
+- lib/adhearsion/initializer/rails.rb
+- lib/adhearsion/logging.rb
+- lib/adhearsion/tasks.rb
+- lib/adhearsion/tasks/database.rb
+- lib/adhearsion/tasks/generating.rb
+- lib/adhearsion/tasks/lint.rb
+- lib/adhearsion/tasks/testing.rb
+- lib/adhearsion/version.rb
+- lib/adhearsion/voip/asterisk.rb
+- lib/adhearsion/voip/asterisk/agi_server.rb
+- lib/adhearsion/voip/asterisk/ami.rb
+- lib/adhearsion/voip/asterisk/ami/actions.rb
+- lib/adhearsion/voip/asterisk/ami/machine.rb
+- lib/adhearsion/voip/asterisk/ami/machine.rl
+- lib/adhearsion/voip/asterisk/ami/parser.rb
+- lib/adhearsion/voip/asterisk/commands.rb
+- lib/adhearsion/voip/asterisk/config_generators/agents.conf.rb
+- lib/adhearsion/voip/asterisk/config_generators/config_generator.rb
+- lib/adhearsion/voip/asterisk/config_generators/queues.conf.rb
+- lib/adhearsion/voip/asterisk/config_generators/voicemail.conf.rb
+- lib/adhearsion/voip/asterisk/config_manager.rb
+- lib/adhearsion/voip/asterisk/special_dial_plan_managers.rb
+- lib/adhearsion/voip/call.rb
+- lib/adhearsion/voip/call_routing.rb
+- lib/adhearsion/voip/commands.rb
+- lib/adhearsion/voip/constants.rb
+- lib/adhearsion/voip/conveniences.rb
+- lib/adhearsion/voip/dial_plan.rb
+- lib/adhearsion/voip/dsl/dialing_dsl.rb
+- lib/adhearsion/voip/dsl/dialing_dsl/dialing_dsl_monkey_patches.rb
+- lib/adhearsion/voip/dsl/dialplan/control_passing_exception.rb
+- lib/adhearsion/voip/dsl/dialplan/dispatcher.rb
+- lib/adhearsion/voip/dsl/dialplan/parser.rb
+- lib/adhearsion/voip/dsl/dialplan/thread_mixin.rb
+- lib/adhearsion/voip/dsl/numerical_string.rb
+- lib/adhearsion/voip/freeswitch/basic_connection_manager.rb
+- lib/adhearsion/voip/freeswitch/event_handler.rb
+- lib/adhearsion/voip/freeswitch/freeswitch_dialplan_command_factory.rb
+- lib/adhearsion/voip/freeswitch/inbound_connection_manager.rb
+- lib/adhearsion/voip/freeswitch/oes_server.rb
+- lib/adhearsion/voip/menu_state_machine/calculated_match.rb
+- lib/adhearsion/voip/menu_state_machine/matchers.rb
+- lib/adhearsion/voip/menu_state_machine/menu_builder.rb
+- lib/adhearsion/voip/menu_state_machine/menu_class.rb
+has_rdoc: false
+homepage: http://adhearsion.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: adhearsion
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Adhearsion, open-source telephony development framework
+test_files: []
+