serf 0.9.0 → 0.10.0

data/lib/serf/serfer.rb

@@ -1,145 +1,87 @@
-require 'active_support/core_ext/hash/keys'
+require 'hashie'
 
 require 'serf/error'
+require 'serf/errors/not_found'
 require 'serf/util/error_handling'
+require 'serf/util/null_object'
 
 module Serf
 
+  ##
+  # Class to drive the command handler execution, error handling, etc
+  # of received messages.
   class Serfer
-    include ::Serf::Util::ErrorHandling
+    include Serf::Util::ErrorHandling
+
+    attr_reader :route_set
+    attr_reader :response_channel
+    attr_reader :error_channel
+    attr_reader :logger
 
     def initialize(*args)
       extract_options! args
 
-      # Map of Runners to Registries
-      @registries = opts :registries, {}
-
-      # Additional serf infrastructure options to pass to Endpoints#build.
-      @serf_options = opts :serf_options, {}
-
-      # Options for handling the requests
-      @not_found = opts :not_found, lambda { |env|
-        raise ArgumentError, 'Handler Not Found'
-      }
+      @route_set = opts! :route_set
+      @response_channel = opts(:response_channel) { Serf::Util::NullObject }
+      @error_channel = opts(:error_channel) { Serf::Util::NullObject }
+      @logger = opts(:logger) { Serf::Util::NullObject }
     end
 
     ##
     # Rack-like call to run a set of handlers for a message
     #
     def call(env)
-      # We normalize by symbolizing the env keys
-      env = env.symbolize_keys
-
-      # Call the processor
-      matched, results = process_request env
-
-      # If we don't have any handlers, do the not_found call.
-      # NOTE: Purposefully not wrapping this in exception handling.
-      return @not_found.call env unless matched > 0
-
+      env = Hashie::Mash.new env unless env.is_a? Hashie::Mash
+
+      # We normalize by making the request a Hashie Mash
+      message = Hashie::Mash.new env.message
+      context = Hashie::Mash.new env.context
+
+      # Resolve the routes that we want to run
+      routes = route_set.resolve message, context
+
+      # We raise an error if no routes were found.
+      raise Serf::Errors::NotFound unless routes.size > 0
+
+      # For each route, we're going to execute
+      results = routes.map { |route|
+        # 1. Check request+context with the policies (RAISE)
+        # 2. Execute command (RETURNS Hash)
+        ok, res = with_error_handling(
+            message: message,
+            options: context) do
+          route.check_policies! message, context
+          route.execute! message, context
+        end
+        # Return the run_results as result of this block.
+        res
+      }.flatten.select { |r| r }
+      push_results results, context
       return results
     rescue => e
-      e.extend(::Serf::Error)
+      e.extend(Serf::Error)
       raise e
     end
-    alias_method :push, :call
-    alias_method :<<, :call
 
-    def self.build(options={})
-      self.new options
+    def self.build(*args, &block)
+      new *args, &block
     end
 
-    protected
+    private
 
     ##
-    # Do the work of processing the env.
-    # 1. Match our endpoints to run, keep associated with their runner.
-    # 2. Turn endpoints into actual handlers that can be called by runners.
-    # 3. Call runner to process the endpoints
-    # 4. Return results
-    #
-    # NOTES:
-    # * Any error in matching will be raised to the caller, not absorbed by
-    #   the error handler.
-    # * Any error in Handler creation from endpoint will be caught by the
-    #   error handler, (1) pushed to the error channel and (2)
-    #   an error event will included in the results pass back to caller.
-    #   (a) There may be successul handlers created that can complete.
-    # * If the runner raises an error, it will be caught and the error
-    #   event will be appended to the results. This is so one
-    #   runner failure will not affect another runner's run.
-    #   Each runner SHOULD do their own error handling so errors in
-    #   one handler will not affect another in the list of handlers the runner
-    #   is to process.
-    # * RUNNERS MUST push errors they catch to the error channel.
-    #
-    def process_request(env)
-      # This will be the work we need to do.
-      # This is a hash of runners to handlers to run.
-      tasks = {}
-
-      # We're going to concat all the results
-      results = []
-
-      # Figure out which endpoints to run.
-      matches = match_endpoints env
-
-      # Now we go head and create our Tasks (Units of Work)
-      # for each of the matched endpoints (with their runners).
-      matches.each do |runner, endpoints|
-        # We create the unit of work
-        handlers = endpoints.map{ |endpoint|
-          # We try to build the endpoint. Any errors here will
-          # be caught and returned to the caller.
-          # This is so individual building of tasks do not affect other tasks.
-          ok, obj = with_error_handling(env) do
-            endpoint.build env.dup, @serf_options
-          end
-          # The return of this if/else statement will be result of map item.
-          if ok
-            obj
-          else
-            results << obj
-            nil
-          end
-        }.
-        select{ |h| !h.nil? }
-
-        # No we enqueue the units of work into our task queue
-        # List could be empty because all build calls could have error out.
-        tasks[runner] = handlers if handlers.size > 0
-      end
-
-      # We call the runners with the handlers they need to execute.
-      # Errors raised by the runner are pushed to the error channel.
-      # Errors here are also passed back the caller of the SerfApp.
-      #
-      tasks.each do |runner, handlers|
-        ok, run_result = with_error_handling(env) do
-          runner.call handlers, env
+    # Loop over the results and push them to the response channel.
+    # Any error in pushing individual messages will result in
+    # a log event and an error channel event.
+    def push_results(results, context)
+      results.each do |result|
+        with_error_handling(result) do
+          response_channel.push(
+            message: result,
+            context: context)
         end
-        # We need to coerce the runner's results (nil, Hash, Array, Object)
-        # into an Array of messages.
-        # now we concat this run's results to our total results list.
-        run_result = run_result.is_a?(Hash) ? [run_result] : Array(run_result)
-        results.concat run_result
       end
-
-      return matches.size, results
-    end
-
-    ##
-    # Figure out which endpoints to run
-    #
-    def match_endpoints(env)
-      matches = {}
-
-      @registries.each do |runner, registry|
-        endpoints = registry.match env
-        matches[runner] = endpoints if endpoints.size > 0
-      end
-
-      return matches
+      return nil
     end
 
   end

data/lib/serf/util/error_handling.rb

@@ -22,13 +22,9 @@ module Util
     ##
     # A block wrapper to handle errors when executing a block.
     #
-    def with_error_handling(context=nil, errback=:handle_error, &block)
-      ok, results = protected_call &block
-      return ok, (ok ?
-        results :
-        ((errback.is_a?(Proc) ?
-          errback.call(results, context) :
-          send(errback, results, context))))
+    def with_error_handling(context=nil, *args, &block)
+      ok, results = pcall *args, &block
+      return ok, (ok ? results : handle_error(results, context))
     end
 
     ##
@@ -38,8 +34,8 @@ module Util
     # log the exception itself to the logger.
     #
     def handle_error(e, context=nil)
-      logger = opts :logger, ::Serf::Util::NullObject.new
-      error_channel = opts :error_channel, ::Serf::Util::NullObject.new
+      logger = opts(:logger){ ::Serf::Util::NullObject.new }
+      error_channel = opts(:error_channel) { ::Serf::Util::NullObject.new }
       error_event = {
         kind: 'serf/messages/caught_exception_event',
         context: context,

data/lib/serf/util/options_extraction.rb

@@ -1,3 +1,5 @@
+require 'hashie'
+
 module Serf
 module Util
 
@@ -29,7 +31,7 @@ module Util
     # Reader method for the options hash.
     #
     def options
-      return @options || {}
+      return @options || Hashie::Mash.new
     end
 
     ##
@@ -92,12 +94,21 @@ module Util
     protected
 
     ##
-    # Extracts the options from the arguments list.
+    # Extracts the options from the arguments list, BUT does not save it to
+    # an instance variable for use by the opts helpr methods.
+    #
+    def pop_options!(args)
+      args.last.is_a?(::Hash) ?
+        [true, Hashie::Mash.new(args.pop)] :
+        [false, Hashie::Mash.new]
+    end
+
+    ##
+    # Extracts the options from the arguments list, and saves it to the
+    # an instance variable for use by the opts helpr methods.
     #
     def extract_options!(args)
-      _, @options = args.last.is_a?(::Hash) ?
-        [true, args.pop.dup] :
-        [false, {}]
+      _, @options = pop_options! args
     end
 
   end

data/lib/serf/util/protected_call.rb

@@ -23,11 +23,12 @@ module Util
     #
     # @return boolean success and the block's (or caught exception) results.
     #
-    def protected_call
-      return true, yield
+    def pcall(*args)
+      return true, yield(*args)
     rescue => e
       return false, e
     end
+    alias_method :protected_call, :pcall
 
   end
 

data/lib/serf/util/uuidable.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'hashie'
 require 'uuidtools'
 
 module Serf
@@ -12,6 +13,30 @@ module Util
   #
   module Uuidable
 
+    ##
+    # @see self.create_coded_uuid
+    def create_coded_uuid
+      Uuidable.create_coded_uuid
+    end
+
+    ##
+    # @see self.parse_coded_uuid
+    def parse_coded_uuid(coded_uuid)
+      Uuidable.parse_coded_uuid coded_uuid
+    end
+
+    ##
+    # @see self.create_uuids
+    def create_uuids(parent={})
+      Uuidable.create_uuids parent
+    end
+
+    ##
+    # @see self.annotate_with_uuids!
+    def annotate_with_uuids!(message, parent={})
+      Uuidable.annotate_with_uuids! message, parent
+    end
+
     ##
     # Creates a Timestamp UUID, base64 encoded.
     #
@@ -38,14 +63,13 @@ module Util
     # Create a new set of uuids.
     #
     def self.create_uuids(parent={})
-      {
+      Hashie::Mash.new(
         uuid: create_coded_uuid,
-        parent_uuid: parent['uuid'],
+        parent_uuid: parent[:uuid],
         origin_uuid: (
           parent[:origin_uuid] ||
           parent[:parent_uuid] ||
-          parent[:uuid])
-      }
+          parent[:uuid]))
     end
 
     ##

data/lib/serf/version.rb

@@ -2,7 +2,7 @@ module Serf
 
   module Version
     MAJOR = 0
-    MINOR = 9
+    MINOR = 10
     PATCH = 0
     BUILD = nil
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join '.'

data/serf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "serf"
-  s.version = "0.9.0"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Yu"]
-  s.date = "2012-05-06"
+  s.date = "2012-05-30"
   s.description = "Event-Driven SOA with CQRS"
   s.email = "benjaminlyu@gmail.com"
   s.extra_rdoc_files = [
@@ -30,21 +30,18 @@ Gem::Specification.new do |s|
     "lib/serf/builder.rb",
     "lib/serf/command.rb",
     "lib/serf/error.rb",
+    "lib/serf/errors/not_found.rb",
+    "lib/serf/middleware/girl_friday_async.rb",
+    "lib/serf/middleware/masherize.rb",
     "lib/serf/middleware/uuid_tagger.rb",
-    "lib/serf/more/command_worker.rb",
-    "lib/serf/routing/endpoint.rb",
-    "lib/serf/routing/registry.rb",
-    "lib/serf/runners/direct.rb",
-    "lib/serf/runners/event_machine.rb",
-    "lib/serf/runners/girl_friday.rb",
-    "lib/serf/runners/helper.rb",
+    "lib/serf/routing/regexp_matcher.rb",
+    "lib/serf/routing/route.rb",
+    "lib/serf/routing/route_set.rb",
     "lib/serf/serfer.rb",
     "lib/serf/util/error_handling.rb",
-    "lib/serf/util/mash_factory.rb",
     "lib/serf/util/null_object.rb",
     "lib/serf/util/options_extraction.rb",
     "lib/serf/util/protected_call.rb",
-    "lib/serf/util/regexp_matcher.rb",
     "lib/serf/util/uuidable.rb",
     "lib/serf/version.rb",
     "schemas/caught_exception_event.json",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serf
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-06 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70100670653360 !ruby/object:Gem::Requirement
+  requirement: &70327288822860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70100670653360
+  version_requirements: *70327288822860
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70100670652560 !ruby/object:Gem::Requirement
+  requirement: &70327288821320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70100670652560
+  version_requirements: *70327288821320
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70100670651180 !ruby/object:Gem::Requirement
+  requirement: &70327288843640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70100670651180
+  version_requirements: *70327288843640
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70100670649260 !ruby/object:Gem::Requirement
+  requirement: &70327288842560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70100670649260
+  version_requirements: *70327288842560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70100670647520 !ruby/object:Gem::Requirement
+  requirement: &70327288841020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70100670647520
+  version_requirements: *70327288841020
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70100670646500 !ruby/object:Gem::Requirement
+  requirement: &70327288839480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70100670646500
+  version_requirements: *70327288839480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70100670814180 !ruby/object:Gem::Requirement
+  requirement: &70327288837820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70100670814180
+  version_requirements: *70327288837820
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70100670813540 !ruby/object:Gem::Requirement
+  requirement: &70327288847420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70100670813540
+  version_requirements: *70327288847420
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70100670812840 !ruby/object:Gem::Requirement
+  requirement: &70327288845020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70100670812840
+  version_requirements: *70327288845020
 - !ruby/object:Gem::Dependency
   name: log4r
-  requirement: &70100670812100 !ruby/object:Gem::Requirement
+  requirement: &70327288859780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 1.1.10
   type: :development
   prerelease: false
-  version_requirements: *70100670812100
+  version_requirements: *70327288859780
 - !ruby/object:Gem::Dependency
   name: msgpack
-  requirement: &70100670811380 !ruby/object:Gem::Requirement
+  requirement: &70327288858080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: 0.4.6
   type: :development
   prerelease: false
-  version_requirements: *70100670811380
+  version_requirements: *70327288858080
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70100670810700 !ruby/object:Gem::Requirement
+  requirement: &70327288857320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: 0.12.10
   type: :development
   prerelease: false
-  version_requirements: *70100670810700
+  version_requirements: *70327288857320
 - !ruby/object:Gem::Dependency
   name: girl_friday
-  requirement: &70100670809960 !ruby/object:Gem::Requirement
+  requirement: &70327288856640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: 0.9.7
   type: :development
   prerelease: false
-  version_requirements: *70100670809960
+  version_requirements: *70327288856640
 description: Event-Driven SOA with CQRS
 email: benjaminlyu@gmail.com
 executables: []
@@ -175,21 +175,18 @@ files:
 - lib/serf/builder.rb
 - lib/serf/command.rb
 - lib/serf/error.rb
+- lib/serf/errors/not_found.rb
+- lib/serf/middleware/girl_friday_async.rb
+- lib/serf/middleware/masherize.rb
 - lib/serf/middleware/uuid_tagger.rb
-- lib/serf/more/command_worker.rb
-- lib/serf/routing/endpoint.rb
-- lib/serf/routing/registry.rb
-- lib/serf/runners/direct.rb
-- lib/serf/runners/event_machine.rb
-- lib/serf/runners/girl_friday.rb
-- lib/serf/runners/helper.rb
+- lib/serf/routing/regexp_matcher.rb
+- lib/serf/routing/route.rb
+- lib/serf/routing/route_set.rb
 - lib/serf/serfer.rb
 - lib/serf/util/error_handling.rb
-- lib/serf/util/mash_factory.rb
 - lib/serf/util/null_object.rb
 - lib/serf/util/options_extraction.rb
 - lib/serf/util/protected_call.rb
-- lib/serf/util/regexp_matcher.rb
 - lib/serf/util/uuidable.rb
 - lib/serf/version.rb
 - schemas/caught_exception_event.json
@@ -212,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2754574147578555547
+      hash: 2408210682612837552
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/serf/more/command_worker.rb

@@ -1,45 +0,0 @@
-require 'serf/command'
-require 'serf/util/error_handling'
-
-module Serf
-module More
-
-  ##
-  # Creates a proc (CommandWorker.worker) that will be used by
-  # GirlFriday WorkQueues. This proc will receive messages from
-  # GirlFriday and will (1) create a CommandWorker instance with the
-  # given message and (2) execute (#call) said CommandWorker instance.
-  # The CommandWorker instance assumes that the received message is
-  # a callable (#call) object, and will execute that object's 'call' method.
-  #
-  # The purpose of this is so we can build Command objects in one
-  # context/thread and have it actually executed in a separate threadpool.
-  #
-  # Example:
-  #
-  #   # Creates the GirlFriday work queue.
-  #   command_worker_queue = GirlFriday::WorkQueue.new(
-  #     CommandWorker.worker(
-  #       logger: my_logger,
-  #       response_channel: response_channel,
-  #       error_channel: error_channel))
-  #
-  #   # In some place that receives requests and generates commands.
-  #   # Push the command into the command workqueue for async processing.
-  #   command_worker_queue.push MyCommand.build(REQUEST_HASH)
-  #
-  class CommandWorker
-    include Serf::Command
-    include Serf::ErrorHandling
-
-    def call
-      ok, results = with_error_handling do
-        request.call
-      end
-      return results
-    end
-
-  end
-
-end
-end