jicksta-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

data/lib/adhearsion.rb

@@ -0,0 +1,37 @@
+# Check the Ruby version
+STDERR.puts "WARNING: You are running Adhearsion in an unsupported
+version of Ruby (Ruby #{RUBY_VERSION} #{RUBY_RELEASE_DATE})!
+Please upgrade to at least Ruby v1.8.5." if RUBY_VERSION < "1.8.5"
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+
+require 'adhearsion/version'
+require 'adhearsion/voip/call'
+require 'adhearsion/voip/dial_plan'
+require 'adhearsion/voip/asterisk/special_dial_plan_managers'
+require 'adhearsion/foundation/all'
+require 'adhearsion/events_support'
+require 'adhearsion/logging'
+require 'adhearsion/component_manager'
+require 'adhearsion/initializer/configuration'
+require 'adhearsion/initializer'
+require 'adhearsion/voip/dsl/numerical_string'
+require 'adhearsion/voip/dsl/dialplan/parser'
+require 'adhearsion/voip/commands'
+require 'adhearsion/voip/asterisk/commands'
+require 'adhearsion/voip/dsl/dialing_dsl'
+require 'adhearsion/voip/call_routing'
+
+module Adhearsion
+  # Sets up the Gem require path.
+  AHN_INSTALL_DIR = File.expand_path(File.dirname(__FILE__) + "/..")
+  AHN_CONFIG = Configuration.new
+  
+  ##
+  # This Array holds all the Threads whose life matters. Adhearsion will not exit until all of these have died.
+  #
+  IMPORTANT_THREADS = []
+  
+end

data/lib/theatre/README.markdown

@@ -0,0 +1,64 @@
+Theatre
+=======
+
+Present status: stable
+
+A library for choreographing a dynamic pool of hierarchically organized actors. This was originally extracted from the [Adhearsion](http://adhearsion.com) framework by Jay Phillips.
+
+In the Adhearsion framework, it was necessary to develop an internal message-passing system that could work either synchronously or asynchronously. This is used by the framework itself and for framework extensions (called _components_) to talk with each other. The source of the events is completely undefined -- events could originate from within the framework out outside the framework. For example, a Message Queue such as [Stomp](http://stomp.codehaus.org) can wire incoming events into Theatre and catch events going to a particular destination so it can proxy them out to the server.
+
+Motivations and Design Decisions
+--------------------------------
+
+* Must maintain Ruby 1.8 and JRuby compatibility
+* Must be Thread-safe
+* Must provide some level of transparency into the events going through it
+* Must be dynamic enough to reallocate the number of triggerrs based on load
+* Must help facilitate test-driven development of Actor functionality
+* Must allow external persistence in case of a crash
+
+Example
+-------
+
+Below is an example taken from Adhearsion for executing framework-level callbacks. Note: the framework treats this callback synchronously.
+
+    events.framework.asterisk.before_call.each do |event|
+      # Pull headers from event and respond to it here.
+    end
+
+Below is an example of integration with [Stomp](http://stomp.codehaus.org/), a simple yet robust open-protocol message queue.
+
+    events.stomp.new_call.each do |event|
+      # Handle all events from the Stomp MQ server whose name is "new_call" (the String)
+    end
+
+This will filter all events whose name is "new_call" and yield the Stomp::Message to the block.
+
+Framework terminology
+--------------------
+
+Below are definitions of terms I use in Theatre. See the respective links for more information.
+
+* **callback**: This is the block given to the `each` method which triggers events coming in.
+* **payload**: This is the "message" sent to the Theatre and is what will ultimately be yielded to the callback
+* **[Actor](http://en.wikipedia.org/wiki/Actor_model)**: This refers to concurrent responders to events in a concurrent system.
+
+Synchronous vs. Asynchronous
+----------------------------
+
+With Theatre, all events are asynchronous with the optional ability to synchronously block until the event is scheduled, triggered, and has returned. If you wish to synchronously trigger the event, simple call `wait` on an `Invocation` object returned from `trigger` and then check the `Invocation#current_state` property for `:success` or `:error`. Optionally the `Invocation#success?` and `Invocation#error?` methods also provide more intuitive access to the finished state. If the event finished with `:success`, you may retrieve the returned value of the event Proc by calling `Invocation#returned_value`. If the event finished with `:error`, you may get the Exception with `Invocation#error`.
+
+Because many callbacks can be registered for a particular namespace, each needing its own Invocation object, the `Theatre#trigger` method returns an Array of Invocation objects.
+
+    # We'll assume only one callback is registered and call #first on the Array of Invocations returned by #trigger
+    invocation = my_theatre.trigger("your/namespace/here", YourSpecialClass.new("this can be anything")).first
+    invocation.wait
+    raise invocation.error if invocation.error?
+    log "Actor finished with return value #{invocation.returned_value}"
+
+Ruby 1.8 vs. Ruby 1.9 vs. JRuby
+-------------------------------
+
+Theatre was created for Ruby 1.8 because no good Actor system existed on Ruby 1.8 that met Adhearsion's needs (e.g. hierarchal with synchronous and asynchronous modes. If you wish to achieve real processor-level concurrency, use JRuby.
+
+Presently Ruby 1.9 compatibility is not a priority but patches for compatibility will be accepted, as long as they preserve compatibility with both MRI and JRuby.

data/lib/theatre/callback_definition_loader.rb

@@ -0,0 +1,84 @@
+module Theatre
+  
+  ##
+  # This class provides the a wrapper aroung which an events.rb file can be instance_eval'd.
+  #
+  class CallbackDefinitionLoader
+    
+    attr_reader :theatre, :root_name
+    def initialize(theatre, root_name=:events)
+      @theatre   = theatre
+      @root_name = root_name
+      
+      create_recorder_method root_name
+    end
+    
+    def anonymous_recorder
+      BlankSlateMessageRecorder.new(&method(:callback_registered))
+    end
+    
+    ##
+    # Parses the given Ruby source code file and returns this object.
+    #
+    # @param [String, File] file The filename or File object for the Ruby source code file to parse.
+    #
+    def load_events_file(file)
+      file = File.open(file) if file.kind_of? String
+      instance_eval file.read, file.path
+      self
+    end
+    
+    ##
+    # Parses the given Ruby source code and returns this object.
+    #
+    # NOTE: Only use this if you're generating the code yourself! If you're loading a file from the filesystem, you should
+    # use load_events_file() since load_events_file() will properly attribute errors in the code to the file from which the
+    # code was loaded.
+    #
+    # @param [String] code The Ruby source code to parse
+    #
+    def load_events_code(code)
+      instance_eval code
+      self
+    end
+    
+    protected
+    
+    ##
+    # Immediately register the namespace and callback with the Theatre instance given to the constructor. This method is only
+    # called when a new BlankSlateMessageRecorder is instantiated and receives #each().
+    #
+    def callback_registered(namespaces, callback)
+      # Get rid of all arguments passed to the namespaces. Will support arguments in the future.
+      namespaces = namespaces.map { |namespace| namespace.first }
+      
+      theatre.namespace_manager.register_callback_at_namespace namespaces, callback
+    end
+    
+    def create_recorder_method(record_method_name)
+      (class << self; self; end).send(:alias_method, record_method_name, :anonymous_recorder)
+    end
+    
+    class BlankSlateMessageRecorder
+      
+      (instance_methods - %w[__send__ __id__]).each { |m| undef_method m }
+      
+      def initialize(&notify_on_completion)
+        @notify_on_completion = notify_on_completion
+        @namespaces = []
+      end
+      
+      def method_missing(*method_name_and_args)
+        raise ArgumentError, "Supplying a block is not supported" if block_given?
+        @namespaces << method_name_and_args
+        self
+      end
+      
+      def each(&callback)
+        @notify_on_completion.call(@namespaces, callback)
+      end
+      
+    end
+    
+  end
+end

data/lib/theatre/guid.rb

@@ -0,0 +1,23 @@
+# Right now Adhearsion also defines this method. The eventual solution will be to extract the Adhearsion features on which
+# Theatre depends and make that a dependent library.
+
+unless respond_to? :new_guid
+  
+  def random_character
+    case random_digit = rand(62)
+      when  0...10 : random_digit.to_s
+      when 10...36 : (random_digit + 55).chr
+      when 36...62 : (random_digit + 61).chr
+    end
+  end
+  
+  def random_string(length_of_string=8)
+    Array.new(length_of_string) { random_character }.join
+  end
+  
+  # This GUID implementation doesn't adhere to the RFC which wants to make certain segments based on the MAC address of a
+  # network interface card and other wackiness. It's sufficiently random for our needs.
+  def new_guid
+    [8,4,4,4,12].map { |segment_length| random_string(segment_length) }.join('-')
+  end
+end

data/lib/theatre/invocation.rb

@@ -0,0 +1,121 @@
+require 'theatre/guid'
+require 'thread'
+require 'monitor'
+
+module Theatre
+  
+  ##
+  # An Invocation is an object which Theatre generates and returns from Theatre#trigger.
+  #
+  class Invocation
+    
+    attr_reader :queued_time, :started_time, :finished_time, :unique_id, :callback, :namespace, :error, :returned_value
+    
+    class InvalidStateError < Exception; end
+    
+    ##
+    # Create a new Invocation.
+    #
+    # @param [String] namespace The "/foo/bar/qaz" path to the namespace to which this Invocation belongs.
+    # @param [Proc] callback The block which should be executed by an Actor scheduler.
+    # @param [Object] payload The message that will be sent to the callback for processing.
+    #
+    def initialize(namespace, callback, payload=:theatre_no_payload)
+      raise ArgumentError, "Callback must be a Proc" unless callback.kind_of? Proc
+      @payload       = payload
+      @unique_id     = new_guid.freeze
+      @callback      = callback
+      @current_state = :new
+      @state_lock    = Mutex.new
+      
+      # Used just to protect access to the @returned_value instance variable
+      @returned_value_lock = Monitor.new
+      
+      # Used when wait() is called to notify all waiting threads by using a ConditionVariable
+      @returned_value_blocker = Monitor::ConditionVariable.new @returned_value_lock
+    end
+    
+    def queued
+      with_state_lock do
+        raise InvalidStateError unless @current_state == :new
+        @current_state = :queued
+        @queued_time = Time.now.freeze
+      end
+      true
+    end
+    
+    def current_state
+      with_state_lock { @current_state }
+    end
+    
+    def start
+      with_state_lock do
+        raise InvalidStateError unless @current_state == :queued
+        @current_state = :running
+      end
+      @started_time = Time.now.freeze
+      
+      begin
+        self.returned_value = if @payload.equal? :theatre_no_payload
+          @callback.call
+        else
+          @callback.call @payload
+        end
+        with_state_lock { @current_state = :success }
+      rescue => @error
+        with_state_lock { @current_state = :error }
+      ensure
+        @finished_time = Time.now.freeze
+      end
+    end
+    
+    def execution_duration
+      return nil unless @finished_time
+      @finished_time - @started_time
+    end
+    
+    def error?
+      current_state.equal? :error
+    end
+    
+    def success?
+      current_state.equal? :success
+    end
+    
+    ##
+    # When this Invocation has been queued, started, and entered either the :success or :error state, this method will
+    # finally return. Until then, it blocks the Thread.
+    #
+    # @return [Object] The result of invoking this Invocation's callback
+    #
+    def wait
+      with_returned_value_lock { return @returned_value if defined? @returned_value }
+      @returned_value_blocker.wait
+      # Return the returned_value
+      with_returned_value_lock { @returned_value }
+    end
+    
+    protected
+    
+    ##
+    # Protected setter which does some other housework when the returned value is found (such as notifying wait()ers)
+    #
+    # @param [returned_value] The value to set this returned value to.
+    #
+    def returned_value=(returned_value)
+      with_returned_value_lock do
+        @returned_value = returned_value
+        @returned_value_blocker.broadcast
+      end
+    end
+    
+    def with_returned_value_lock(&block)
+      @returned_value_lock.synchronize(&block)
+    end
+    
+    def with_state_lock(&block)
+      @state_lock.synchronize(&block)
+    end
+    
+  end
+end