serf 0.3.0 → 0.4.0

data/Gemfile

@@ -4,7 +4,6 @@ source 'http://rubygems.org'
 #   gem 'activesupport', '>= 2.3.5'
 
 # Requirements for both clients and servers.
-gem 'activemodel', '~> 3.1.3'
 gem 'activesupport', '~> 3.1.3'
 gem 'i18n', '~> 0.6.0' # For ActiveSupport
 # Used by Serf::Messages::*

data/Gemfile.lock

@@ -1,13 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
     activesupport (3.1.3)
       multi_json (~> 1.0)
-    builder (3.0.0)
     diff-lcs (1.1.3)
     eventmachine (0.12.10)
     git (1.2.5)
@@ -35,7 +30,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activemodel (~> 3.1.3)
   activesupport (~> 3.1.3)
   bundler (~> 1.0.0)
   eventmachine (~> 0.12.10)

data/README.md

@@ -38,14 +38,15 @@ Serf App and Channels
 A Serf App is a Rack-like application that accepts an ENV hash as input.
 This ENV hash is simply the hash representation of a message to be processed.
 The Serf App, as configured by registered manifests, will:
-1. validate the message
-2. route the message to the proper handler
-3. run the handler in blocking or non-blocking mode.
-4. publish the handler's results to results or error channels.
+1. route the ENV to the proper handler
+2. run the handler in blocking or non-blocking mode.
+  a. The handler's serf call method will parse the ENV into a message object
+    if the handler registered a Message class.
+3. publish the handler's results to results or error channels.
   a. These channels are normally message queuing channels.
   b. We only require the channel instance to respond to the 'publish'
     method and accept a message (or message hash) as the argument.
-5. return the handler's results to the caller if it is blocking mode.
+4. return the handler's results to the caller if it is blocking mode.
   a. In non-blocking mode, an MessageAcceptedEvent is returned instead
     because the message will be run by the EventMachine deferred threadpool
     by default.
@@ -63,19 +64,56 @@ Service Libraries
   a. Barring that, they should conform to the idea that messages may be
     hashes that define at least one attribute: 'kind'.
 2. Serialization of the messages SHOULD BE Json or MessagePack (I hate XML).
+  a. `to_hash` is also included.
 3. Service Libraries SHOULD implement handler classes that include the
   ::Serf::Handler helper module.
-4. Handler methods MUST receive a message as an options hash, symbolized keys.
+4. Handler methods MUST receive a message as either as an options hash
+  (with symbolized keys) or an instance of a declared Message.
 5. Handler methods MUST return zero or more messages.
 6. Handler methods SHOULD handle catch their business logic exceptions and
   return them as specialized messages that can be forwarded down error channels.
   Uncaught exceptions that are then caught by Serf are published as
   generic Serf::CaughtExceptionEvents, and are harder to deal with.
 
+
+Serf::Message
+-------------
+
+Users of the Serf::Message module need to be aware of that:
+
+1. Messages MUST implement the `#attributes` method to use the
+  default implementations of `to_msgpack`, `to_json`, and `to_hash`.
+2. Messages MAY implement validation helpers (e.g. ActiveModel or
+  Virtus + Aequitas (DataMapper)). This is purely to be helpful for
+  receivers (Serf::Handlers) to validate the Messages before running
+  code against its data. The Serf infrastructure code does not
+  validate the Messages; it is the job of the handler code.
+3. Messages MAY override `Message.parse` class method if they want
+  different parsing (Message object instantiation) than
+  `message_class.new *args`. This parse method is called in
+  Serf::Handler when the handler class has defined a Message class
+  to be used to deserialize the ENV for a handler action method.
+3. Messages MAY override `Message#kind` instance method or `Message.kind`
+  class method to specify a message `kind` that is different than
+  the tableized name of the implementing ruby class.
+4. Messages MAY override `Message#to_msgpack`, `Message#to_json`, or
+  `Message#to_hash` to get alternate serialization.
+
+User that opt to roll their own Message class only need to be
+aware that:
+
+1. Message classes MUST implement `Message.parse(env={})` class method
+  if said message class is to be used as the target object representation
+  of a received message (from ENV hash).
+    a. Serf::Handler code makes this assumption when it finds an ENV
+    hash that is to be parsed into a message object.
+
+
 Example
 =======
 
     # Require our libraries
+    require 'active_model'
     require 'log4r'
     require 'serf/handler'
     require 'serf/message'
@@ -87,37 +125,57 @@ Example
       'fileOutputter',
       filename: 'log.txt')
 
+    # my_lib/my_message.rb
+    class MyMessage
+      include Serf::Message
+      include ActiveModel::Validations
+
+      attr_accessor :data
+
+      validates_presence_of :data
+
+      def initialize(options={})
+        @hi = options[:data] || 'some data here'
+      end
+
+    end
+
     # my_lib/my_handler.rb
     class MyHandler
       include Serf::Handler
 
+      # Declare handlers for a 'my_message' message kind with a Message class.
       receives(
         'my_message',
+        as: MyMessage,
         with: :submit_my_message)
 
+      # This handler of 'other_message' doesn't need a Message class,
+      # and will just work off the ENV hash.
+      receives(
+        'other_message',
+        with: :submit_other_message)
+
       def initialize(options={})
         @logger = options[:logger]
       end
 
-      def submit_my_message(message={})
-        @logger.info "In Submit Match Result: #{message.inspect.to_s}"
+      def submit_my_message(message)
+        @logger.info "In Submit My Message: #{message.inspect.to_s}"
+        # Validate message because we have implement my_message with it.
+        unless message.valid?
+          raise ArgumentError, message.errors.full_messages.join(',')
+        end
         # Do work Here...
         # And return other messages as results of work, or nil for nothing.
         return nil
       end
 
-    end
-
-    # my_lib/my_message.rb
-    class MyMessage
-      include Serf::Message
-
-      attr_accessor :data
-
-      validates_presence_of :data
-
-      def initialize(options={})
-        @hi = options[:data] || 'some data here'
+      def submit_other_message(message={})
+        # The message here is the ENV hash because we didn't declare
+        # an :as option with `receives`.
+        @logger.info "In Submit Other Result: #{message.inspect.to_s}"
+        return nil
       end
 
     end
@@ -125,12 +183,15 @@ Example
     # my_lib/manifest.rb
     MANIFEST = {
       'my_message' => {
-        # Optional Definition of an implementation class.
-        #message_class => 'other_name_space/my_other_message_implementation',
-        # Declares which handler
+        # Declares which handler to use. This is the tableized
+        # name of the class. It will be constantized by the serf code.
         handler: 'my_handler',
         # Default is true to process in background.
         async: true
+      },
+      'other_message' => {
+        handler: 'my_handler',
+        async: false
       }
     }
 
@@ -206,5 +267,5 @@ Contributing to serf
 Copyright
 =========
 
-Copyright (c) 2011 Benjamin Yu. See LICENSE.txt for further details.
+Copyright (c) 2011-2012 Benjamin Yu. See LICENSE.txt for further details.
 

data/lib/serf/builder.rb

@@ -98,9 +98,7 @@ module Serf
 
     def to_app
       # Our async and sync messages & handlers.
-      kinds = {}
       handlers = {}
-      async_kinds = {}
       async_handlers = {}
 
       # Iterate our manifests to build out handlers and message classes
@@ -111,21 +109,12 @@ module Serf
         args, block = @config.fetch(handler_str) { [[], nil] }
         handler = handler_class.new *args, &block
 
-        # Get the implementing message serialization class.
-        # For a given message kind, we may have a different (or nil)
-        # implementing class. If nil, then we're not going to try to
-        # create a message class to validate before passing to handler.
-        message_class = options.fetch(:message_class) { kind }
-        message_class = message_class && message_class.camelize.constantize
-
         # Put handlers and kinds into the proper map of handlers for either
         # synchronous or asynchronous processing.
         async = options.fetch(:async) { true }
         if async
-          async_kinds[kind] = message_class if message_class
           async_handlers[kind] = handler
         else
-          kinds[kind] = message_class if message_class
           handlers[kind] = handler
         end
       end
@@ -144,7 +133,6 @@ module Serf
         # create the serfer class to run synchronous handlers
         app = @serfer_class.new(
           @serfer_options.merge(
-            kinds: kinds,
             handlers: handlers,
             runner: runner,
             not_found: app))
@@ -159,7 +147,6 @@ module Serf
         # create the serfer class to run async handlers
         app = @serfer_class.new(
           @serfer_options.merge(
-            kinds: async_kinds,
             handlers: async_handlers,
             runner: async_runner,
             not_found: app))

data/lib/serf/handler.rb

@@ -16,9 +16,13 @@ module Serf
       # create an inheritable class attribute that will store
       # our mappings between messages and the methods to call.
       class_attribute :serf_actions
+      class_attribute :serf_message_classes
       send(
         'serf_actions=',
         ActiveSupport::InheritableOptions.new)
+      send(
+        'serf_message_classes=',
+        ActiveSupport::InheritableOptions.new)
 
       def self.inherited(kls) #:nodoc:
         super
@@ -27,6 +31,9 @@ module Serf
         kls.send(
           'serf_actions=',
           self.serf_actions.inheritable_copy)
+        kls.send(
+          'serf_message_classes=',
+          self.serf_message_classes.inheritable_copy)
       end
 
     end
@@ -45,6 +52,10 @@ module Serf
         raise ArgumentError, 'No "kind" in call env' if message_kind.blank?
         method = self.class.serf_actions[message_kind]
         raise ArgumentError, "#{message_kind} not found" if method.blank?
+        # Optionally convert the env into a Message class.
+        # Let the actual handler method validate if they want.
+        message_class = self.class.serf_message_classes[message_kind]
+        env = message_class.parse env if message_class
         # Now execute the method with the environment parameters
         self.send method, env
       rescue => e
@@ -57,12 +68,20 @@ module Serf
 
       ##
       # registers a method to handle the receipt of a message type.
+      # @param *args splat list of message kinds
+      # @options opts [Symbol] :with The method to call.
+      # @options opts [Object] :as The Message class to call `parse`.
       #
-      def receives(message_kind, options={})
-        raise ArgumentError, 'Blank message_kind' if message_kind.blank?
+      def receives(*args)
+        options = args.last.kind_of?(Hash) ? args.pop : {}
         exposed_method = options[:with]
         raise ArgumentError, 'Missing "with" option' if exposed_method.blank?
-        self.serf_actions[message_kind] = exposed_method
+        message_class = options[:as]
+        args.each do |kind|
+          raise ArgumentError, 'Blank kind' if kind.blank?
+          self.serf_actions[kind] = exposed_method
+          self.serf_message_classes[kind] = message_class if message_class
+        end
       end
 
     end

data/lib/serf/message.rb

@@ -1,4 +1,3 @@
-require 'active_model'
 require 'active_support/concern'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/string/inflections'
@@ -12,30 +11,28 @@ module Serf
   #
   module Message
     extend ActiveSupport::Concern
-    include ActiveModel::Serialization
-    include ActiveModel::Serializers::JSON
-    include ActiveModel::Validations
 
     included do
       class_attribute :kind
       send 'kind=', self.to_s.tableize.singularize
-      self.include_root_in_json = false
     end
 
     module InstanceMethods
 
-      def attributes
-        {
-          :kind => kind
-        }
-      end
-
       def kind
         self.class.kind
       end
 
+      def to_hash
+        attributes.merge kind: kind
+      end
+
       def to_msgpack
-        attributes.to_msgpack
+        to_hash.to_msgpack
+      end
+
+      def to_json(*args)
+        to_hash.to_json *args
       end
 
     end

data/lib/serf/messages/caught_exception_event.rb

@@ -33,11 +33,11 @@ module Messages
         'error_message' => @error_message,
         'error_backtrace' => @error_backtrace,
         'uuid' => uuid
-      }.merge!(super)
+      }
     end
 
     def to_s
-      attributes.to_s
+      to_hash.to_s
     end
 
   end

data/lib/serf/messages/message_accepted_event.rb

@@ -25,11 +25,11 @@ module Messages
       {
         'message' => @message,
         'uuid' => uuid
-      }.merge!(super)
+      }
     end
 
     def to_s
-      attributes.to_s
+      to_hash.to_s
     end
 
   end

data/lib/serf/serfer.rb

@@ -9,7 +9,6 @@ module Serf
       @runner = options.fetch(:runner)
 
       # Options for handling the requests
-      @kinds = options[:kinds] || {}
       @handlers = options[:handlers] || {}
       @not_found = options[:not_found] || proc do
         raise ArgumentError, 'Handler Not Found'
@@ -27,18 +26,6 @@ module Serf
       kind = params[:kind]
       handler = @handlers[kind]
       if handler
-        # Do a message_class validation if we have it listed.
-        # And use the message attributes instead of raw env when passing
-        # to message handler.
-        message_class = @kinds[kind]
-        if message_class
-          message = message_class.parse params
-          unless message.valid?
-            raise ArgumentError, message.errors.full_messages.join('. ')
-          end
-          params = message.attributes.symbolize_keys
-        end
-
         # Let's run the handler
         return @runner.run(handler, params) if handler
       else

data/lib/serf/version.rb

@@ -2,7 +2,7 @@ module Serf
 
   module Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     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.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Yu"]
-  s.date = "2011-12-23"
+  s.date = "2012-01-19"
   s.description = "Event-Driven SOA with CQRS"
   s.email = "benjaminlyu@gmail.com"
   s.extra_rdoc_files = [
@@ -52,7 +52,6 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activemodel>, ["~> 3.1.3"])
       s.add_runtime_dependency(%q<activesupport>, ["~> 3.1.3"])
       s.add_runtime_dependency(%q<i18n>, ["~> 0.6.0"])
       s.add_runtime_dependency(%q<uuidtools>, ["~> 2.1.2"])
@@ -64,7 +63,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<msgpack>, ["~> 0.4.6"])
       s.add_development_dependency(%q<eventmachine>, ["~> 0.12.10"])
     else
-      s.add_dependency(%q<activemodel>, ["~> 3.1.3"])
       s.add_dependency(%q<activesupport>, ["~> 3.1.3"])
       s.add_dependency(%q<i18n>, ["~> 0.6.0"])
       s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])
@@ -77,7 +75,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<eventmachine>, ["~> 0.12.10"])
     end
   else
-    s.add_dependency(%q<activemodel>, ["~> 3.1.3"])
     s.add_dependency(%q<activesupport>, ["~> 3.1.3"])
     s.add_dependency(%q<i18n>, ["~> 0.6.0"])
     s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000Z
+date: 2012-01-19 00:00:00.000000000Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: &70304875304400 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.1.3
-  type: :runtime
-  prerelease: false
-  version_requirements: *70304875304400
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70304875303800 !ruby/object:Gem::Requirement
+  requirement: &70321253946220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +21,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70304875303800
+  version_requirements: *70321253946220
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70304875303260 !ruby/object:Gem::Requirement
+  requirement: &70321253945360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70304875303260
+  version_requirements: *70321253945360
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70304875302780 !ruby/object:Gem::Requirement
+  requirement: &70321253944480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +43,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70304875302780
+  version_requirements: *70321253944480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70304875302300 !ruby/object:Gem::Requirement
+  requirement: &70321253943600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +54,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70304875302300
+  version_requirements: *70321253943600
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70304875301820 !ruby/object:Gem::Requirement
+  requirement: &70321253942720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +65,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70304875301820
+  version_requirements: *70321253942720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70304875301340 !ruby/object:Gem::Requirement
+  requirement: &70321253941800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70304875301340
+  version_requirements: *70321253941800
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70304875206820 !ruby/object:Gem::Requirement
+  requirement: &70321253941020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +87,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70304875206820
+  version_requirements: *70321253941020
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70304875206340 !ruby/object:Gem::Requirement
+  requirement: &70321253940260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70304875206340
+  version_requirements: *70321253940260
 - !ruby/object:Gem::Dependency
   name: msgpack
-  requirement: &70304875205860 !ruby/object:Gem::Requirement
+  requirement: &70321253939160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +109,10 @@ dependencies:
         version: 0.4.6
   type: :development
   prerelease: false
-  version_requirements: *70304875205860
+  version_requirements: *70321253939160
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70304875205280 !ruby/object:Gem::Requirement
+  requirement: &70321253938520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +120,7 @@ dependencies:
         version: 0.12.10
   type: :development
   prerelease: false
-  version_requirements: *70304875205280
+  version_requirements: *70321253938520
 description: Event-Driven SOA with CQRS
 email: benjaminlyu@gmail.com
 executables: []
@@ -179,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3406748221232182748
+      hash: -2016734549477828314
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: