rene-adhearsion 0.8.6

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{instance_eval object_id}).each { |method| undef_method method unless method =~ /^__/ }
+
+      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 then random_digit.to_s
+      when 10...36 then (random_digit + 55).chr
+      when 36...62 then (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 < StandardError; 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 = @returned_value_lock.new_cond#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

data/lib/theatre/namespace_manager.rb

@@ -0,0 +1,153 @@
+module Theatre
+
+  ##
+  # Manages the hierarchial namespaces of a Theatre. This class is Thread-safe.
+  #
+  class ActorNamespaceManager
+
+    VALID_NAMESPACE = %r{^(/[\w_]+)+$}
+
+    class << self
+      def valid_namespace_path?(namespace_path)
+        namespace_path =~ VALID_NAMESPACE
+      end
+
+      ##
+      # Since there are a couple ways to represent namespaces, this is a helper method which will normalize
+      # them into the most practical: an Array of Symbols
+      # @param [String, Array] paths The namespace to register. Can be in "/foo/bar" or *[foo,bar] format
+      def normalize_path_to_array(paths)
+        paths = paths.is_a?(Array) ? paths.flatten : Array(paths)
+        paths.map! { |path_segment| path_segment.kind_of?(String) ? path_segment.split('/') : path_segment }
+        paths.flatten!
+        paths.reject! { |path| path.nil? || (path.kind_of?(String) && path.empty?) }
+        paths.map { |path| path.to_sym }
+      end
+
+    end
+
+    def initialize
+      @registry_lock = Mutex.new
+      @root          = RootNamespaceNode.new
+    end
+
+    ##
+    # Have this registry recognize a new path and prepare it for callback registrations. All path segements will be created
+    # in order. For example, when registering "/foo/bar/qaz" when no namespaces at all have been registered, this method will
+    # first register "foo", then "bar", then "qaz". If the namespace was already registered, it will not be affected.
+    #
+    # @param [String, Array] paths The namespace to register. Can be in "/foo/bar" or *[foo,bar] format
+    # @return [NamespaceNode] The NamespaceNode representing the path given.
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def register_namespace_name(*paths)
+      paths = self.class.normalize_path_to_array paths
+
+      paths.inject(@root) do |node, name|
+        node.register_namespace_name name
+      end
+    end
+
+    ##
+    # Returns a Proc found after searching with the namespace you provide
+    #
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def callbacks_for_namespaces(*paths)
+      search_for_namespace(paths).callbacks
+    end
+
+    ##
+    # Find a namespace in the tree.
+    #
+    # @param [Array, String] paths Must be an Array of segments or a name like "/foo/bar/qaz"
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def search_for_namespace(paths)
+      paths = self.class.normalize_path_to_array paths
+      path_string = "/"
+
+      found_namespace = paths.inject(@root) do |last_node,this_node_name|
+        raise NamespaceNotFound.new(path_string) if last_node.nil?
+        path_string << this_node_name.to_s
+        last_node.child_named this_node_name
+      end
+      raise NamespaceNotFound.new("/#{paths.join('/')}") unless found_namespace
+      found_namespace
+    end
+
+    ##
+    # Registers the given callback at a namespace, assuming the namespace was already registered.
+    #
+    # @param [Array] paths Must be an Array of segments
+    # @param [Proc] callback
+    # @raise NamespaceNotFound if a segment has not been registered yet
+    #
+    def register_callback_at_namespace(paths, callback)
+      raise ArgumentError, "callback must be a Proc" unless callback.kind_of? Proc
+      search_for_namespace(paths).register_callback callback
+    end
+
+    protected
+
+    ##
+    # Used by NamespaceManager to build a tree of namespaces. Has a Hash of children which is not
+    # Thread-safe. For Thread-safety, all access should semaphore through the NamespaceManager.
+    class NamespaceNode
+
+      attr_reader :name
+      def initialize(name)
+        @name = name.freeze
+        @children  = {}
+        @callbacks = []
+      end
+
+      def register_namespace_name(name)
+        @children[name] ||= NamespaceNode.new(name)
+      end
+
+      def register_callback(callback)
+        @callbacks << callback
+        callback
+      end
+
+      def callbacks
+        @callbacks.clone
+      end
+
+      def delete_callback(callback)
+        @callbacks.delete callback
+      end
+
+      def child_named(name)
+        @children[name]
+      end
+
+      def destroy_namespace(name)
+        @children.delete name
+      end
+
+      def root?
+        false
+      end
+
+    end
+
+    class RootNamespaceNode < NamespaceNode
+      def initialize
+        super :ROOT
+      end
+      def root?
+        true
+      end
+    end
+
+  end
+
+  class NamespaceNotFound < StandardError
+    def initialize(full_path)
+      super "Could not find #{full_path.inspect} in the namespace registry. Did you register it yet?"
+    end
+  end
+
+end

data/lib/theatre/version.rb

@@ -0,0 +1,2 @@
+THEATRE_VERSION_MAJOR, THEATRE_VERSION_MINOR, THEATRE_VERSION_REVISION = THEATRE_VERSION = [0,8,1]
+THEATRE_VERSION_STRING = THEATRE_VERSION.join '.'

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification 
+name: rene-adhearsion
+version: !ruby/object:Gem::Version 
+  version: 0.8.6
+platform: ruby
+authors: 
+- Jay Phillips
+- Jason Goecke
+- Ben Klang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Adhearsion is an open-source telephony development framework
+email: dev&Adhearsion.com
+executables: 
+- ahn
+- ahnctl
+- jahn
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- adhearsion.gemspec
+- app_generators/ahn/ahn_generator.rb
+- app_generators/ahn/templates/.ahnrc
+- app_generators/ahn/templates/components/ami_remote/ami_remote.rb
+- app_generators/ahn/templates/components/disabled/HOW_TO_ENABLE
+- app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.yml
+- app_generators/ahn/templates/components/disabled/stomp_gateway/README.markdown
+- app_generators/ahn/templates/components/disabled/stomp_gateway/stomp_gateway.rb
+- app_generators/ahn/templates/components/disabled/sandbox/sandbox.rb
+- app_generators/ahn/templates/components/disabled/sandbox/sandbox.yml
+- app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.yml
+- app_generators/ahn/templates/components/disabled/restful_rpc/example-client.rb
+- app_generators/ahn/templates/components/disabled/restful_rpc/README.markdown
+- app_generators/ahn/templates/components/disabled/restful_rpc/restful_rpc.rb
+- app_generators/ahn/templates/components/disabled/restful_rpc/spec/restful_rpc_spec.rb
+- app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.rb
+- app_generators/ahn/templates/components/disabled/xmpp_gateway/xmpp_gateway.yml
+- app_generators/ahn/templates/components/disabled/xmpp_gateway/README.markdown
+- app_generators/ahn/templates/components/simon_game/simon_game.rb
+- app_generators/ahn/templates/config/startup.rb
+- app_generators/ahn/templates/dialplan.rb
+- app_generators/ahn/templates/events.rb
+- app_generators/ahn/templates/Rakefile
+- app_generators/ahn/templates/README
+- app_generators/ahn/USAGE
+- bin/ahn
+- bin/ahnctl
+- bin/jahn
+- CHANGELOG
+- EVENTS
+- examples/asterisk_manager_interface/standalone.rb
+- lib/adhearsion.rb
+- lib/adhearsion/cli.rb
+- lib/adhearsion/component_manager.rb
+- lib/adhearsion/component_manager/component_tester.rb
+- lib/adhearsion/component_manager/spec_framework.rb
+- lib/adhearsion/events_support.rb
+- lib/adhearsion/foundation/all.rb
+- lib/adhearsion/foundation/blank_slate.rb
+- lib/adhearsion/foundation/custom_daemonizer.rb
+- lib/adhearsion/foundation/event_socket.rb
+- lib/adhearsion/foundation/future_resource.rb
+- lib/adhearsion/foundation/metaprogramming.rb
+- lib/adhearsion/foundation/numeric.rb
+- lib/adhearsion/foundation/pseudo_guid.rb
+- lib/adhearsion/foundation/relationship_properties.rb
+- lib/adhearsion/foundation/string.rb
+- lib/adhearsion/foundation/synchronized_hash.rb
+- lib/adhearsion/foundation/thread_safety.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/ldap.rb
+- lib/adhearsion/initializer/drb.rb
+- lib/adhearsion/initializer/freeswitch.rb
+- lib/adhearsion/initializer/rails.rb
+- lib/adhearsion/initializer/xmpp.rb
+- lib/adhearsion/logging.rb
+- lib/adhearsion/tasks.rb
+- lib/adhearsion/tasks/database.rb
+- lib/adhearsion/tasks/deprecations.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/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/manager_interface.rb
+- lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rb
+- lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rl.rb
+- lib/adhearsion/voip/asterisk/manager_interface/ami_messages.rb
+- lib/adhearsion/voip/asterisk/manager_interface/ami_protocol_lexer_machine.rl
+- lib/adhearsion/voip/asterisk/special_dial_plan_managers.rb
+- lib/adhearsion/voip/asterisk/super_manager.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
+- lib/adhearsion/xmpp/connection.rb
+- lib/theatre.rb
+- lib/theatre/callback_definition_loader.rb
+- lib/theatre/guid.rb
+- lib/theatre/invocation.rb
+- lib/theatre/namespace_manager.rb
+- lib/theatre/README.markdown
+- lib/theatre/version.rb
+- LICENSE
+- Rakefile
+has_rdoc: true
+homepage: http://adhearsion.com
+licenses: []
+
+post_install_message: "    *******************************************************************\n    * NOTE: You must manually install the \"rubigen\" gem to create     *\n    * new Adhearsion applications.                                    *\n    *                                                                 *\n    * The Rubigen package is no longer automatically installed due to *\n    * dependency conflicts with ActiveSupport 3.0.                    *\n    * Users of existing Adhearsion applications can safely ignore     *\n    * this message.                                                   *\n    *******************************************************************\n"
+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.3.5
+signing_key: 
+specification_version: 2
+summary: Adhearsion, open-source telephony development framework
+test_files: []
+