serf 0.12.0 → 0.12.1

data/.gitignore

@@ -1,21 +1,10 @@
 # Gemfile.lock because this is a library, not a deployable application.
 Gemfile.lock
-
-# rcov generated
 coverage
-
-# rdoc generated
 rdoc
-
-# yard generated
 doc
 .yardoc
-
-# bundler config
 .bundle
-
-# bundler installs here if bundle path is set to "vendor"
 vendor
-
-# generated builds
 pkg
+tmp

data/lib/serf/middleware/error_handler.rb

@@ -1,9 +1,8 @@
 require 'hashie'
 require 'optser'
 
-require 'serf/parcel_builder'
+require 'serf/parcel_factory'
 require 'serf/util/error_handling'
-require 'serf/util/uuidable'
 
 module Serf
 module Middleware
@@ -16,8 +15,7 @@ module Middleware
     include Serf::Util::ErrorHandling
 
     attr_reader :app
-    attr_reader :parcel_builder
-    attr_reader :uuidable
+    attr_reader :parcel_factory
 
     ##
     # @param app the app
@@ -27,8 +25,7 @@ module Middleware
       @app = app
 
       # Tunable knobs
-      @parcel_builder = opts.get(:parcel_builder) { Serf::ParcelBuilder.new }
-      @uuidable = opts.get(:uuidable) { Serf::Util::Uuidable.new }
+      @parcel_factory = opts.get(:parcel_factory) { Serf::ParcelFactory.new }
     end
 
     def call(parcel)
@@ -42,9 +39,10 @@ module Middleware
 
       # We got an error message instead, so build out the headers
       # and return the parcel.
-      error_headers = uuidable.create_uuids parcel[:headers]
-      error_headers[:kind] = 'serf/events/caught_error'
-      return parcel_builder.build error_headers, error_message
+      return parcel_factory.create(
+        kind: 'serf/events/caught_error',
+        parent: parcel,
+        message: error_message)
     end
 
   end

data/lib/serf/parcel_factory.rb

@@ -0,0 +1,45 @@
+require 'hashie'
+require 'optser'
+
+require 'serf/util/uuidable'
+
+module Serf
+
+  ##
+  # Creates Parcels as Hashie::Mash objects with headers and messages.
+  #
+  class ParcelFactory
+    attr_reader :mash_class
+    attr_reader :uuidable
+
+    def initialize(*args)
+      opts = Optser.extract_options! args
+
+      @mash_class = opts.get :mash_class, Hashie::Mash
+      @uuidable = opts.get(:uuidable) { Serf::Util::Uuidable.new }
+    end
+
+    def create(*args)
+      opts = Optser.extract_options! args
+
+      # Get parameters
+      kind = opts.get :kind
+      parent = opts.get :parent, {}
+      headers = opts.get :headers, {}
+      message = opts.get :message, {}
+
+      # Coerce to mashes.
+      parent = mash_class.new(parent) unless parent.kind_of? mash_class
+      headers = mash_class.new(headers) unless headers.kind_of? mash_class
+
+      # Create a new headers object w/ uuids set from the parent and kind.
+      headers = headers.merge uuidable.create_uuids(parent.headers)
+      headers.kind = kind
+
+      # Return a final parcel, coerced as a mash.
+      mash_class.new headers: headers, message: message
+    end
+
+  end
+
+end

data/lib/serf/serfer.rb

@@ -1,8 +1,6 @@
-require 'hashie'
 require 'optser'
 
-require 'serf/parcel_builder'
-require 'serf/util/uuidable'
+require 'serf/parcel_factory'
 
 module Serf
 
@@ -11,8 +9,7 @@ module Serf
   #
   class Serfer
     attr_reader :interactor
-    attr_reader :parcel_builder
-    attr_reader :uuidable
+    attr_reader :parcel_factory
 
     def initialize(interactor, *args)
       opts = Optser.extract_options! args
@@ -21,26 +18,24 @@ module Serf
       @interactor = interactor
 
       # Tunable knobs
-      @parcel_builder = opts.get(:parcel_builder) { Serf::ParcelBuilder.new }
-      @uuidable = opts.get(:uuidable) { Serf::Util::Uuidable.new }
+      @parcel_factory = opts.get(:parcel_factory) { Serf::ParcelFactory.new }
     end
 
     ##
     # Rack-like call to run the Interactor's use-case.
     #
     def call(parcel)
-      headers = parcel[:headers]
-      message = parcel[:message]
-
       # 1. Execute interactor
-      response_kind, response_message = interactor.call message
-
-      # 2. Create the response headers
-      response_headers = uuidable.create_uuids headers
-      response_headers[:kind] = response_kind
-
-      # 3. Return the response headers and message as a parcel
-      return parcel_builder.build response_headers, response_message
+      response_kind, response_message = interactor.call parcel[:message]
+
+      # 2. Return a new response parcel with:
+      #   a. uuids set from parent parcel
+      #   b. kind set to response kind
+      #   c. the message set to response_message
+      return parcel_factory.create(
+        parent: parcel,
+        kind: response_kind,
+        message: response_message)
     end
 
   end

data/lib/serf/version.rb

@@ -3,7 +3,7 @@ module Serf
   module Version
     MAJOR = 0
     MINOR = 12
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join '.'
   end

data/serf.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   ]
 
   gem.add_runtime_dependency('hashie', ['>= 1.2.0'])
-  gem.add_runtime_dependency('ice_nine', ['>= 0.4.0'])
+  gem.add_runtime_dependency('ice_nine', ['>= 0.6.0'])
   gem.add_runtime_dependency('optser', ['>= 0.1.0'])
   gem.add_runtime_dependency('uuidtools', ['>= 2.1.3'])
 end

data/spec/serf/middleware/error_handler_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+require 'factory_girl'
+
 require 'serf/middleware/error_handler'
 
 describe Serf::Middleware::ErrorHandler do
@@ -7,6 +9,13 @@ describe Serf::Middleware::ErrorHandler do
   describe '#call' do
 
     context 'has a raised error' do
+      let(:request_parcel) {
+        FactoryGirl.create :random_parcel
+      }
+      let(:response_parcel) {
+        FactoryGirl.create :random_parcel
+      }
+
       subject {
         described_class.new(proc { |parcel|
           raise 'Some Runtime Error'
@@ -24,6 +33,25 @@ describe Serf::Middleware::ErrorHandler do
         parcel = subject.call({})
         expect(parcel[:headers][:kind]).to eq('serf/events/caught_error')
       end
+
+      it 'uses parcel factory w/ kind, parent, and error message' do
+        mock_parcel_factory = double 'parcel_factory'
+        mock_parcel_factory.
+          should_receive(:create).
+          with({
+            parent: request_parcel,
+            kind: 'serf/events/caught_error',
+            message: anything()
+          }).
+          and_return(response_parcel)
+
+        app = described_class.new(proc { |parcel|
+            raise 'Some Runtime Error'
+          },
+          parcel_factory: mock_parcel_factory)
+        response = app.call request_parcel
+        expect(response).to eq(response_parcel)
+      end
     end
 
     context 'has a succeeding app' do

data/spec/serf/parcel_factory_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+require 'hashie'
+require 'securerandom'
+
+require 'serf/parcel_factory'
+
+describe Serf::ParcelFactory do
+
+  describe '#build' do
+    let(:response_kind) {
+      SecureRandom.hex
+    }
+    let(:response_headers) {
+      FactoryGirl.create :random_headers
+    }
+    let(:response_message) {
+      FactoryGirl.create :random_message
+    }
+    let(:parent_parcel) {
+      FactoryGirl.create :random_parcel
+    }
+
+    it 'returns a Hashie Mash' do
+      parcel = subject.create
+      expect(parcel).to be_a_kind_of(Hashie::Mash)
+    end
+
+    it 'returns the headers as a Hashie Mash' do
+      parcel = subject.create
+      expect(parcel.headers).to be_a_kind_of(Hashie::Mash)
+    end
+
+    it 'sets nil kind in parcel headers' do
+      parcel = subject.create
+      expect(parcel.headers.kind).to be_nil
+    end
+
+    it 'sets nil kind in parcel headers to overwrite headers kind' do
+      parcel = subject.create headers: response_headers
+      expect(response_headers.kind).to_not be_nil
+      expect(parcel.headers.kind).to be_nil
+    end
+
+    it 'sets a kind in parcel headers to overwrite headers' do
+      parcel = subject.create kind: response_kind, headers: response_headers
+      expect(response_headers.kind).to_not eq(response_kind)
+      expect(parcel.headers.kind).to eq(response_kind)
+    end
+
+    it 'sets uuid, w/ nil origin and parent in parcel headers' do
+      parcel = subject.create
+      expect(parcel.headers.uuid).to_not be_nil
+      expect(parcel.headers.parent_uuid).to be_nil
+      expect(parcel.headers.origin_uuid).to be_nil
+    end
+
+    it 'sets uuid, origin and parent in response headers from parent' do
+      parcel = subject.create parent: parent_parcel
+      expect(parcel.headers.uuid).to_not be_nil
+      expect(parcel.headers.parent_uuid).to eq(parent_parcel.headers.uuid)
+      expect(parcel.headers.origin_uuid).
+        to eq(parent_parcel.headers.origin_uuid)
+    end
+
+    it 'returns the message as a Hashie Mash' do
+      parcel = subject.create
+      expect(parcel.message).to be_a_kind_of(Hashie::Mash)
+    end
+
+    it 'sets empty parcel message as default' do
+      parcel = subject.create
+      expect(parcel[:message]).to eq({})
+    end
+
+    it 'sets the message, given a message' do
+      parcel = subject.create message: response_message
+      expect(parcel.message).to eq(response_message)
+    end
+
+    it 'sets meets expectations given kind, headers, message and parent' do
+      parcel = subject.create(
+        parent: parent_parcel,
+        kind: response_kind,
+        headers: response_headers,
+        message: response_message)
+      expect(response_headers.kind).to_not eq(response_kind)
+      expect(parcel.headers.kind).to eq(response_kind)
+      expect(parcel.headers.uuid).to_not be_nil
+      expect(parcel.headers.parent_uuid).to eq(parent_parcel.headers.uuid)
+      expect(parcel.headers.origin_uuid).
+        to eq(parent_parcel.headers.origin_uuid)
+      expect(parcel.headers.option_a).to eq(response_headers.option_a)
+      expect(parcel.message).to eq(response_message)
+    end
+
+  end
+
+end

data/spec/serf/serfer_spec.rb

@@ -1,59 +1,81 @@
 require 'spec_helper'
 
+require 'hashie'
+require 'securerandom'
+
 require 'serf/serfer'
 
 describe Serf::Serfer do
 
   describe '#call' do
+    let(:request_parcel) {
+      Hashie::Mash.new(
+        headers: request_headers,
+        message: request_message)
+    }
+    let(:request_headers) {
+      FactoryGirl.create :random_headers
+    }
     let(:request_message) {
       FactoryGirl.create :random_message
     }
+    let(:response_kind) {
+      SecureRandom.hex
+    }
     let(:response_message) {
       FactoryGirl.create :random_message
     }
+    let(:disconnected_response_parcel) {
+      FactoryGirl.create :random_parcel
+    }
 
     it 'calls app with message' do
       mock_app = double 'mock_app'
       mock_app.should_receive(:call).with(request_message)
       serfer = described_class.new mock_app
-      serfer.call(
-        headers: nil,
-        message: request_message)
+      serfer.call request_parcel
     end
 
-    it 'returns a parcel' do
+    it 'returns a parcel with a kind, message and uuids' do
       mock_app = double 'mock_app'
       mock_app.
         should_receive(:call).
         with(request_message).
-        and_return([nil, response_message])
+        and_return([response_kind, response_message])
       serfer = described_class.new mock_app
-      parcel = serfer.call(
-        headers: nil,
-        message: request_message)
+
+      parcel = serfer.call request_parcel
+
+      # We expect the kind and message to match.
+      # We also expect that the uuid is some value
+      # We also expect that the response parent uuid matches request uuid
+      # We also expect that the response origin uuid matches request origin's.
+      expect(parcel.headers.kind).to eq(response_kind)
+      expect(parcel.headers.uuid).to_not be_nil
+      expect(parcel.headers.origin_uuid).
+        to eq(request_parcel.headers.origin_uuid)
+      expect(parcel.headers.parent_uuid).
+        to eq(request_parcel.headers.uuid)
       expect(parcel.message).to eq(response_message)
     end
 
-    it 'sets the kind header in response' do
-      mock_app = double 'mock_app'
-      mock_app.
-        should_receive(:call).
-        with(request_message).
-        and_return(['KIND', response_message])
-      serfer = described_class.new mock_app
-      parcel = serfer.call(
-        headers: nil,
-        message: request_message)
-      expect(parcel.headers.kind).to eq('KIND')
-    end
+    it 'uses parcel factory w/ message and headers' do
+      mock_parcel_factory = double 'parcel_factory'
+      mock_parcel_factory.
+        should_receive(:create).
+        with({
+          parent: request_parcel,
+          kind: response_kind,
+          message: response_message
+        }).
+        and_return(disconnected_response_parcel)
 
-    it 'generate uuids' do
-      uuidable = double 'uuidable'
-      uuidable.should_receive(:create_uuids).and_return({})
       serfer = described_class.new(
-        lambda {|obj| return obj },
-        uuidable: uuidable)
-      serfer.call({})
+        lambda {|obj| return response_kind, response_message },
+        parcel_factory: mock_parcel_factory)
+      parcel = serfer.call request_parcel
+
+      expect(parcel).to eq(disconnected_response_parcel)
     end
 
   end

data/spec/support/factories.rb

@@ -15,6 +15,8 @@ FactoryGirl.define do
   factory :random_parcel, class: Hashie::Mash do
     headers {{
       uuid: generate(:random_string),
+      origin_uuid: generate(:random_string),
+      parent_uuid: generate(:random_string),
       kind: generate(:random_string)
     }}
     message {{
@@ -24,7 +26,10 @@ FactoryGirl.define do
 
   factory :random_headers, class: Hashie::Mash do
     uuid { generate(:random_string) }
+    origin_uuid { generate(:random_string) }
+    parent_uuid { generate(:random_string) }
     kind { generate(:random_string) }
+    option_a { generate(:random_string) }
   end
 
   factory :random_message, class: Hashie::Mash do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serf
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-22 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: optser
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ files:
 - lib/serf/middleware/policy_checker.rb
 - lib/serf/middleware/request_timer.rb
 - lib/serf/middleware/uuid_tagger.rb
-- lib/serf/parcel_builder.rb
+- lib/serf/parcel_factory.rb
 - lib/serf/serfer.rb
 - lib/serf/util/error_handling.rb
 - lib/serf/util/null_object.rb
@@ -126,7 +126,7 @@ files:
 - spec/serf/middleware/policy_checker_spec.rb
 - spec/serf/middleware/request_timer_spec.rb
 - spec/serf/middleware/uuid_tagger_spec.rb
-- spec/serf/parcel_builder_spec.rb
+- spec/serf/parcel_factory_spec.rb
 - spec/serf/serfer_spec.rb
 - spec/serf/util/error_handling_spec.rb
 - spec/serf/util/null_object_spec.rb
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3194185596279459247
+      hash: 4471778564530978528
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3194185596279459247
+      hash: 4471778564530978528
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -183,7 +183,7 @@ test_files:
 - spec/serf/middleware/policy_checker_spec.rb
 - spec/serf/middleware/request_timer_spec.rb
 - spec/serf/middleware/uuid_tagger_spec.rb
-- spec/serf/parcel_builder_spec.rb
+- spec/serf/parcel_factory_spec.rb
 - spec/serf/serfer_spec.rb
 - spec/serf/util/error_handling_spec.rb
 - spec/serf/util/null_object_spec.rb

data/lib/serf/parcel_builder.rb

@@ -1,27 +0,0 @@
-require 'hashie'
-require 'optser'
-
-module Serf
-
-  ##
-  # Builds Parcels as Hashie::Mash objects with headers and messages.
-  #
-  class ParcelBuilder
-    attr_reader :mash_class
-
-    def initialize(*args)
-      opts = Optser.extract_options! args
-
-      @mash_class = opts.get :mash_class, Hashie::Mash
-    end
-
-    def build(headers=nil, message=nil)
-      # We want to make sure that our headers and message are Mashes.
-      headers = mash_class.new(headers) unless headers.kind_of? mash_class
-      message = mash_class.new(message) unless message.kind_of? mash_class
-      mash_class.new headers: headers, message: message
-    end
-
-  end
-
-end

data/spec/serf/parcel_builder_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-require 'hashie'
-
-require 'serf/parcel_builder'
-
-describe Serf::ParcelBuilder do
-
-  describe '#build' do
-    let(:random_headers) {
-      FactoryGirl.create :random_headers
-    }
-    let(:random_message) {
-      FactoryGirl.create :random_message
-    }
-
-    it 'returns a Hashie' do
-      parcel = subject.build
-      expect(parcel).to be_a_kind_of(Hashie::Mash)
-    end
-
-    it 'sets default parcel headers' do
-      parcel = subject.build
-      expect(parcel[:headers]).to eq({})
-    end
-
-    it 'sets default parcel message' do
-      parcel = subject.build
-      expect(parcel[:headers]).to eq({})
-    end
-
-    it 'sets given headers and message' do
-      parcel = subject.build random_headers, random_message
-      expect(parcel[:headers]).to eq(random_headers)
-      expect(parcel[:message]).to eq(random_message)
-    end
-
-    it 'will coerce headers and message into Hashie::Mash' do
-      parcel = subject.build nil, nil
-      expect(parcel[:headers]).to be_a_kind_of(Hashie::Mash)
-      expect(parcel[:message]).to be_a_kind_of(Hashie::Mash)
-    end
-
-  end
-
-end