jicksta-adhearsion 0.7.999

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 < Exception
+    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 '.'

data/lib/theatre.rb

@@ -0,0 +1,151 @@
+require 'thread'
+require 'rubygems'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'theatre/version'
+require 'theatre/namespace_manager'
+require 'theatre/invocation'
+require 'theatre/callback_definition_loader'
+
+module Theatre
+  
+  class Theatre
+    
+    attr_reader :namespace_manager
+    
+    ##
+    # Creates a new stopped Theatre. You must call start!() after you instantiate this for it to begin processing events.
+    #
+    # @param [Fixnum] thread_count Number of Threads to spawn when started.
+    #
+    def initialize(thread_count=6)
+      @thread_count      = thread_count
+      @started           = false
+      @namespace_manager = ActorNamespaceManager.new
+      @thread_group      = ThreadGroup.new
+      @master_queue      = Queue.new
+      @loader_mixins     = []
+    end
+    
+    ##
+    # Send a message to this Theatre for asynchronous processing.
+    #
+    # @param [String] namespace The namespace to which the payload should be sent
+    # @param [Object] payload The actual content to be sent to the callback. Optional.
+    # @return [Array<Theatre::Invocation>] An Array of Invocation objects
+    # @raise Theatre::NamespaceNotFound Raised when told to enqueue an unrecognized namespace
+    #
+    def trigger(namespace, payload=:argument_undefined)
+      @namespace_manager.callbacks_for_namespaces(namespace).map do |callback|
+        invocation = if payload.equal?(:argument_undefined)
+          Invocation.new(namespace, callback)
+        else
+          Invocation.new(namespace, callback, payload)
+        end
+        invocation.queued
+        @master_queue << invocation
+        invocation
+      end
+    end
+    
+    ##
+    # Send a message to this Theatre for synchronous processing. The execution of this will not go through this Theatre's
+    # Thread pool. If an error occurred in any of callbacks, the Exception object will be placed in the returned Array 
+    # instead for you to act upon.
+    #
+    # @param [String] namespace The namespace to which the payload should be sent
+    # @param [Object] payload The actual content to be sent to the callback. Optional.
+    # @return [Array] An Array containing each callback's return value (or Exception raised, if any) when given the payload
+    # @raise Theatre::NamespaceNotFound Raised when told to enqueue an unrecognized namespace
+    #
+    def trigger_immediately(namespace, payload=:argument_undefined)
+      @namespace_manager.callbacks_for_namespaces(namespace).map do |callback|
+        begin
+          invocation = if payload.equal?(:argument_undefined)
+            callback.call
+          else
+            callback.call payload
+          end
+        rescue => captured_error_to_be_returned
+          captured_error_to_be_returned
+        end
+      end
+    end
+    
+    def load_events_code(code, *args)
+      loader = CallbackDefinitionLoader.new(self, *args)
+      loader.load_events_code code
+    end
+    
+    def load_events_file(file, *args)
+      loader = CallbackDefinitionLoader.new(self, *args)
+      loader.load_events_file file
+    end
+    
+    def register_namespace_name(*args)
+      @namespace_manager.register_namespace_name(*args)
+    end
+    
+    def register_callback_at_namespace(*args)
+      @namespace_manager.register_callback_at_namespace(*args)
+    end
+    
+    def register_loader_mixin(mod)
+      @loader_mixins << mod
+    end
+    
+    def join
+      @thread_group.list.each do |thread|
+        begin
+          thread.join
+        rescue
+          # Ignore any exceptions
+        end
+      end
+    end
+    
+    ##
+    # Starts this Theatre.
+    #
+    # When this method is called, the Threads are spawned and begin pulling messages off this Theatre's master queue.
+    #
+    def start!
+      return false if @thread_group.list.any? # Already started
+      @started_time = Time.now
+      @thread_count.times do
+        @thread_group.add Thread.new(&method(:thread_loop))
+      end
+    end
+    
+    ##
+    # Notifies all Threads for this Theatre to stop by sending them special messages. Any messages which were queued and
+    # untriggered when this method is received will still be processed. Note: you may start this Theatre again later once it
+    # has been stopped.
+    #
+    def graceful_stop!
+      @thread_count.times { @master_queue << :THEATRE_SHUTDOWN! }
+      @started_time = nil
+    end
+    
+    protected
+    
+    # This will use the Adhearsion logger eventually.
+    def warn(exception)
+      # STDERR.puts exception.message, *exception.backtrace
+    end
+    
+    def thread_loop
+      loop do
+        begin
+          next_invocation = @master_queue.pop
+          return :stopped if next_invocation.equal? :THEATRE_SHUTDOWN!
+          next_invocation.start
+        rescue => error
+          warn error
+        end
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: jicksta-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
+- 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/config.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/restful_rpc/config.yml
+- app_generators/ahn/templates/components/restful_rpc/example-client.rb
+- app_generators/ahn/templates/components/restful_rpc/README.markdown
+- app_generators/ahn/templates/components/restful_rpc/restful_rpc.rb
+- 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/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/global.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/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/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/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
+- README.txt
+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: []
+