serf 0.10.0 → 0.11.0

data/lib/serf/util/uuidable.rb

@@ -2,6 +2,8 @@ require 'base64'
 require 'hashie'
 require 'uuidtools'
 
+require 'serf/util/options_extraction'
+
 module Serf
 module Util
 
@@ -11,30 +13,14 @@ module Util
   # 1. Primarily to create and parse 'coded' UUIDs, which are just
   #   base64 encoded UUIDs without trailing '='.
   #
-  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
+  class Uuidable
+    include Serf::Util::OptionsExtraction
 
-    ##
-    # @see self.create_uuids
-    def create_uuids(parent={})
-      Uuidable.create_uuids parent
-    end
+    attr_reader :uuid_tool
 
-    ##
-    # @see self.annotate_with_uuids!
-    def annotate_with_uuids!(message, parent={})
-      Uuidable.annotate_with_uuids! message, parent
+    def initialize(*args)
+      extract_options! args
+      @uuid_tool = opts :uuid_tool, UUIDTools::UUID
     end
 
     ##
@@ -42,27 +28,28 @@ module Util
     #
     # NOTE: UUIDTools TimeStamp code creates a UTC based timestamp UUID.
     #
-    def self.create_coded_uuid
+    def create_coded_uuid
       # All raw UUIDs are 16 bytes long. Base64 lengthens the string to
       # 24 bytes long. We chomp off the last two equal signs '==' to
       # trim the string length to 22 bytes. This gives us an overhead
       # of an extra 6 bytes over raw UUID, but with the readability
       # benefit. And saves us 14 bytes of size from the 'standard'
       # string hex representation of UUIDs.
-      Base64.urlsafe_encode64(UUIDTools::UUID.timestamp_create.raw).chomp('==')
+      Base64.urlsafe_encode64(uuid_tool.timestamp_create.raw).chomp('==')
     end
 
     ##
     # @param coded_uuid a coded uuid to parse.
     #
-    def self.parse_coded_uuid(coded_uuid)
-      UUIDTools::UUID.parse_raw Base64.urlsafe_decode64("#{coded_uuid}==")
+    def parse_coded_uuid(coded_uuid)
+      uuid_tool.parse_raw Base64.urlsafe_decode64("#{coded_uuid}==")
     end
 
     ##
     # Create a new set of uuids.
     #
-    def self.create_uuids(parent={})
+    def create_uuids(parent=nil)
+      parent ||= {}
       Hashie::Mash.new(
         uuid: create_coded_uuid,
         parent_uuid: parent[:uuid],
@@ -72,17 +59,6 @@ module Util
           parent[:uuid]))
     end
 
-    ##
-    # Set a message's UUIDs with new UUIDs based on the parent's UUIDs.
-    #
-    def self.annotate_with_uuids!(message, parent={})
-      uuids = self.create_uuids parent
-      message[:uuid] ||= uuids[:uuid]
-      message[:parent_uuid] ||= uuids[:parent_uuid]
-      message[:origin_uuid] ||= uuids[:origin_uuid]
-      return nil
-    end
-
   end
 
 end

data/lib/serf/version.rb

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

data/schemas/{caught_exception_event.json → serf/events/caught_error.json}

@@ -1,20 +1,17 @@
 {
-  "description": "Message Kind: serf/messages/caught_exception_event",
+  "description": "serf/events/caught_error",
   "type": "object",
   "properties": {
-    "context": {
-      "type": "object"
-    },
     "error": {
       "type": "string"
     },
     "message": {
       "type": "string"
     },
-    "backtrace": {
-      "type": "string"
+    "process_env": {
+      "type": "object"
     },
-    "uuid": {
+    "backtrace": {
       "type": "string"
     }
   }

data/serf.gemspec

@@ -1,107 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/serf/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = "serf"
-  s.version = "0.10.0"
+Gem::Specification.new do |gem|
+  gem.name        = 'serf'
+  gem.version     = Serf::Version::STRING
+  gem.authors     = ['Benjamin Yu']
+  gem.email       = 'benjaminlyu@gmail.com'
+  gem.description = 'Interactors with policy protection'
+  gem.summary     = 'Interactors with policy protection'
+  gem.homepage    = 'http://github.com/byu/serf'
+  gem.licenses    = ['Apache 2.0']
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Benjamin Yu"]
-  s.date = "2012-05-30"
-  s.description = "Event-Driven SOA with CQRS"
-  s.email = "benjaminlyu@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
+  gem.rubygems_version = '1.8.17'
+  gem.files            = `git ls-files`.split($\)
+  gem.executables      = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files       = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths    = ['lib']
+  gem.extra_rdoc_files = [
+    'LICENSE.txt',
+    'NOTICE.txt',
+    'README.md'
   ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "NOTICE.txt",
-    "README.md",
-    "Rakefile",
-    "docs/thread_pools.txt",
-    "lib/serf.rb",
-    "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/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/null_object.rb",
-    "lib/serf/util/options_extraction.rb",
-    "lib/serf/util/protected_call.rb",
-    "lib/serf/util/uuidable.rb",
-    "lib/serf/version.rb",
-    "schemas/caught_exception_event.json",
-    "schemas/message_accepted_event.json",
-    "serf.gemspec",
-    "spec/serf_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/byu/serf"
-  s.licenses = ["Apache 2.0"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
-  s.summary = "Event-Driven SOA with CQRS"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 3.2.0"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0.6.0"])
-      s.add_runtime_dependency(%q<hashie>, [">= 1.2.0"])
-      s.add_runtime_dependency(%q<uuidtools>, [">= 2.1.2"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7.5"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<log4r>, [">= 1.1.10"])
-      s.add_development_dependency(%q<msgpack>, [">= 0.4.6"])
-      s.add_development_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_development_dependency(%q<girl_friday>, [">= 0.9.7"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 3.2.0"])
-      s.add_dependency(%q<i18n>, [">= 0.6.0"])
-      s.add_dependency(%q<hashie>, [">= 1.2.0"])
-      s.add_dependency(%q<uuidtools>, [">= 2.1.2"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<yard>, ["~> 0.7.5"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<log4r>, [">= 1.1.10"])
-      s.add_dependency(%q<msgpack>, [">= 0.4.6"])
-      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-      s.add_dependency(%q<girl_friday>, [">= 0.9.7"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 3.2.0"])
-    s.add_dependency(%q<i18n>, [">= 0.6.0"])
-    s.add_dependency(%q<hashie>, [">= 1.2.0"])
-    s.add_dependency(%q<uuidtools>, [">= 2.1.2"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<yard>, ["~> 0.7.5"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<log4r>, [">= 1.1.10"])
-    s.add_dependency(%q<msgpack>, [">= 0.4.6"])
-    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
-    s.add_dependency(%q<girl_friday>, [">= 0.9.7"])
-  end
+  gem.add_runtime_dependency('hashie', ['>= 1.2.0'])
+  gem.add_runtime_dependency('ice_nine', ['>= 0.4.0'])
+  gem.add_runtime_dependency('uuidtools', ['>= 2.1.3'])
 end
-

data/spec/serf/builder_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+require 'serf/builder'
+
+describe Serf::Builder do
+  let(:request_parcel) {
+    FactoryGirl.create :random_parcel
+  }
+  let(:response_kind) {
+    'MyResponseKindMessage'
+  }
+  let(:app) {
+    lambda { |parcel|
+      return parcel, response_kind
+    }
+  }
+  subject {
+    described_class.new interactor: app
+  }
+
+  describe '#to_app' do
+
+    it 'builds a callable app' do
+      subject.to_app.should respond_to(:call)
+    end
+
+  end
+
+  context 'with build app' do
+
+    describe '#call' do
+
+      it 'runs the app' do
+        response = subject.to_app.call request_parcel
+        puts response.to_hash
+        response.message.should == request_parcel.message
+        response.headers.kind.should == response_kind
+      end
+
+    end
+
+  end
+
+end

data/spec/serf/errors/policy_failure_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+require 'serf/errors/policy_failure'
+
+describe Serf::Errors::PolicyFailure do
+
+  it {
+    should be_a_kind_of(RuntimeError)
+  }
+
+end

data/spec/serf/middleware/error_handler_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+require 'serf/middleware/error_handler'
+
+describe Serf::Middleware::ErrorHandler do
+
+  describe '#call' do
+
+    context 'has a raised error' do
+      subject {
+        described_class.new(proc { |parcel|
+          raise 'Some Runtime Error'
+        })
+      }
+
+      it 'returns an error parcel' do
+        parcel = subject.call({})
+        JsonSchemaTester.new.validate_for!(
+          'serf/events/caught_error',
+          parcel[:message])
+      end
+
+      it 'has an error parcel kind' do
+        parcel = subject.call({})
+        parcel[:headers][:kind].should == 'serf/events/caught_error'
+      end
+    end
+
+    context 'has a succeeding app' do
+      subject {
+        described_class.new(proc { |parcel|
+          response_parcel
+        })
+      }
+      let(:response_parcel) {
+        FactoryGirl.create :random_parcel
+      }
+
+      it 'returns a good response parcel' do
+        parcel = subject.call({})
+        parcel.should == response_parcel
+      end
+
+    end
+
+  end
+
+end

data/spec/serf/middleware/parcel_freezer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+require 'serf/middleware/parcel_freezer'
+
+describe Serf::Middleware::ParcelFreezer do
+
+  describe '#call' do
+
+    it 'freezes the parcel' do
+      parcel = {}
+      app = described_class.new proc { |parcel|
+        parcel.frozen?.should be_true
+      }
+      app.call parcel
+      parcel.frozen?.should be_true
+    end
+
+  end
+
+end

data/spec/serf/middleware/parcel_masher_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'hashie'
+
+require 'serf/middleware/parcel_masher'
+
+describe Serf::Middleware::ParcelMasher do
+
+  describe '#call' do
+
+    it 'should Hashie::Mash the parcel' do
+      parcel = nil
+      app = described_class.new proc { |parcel|
+        parcel.should be_a_kind_of(Hashie::Mash)
+      }
+      app.call parcel
+    end
+
+    it 'should autocreate headers and message' do
+      parcel = nil
+      app = described_class.new proc { |parcel|
+        parcel.headers.should be_a_kind_of(Hashie::Mash)
+        parcel.message.should be_a_kind_of(Hashie::Mash)
+      }
+      app.call parcel
+    end
+
+  end
+
+end

data/spec/serf/middleware/policy_checker_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+require 'serf/errors/policy_failure'
+require 'serf/middleware/policy_checker'
+
+describe Serf::Middleware::PolicyChecker do
+
+  describe '#call' do
+
+    context 'when policy raises error' do
+
+      it 'should not call app' do
+        uncalled_mock = double 'uncalled mock'
+        app = described_class.new(
+          uncalled_mock,
+          policy_chain: [
+            PassingPolicy.new,
+            FailingPolicy.new,
+            PassingPolicy.new
+          ])
+        expect {
+          app.call nil
+        }.to raise_error(Serf::Errors::PolicyFailure)
+      end
+
+    end
+
+    context 'when all policies pass' do
+
+      it 'should call the app' do
+        parcel = double 'parcel'
+        parcel.should_receive :some_success
+        app = described_class.new(
+          proc { |parcel|
+            parcel.some_success
+          },
+          policy_chain: [
+            PassingPolicy.new,
+            PassingPolicy.new
+          ])
+        app.call parcel
+      end
+
+    end
+
+    it 'should iterate the policy chain' do
+      count = 10
+      policy_chain = (1..count).map { |i|
+        policy = double 'policy'
+        policy.should_receive(:check!).once do |parcel|
+          parcel.check_called
+        end
+        policy
+      }
+
+      parcel = double 'parcel'
+      parcel.should_receive(:check_called).exactly(count).times
+      parcel.should_receive :some_success
+
+      app = described_class.new(
+        proc { |parcel|
+          parcel.some_success
+        },
+        policy_chain: policy_chain)
+      app.call parcel
+    end
+
+  end
+
+end

data/spec/serf/middleware/uuid_tagger_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+require 'serf/middleware/uuid_tagger'
+
+describe Serf::Middleware::UuidTagger do
+
+  describe '#call' do
+
+    it 'should add uuid the parcel header' do
+      parcel = {}
+      app = described_class.new proc { |parcel|
+        parcel[:headers][:uuid].should_not be_nil
+      }
+      app.call parcel
+    end
+
+    it 'should not change the existing uuid' do
+      uuid = '0d3eccaabcc46c3bcbe2a53c4505e352'
+      parcel = {
+        headers: {
+          uuid: uuid
+        }
+      }
+      app = described_class.new proc { |parcel|
+        parcel[:headers][:uuid].should == uuid
+      }
+      app.call parcel
+    end
+
+  end
+
+end

data/spec/serf/parcel_builder_spec.rb

@@ -0,0 +1,46 @@
+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
+      parcel.should be_a_kind_of(Hashie::Mash)
+    end
+
+    it 'sets default parcel headers' do
+      parcel = subject.build
+      parcel[:headers].should == {}
+    end
+
+    it 'sets default parcel message' do
+      parcel = subject.build
+      parcel[:headers].should == {}
+    end
+
+    it 'sets given headers and message' do
+      parcel = subject.build random_headers, random_message
+      parcel[:headers].should == random_headers
+      parcel[:message].should == random_message
+    end
+
+    it 'will coerce headers and message into Hashie::Mash' do
+      parcel = subject.build nil, nil
+      parcel[:headers].should be_a_kind_of(Hashie::Mash)
+      parcel[:message].should be_a_kind_of(Hashie::Mash)
+    end
+
+  end
+
+end

data/spec/serf/serfer_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+require 'serf/serfer'
+
+describe Serf::Serfer do
+
+  describe '#call' do
+    let(:request_message) {
+      FactoryGirl.create :random_message
+    }
+    let(:response_message) {
+      FactoryGirl.create :random_message
+    }
+
+    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)
+    end
+
+    it 'returns a parcel' do
+      mock_app = double 'mock_app'
+      mock_app.
+        should_receive(:call).
+        with(request_message).
+        and_return(response_message)
+      serfer = described_class.new mock_app
+      parcel = serfer.call(
+        headers: nil,
+        message: request_message)
+      parcel.message.should == 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([response_message, 'KIND'])
+      serfer = described_class.new mock_app
+      parcel = serfer.call(
+        headers: nil,
+        message: request_message)
+      parcel.headers.kind.should == 'KIND'
+    end
+
+    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({})
+    end
+
+  end
+
+end

data/spec/serf/util/error_handling_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Serf::Util::ErrorHandling do
+  subject { ErrorHandlingWrapper.new }
+
+  context 'has a raised error' do
+
+    it 'returns an error message' do
+      result, error = subject.with_error_handling do
+        raise 'Some Error Message'
+      end
+      result.should be_nil
+      JsonSchemaTester.new.validate_for!(
+        'serf/events/caught_error',
+        error)
+    end
+
+  end
+
+  context 'has a succeeding app' do
+    let(:response_parcel) {
+      FactoryGirl.create :random_parcel
+    }
+
+    it 'returns a good response parcel' do
+      result, error = subject.with_error_handling do
+        response_parcel
+      end
+      result.should == response_parcel
+      error.should be_nil
+    end
+
+  end
+
+end