rhod 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fdc88634e5041f5eb95de18515709647bd9edd2
-  data.tar.gz: fa5cdadac5ca8fcaaef6066862e5b09552b39aee
+  metadata.gz: b3800489cac9157423933e8c61a0d8de2e602ee4
+  data.tar.gz: 30424cdafb3aa4d099ef5983fdd391552119693f
 SHA512:
-  metadata.gz: bb25f0ef2719d5141211eab7f9981938efd5be0dc1fb1a64362280ff844624da0899458e714682e38e6a5021bc7ca7ecc70a48eca151d3b71b260fd7a5733947
-  data.tar.gz: a9d86ea5c9e59a1ea39df024f69bac790adb79c4e87990af471cedff1cc341b7174d9a5bd092661746139f516b2ad0c3caa5725bdd82d15f315cd3d1a8cdd2bb
+  metadata.gz: 027c8d5951ce06f4fe47422dec3c46f1b4fccf8df72010ec27a608d1ff9d1ab762c7e721309bb765cdd44810e09332453edd5efb192447761e1f540e968181e2
+  data.tar.gz: 53921859dd5cd83d5e99d12b6c4d9e8ccf2ca6a790382f90ea169651532dca303d33ed83580de942bb4367b50a9246bb2ab75ababd1d246a575a9cd1b3db2f1b

data/Changes.md

@@ -1,3 +1,7 @@
+# v0.1.3
+Update connection_pool dep to 1.1.0
+Add middleware support - dinedal - PR #9
+
 # v0.1.2
 Added logging as a feature - dleung - PR #8
 

data/README.md

@@ -95,7 +95,7 @@ Rhod.create_profile(:redis,
   backoffs: :^,
   pool: ConnectionPool.new(size: 3, timeout: 10) { Redis.new },
   exceptions: [Redis::BaseError],
-  logger: Logger.new("log.txt")
+  logger: Logger.new(STDOUT)
   )
 
 Rhod.with_redis("1") {|r, a| r.set('test',a)}
@@ -112,6 +112,14 @@ Code within a `Rhod::Command` block with reties in use must be _idempotent_, i.e
 
 Code within a `Rhod::Command` should avoid leaking memory and/or scope by having arguments passed to it:
 
+## Logging
+
+Rhod can optionally log all failures, very useful for debugging. Just set a logger in a profile and they will be logged at the level `:warn`
+
+```ruby
+Rhod.create_profile(:verbose, logger: Logger.new(STDOUT))
+```
+
 ### Good use of argument passing:
 
 ```ruby

data/lib/rhod.rb

@@ -2,6 +2,7 @@ require 'connection_pool'
 require 'logger'
 require_relative "rhod/version"
 require_relative "rhod/backoffs"
+require_relative "rhod/middleware"
 require_relative "rhod/command"
 require_relative "rhod/profile"
 

data/lib/rhod/command.rb

@@ -4,23 +4,19 @@ class Rhod::Command
 
   def initialize(*args, &block)
     opts            = args[-1].kind_of?(Hash) ? args.pop : {}
-    @args           = args || []
-
-    @request        = block
-
-    @retries        = opts[:retries] || 0
-    @attempts       = 0
-
-    @logger         = opts[:logger]
-
-    @backoffs       = Rhod::Backoffs.backoff_sugar_to_enumerator(opts[:backoffs])
-    @backoffs     ||= Rhod::Backoffs::Logarithmic.new(1.3)
-
-    @fallback       = opts[:fallback]
-
-    @pool           = opts[:pool]
-
-    @exceptions     = opts[:exceptions] || EXCEPTIONS
+    @env = {
+      :args           => args || [],
+      :request        => block,
+      :retries        => opts[:retries] || 0,
+      :attempts       => 0,
+      :logger         => opts[:logger],
+      :backoffs       => Rhod::Backoffs.backoff_sugar_to_enumerator(opts[:backoffs]) || Rhod::Backoffs::Logarithmic.new(1.3),
+      :fallback       => opts[:fallback],
+      :pool           => opts[:pool],
+      :exceptions     => opts[:exceptions] || EXCEPTIONS,
+      :profile_name   => opts[:profile_name],
+      :middleware     => opts[:middleware_stack] || Rhod::Middleware.new,
+    }
   end
 
   ### Class methods
@@ -34,26 +30,51 @@ class Rhod::Command
 
   def execute
     begin
-      if @pool
-        @pool.with do |conn|
-          @args = [conn].concat(@args)
+      if @env[:pool]
+        @env[:pool].with do |conn|
+          @env[:args] = [conn].concat(@env[:args])
 
-          @request.call(*@args)
+          call_middleware_before_request
+          @env[:result] = @env[:request].call(*@env[:args])
+          call_middleware_after_request
+          @env[:result]
         end
       else
-        @request.call(*@args)
+        call_middleware_before_request
+        @env[:result] = @env[:request].call(*@env[:args])
+        call_middleware_after_request
+        @env[:result]
       end
-    rescue *@exceptions => e
-      @attempts += 1
-      @next_attempt = @backoffs.next
-      if @attempts <= @retries
-        @logger.warn("Rhod - Caught an exception: #{e.message}.  Attempt #{@attempts} in #{sprintf("%.2f", @next_attempt)} secs") if @logger && @logger.respond_to?(:warn)
-        sleep(@next_attempt)
+    rescue *@env[:exceptions] => e
+      @env[:attempts] += 1
+      @env[:next_attempt] = @env[:backoffs].next
+      if @env[:attempts] <= @env[:retries]
+        @env[:logger].warn("Rhod - Caught an exception: #{e.message}.  Attempt #{@env[:attempts]} in #{sprintf("%.2f", @env[:next_attempt])} secs") if @env[:logger] && @env[:logger].respond_to?(:warn)
+        call_middleware_on_error
+        sleep(@env[:next_attempt])
         retry
       else
-        return @fallback.call(*@args) if @fallback
+        call_middleware_on_failure
+        return @env[:fallback].call(*@env[:args]) if @env[:fallback]
         raise
       end
     end
   end
+
+  def call_middleware_before_request
+    @env = @env[:middleware].on(:before, @env)
+  end
+
+  def call_middleware_after_request
+    @env = @env[:middleware].on(:after, @env)
+  end
+
+  def call_middleware_on_error
+    @env = @env[:middleware].on(:error, @env)
+  end
+
+  def call_middleware_on_failure
+    @env = @env[:middleware].on(:failure, @env)
+  end
+
 end

data/lib/rhod/middleware.rb

@@ -1,10 +1,33 @@
 class Rhod::Middleware
+  class Rhod::InvalidMiddleware < Exception; end
+
+  def initialize
+    @stack = []
+  end
+
   def use(middleware, *args, &block)
-    self.stack << [middleware, args, block]
+    @stack << [middleware, args, block]
   end
 
-  protected
-  def stack
-    @stack ||= []
+  def build_stack
+    @stack = @stack.map do |current_middleware|
+      klass, args, block = current_middleware
+
+      if klass.is_a?(Class)
+        klass.new(*args, &block)
+      else
+        raise Rhod::InvalidMiddleware, "Unable to call middleware #{current_middleware}"
+      end
+    end
   end
+
+  def on(event, env)
+    @stack.reduce(env) do |e, current_middleware|
+      if current_middleware.respond_to?(:on)
+        e = current_middleware.on(event, e)
+      end
+      e
+    end
+  end
+
 end

data/lib/rhod/profile.rb

@@ -13,6 +13,21 @@ class Rhod::Profile < Hash
 
     options.each {|k,v| self[k] = v }
 
+    self[:profile_name] = name
+
+    # Middleware stack construction
+    self[:middleware_stack] = Rhod::Middleware.new
+
+    if self[:middleware].respond_to?(:call)
+      self[:middleware].call(self[:middleware_stack])
+    elsif self[:middleware]
+      self[:middleware].each do |klass|
+        self[:middleware_stack].use klass
+      end
+    end
+
+    self[:middleware_stack].build_stack
+
     # Syntax sugar: named .with_#{profile} methods on this class and the module
     @@profiles[name] = self
 

data/lib/rhod/version.rb

@@ -1,3 +1,3 @@
 module Rhod
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/rhod.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 4.4.0"
   spec.add_development_dependency "turn", "~> 0.9.6"
 
-  spec.add_dependency "connection_pool", "~> 1.0.0"
+  spec.add_dependency "connection_pool", "~> 1.1.0"
 end

data/test/test_command.rb

@@ -96,7 +96,77 @@ describe Rhod::Command do
         pool = ConnectionPool.new(size: 1, timeout: 0) { :conn }
         Rhod::Command.new(1, pool: pool) {|a, b| [a,b]}.execute.must_equal [:conn, 1]
       end
+
+      describe "with middleware" do
+        it "triggers the before and after event" do
+          pool = ConnectionPool.new(size: 1, timeout: 0) { :conn }
+
+          @stack = MiniTest::Mock.new
+
+          cmd = Rhod::Command.new(
+            middleware_stack: @stack,
+            pool: pool
+          ) {|a| a}
+          env = cmd.instance_eval {@env}
+          @stack.expect :on, env, [:before, Hash]
+          @stack.expect :on, env, [:after, Hash]
+          cmd.execute
+          @stack.verify
+        end
+
+      end
+
+    end
+
+    describe "with middleware" do
+      it "triggers the before and after event" do
+        @stack = MiniTest::Mock.new
+        cmd = Rhod::Command.new(middleware_stack: @stack) {|a| a}
+        env = cmd.instance_eval {@env}
+        @stack.expect :on, env, [:before, Hash]
+        @stack.expect :on, env, [:after, Hash]
+        cmd.execute
+        @stack.verify
+      end
+
+      it "triggers the failure event" do
+        @stack = MiniTest::Mock.new
+        cmd = Rhod::Command.new(middleware_stack: @stack) do
+          raise StandardError, "Problem"
+        end
+        env = cmd.instance_eval {@env}
+        @stack.expect :on, env, [:before, Hash]
+        @stack.expect :on, env, [:failure, Hash]
+
+        begin
+          cmd.execute
+        rescue
+        end
+
+        @stack.verify
+      end
+
+      it "triggers the error event" do
+        @stack = MiniTest::Mock.new
+        cmd = Rhod::Command.new(
+          middleware_stack: @stack,
+          retries: 1) do
+          raise StandardError, "Problem"
+        end
+        env = cmd.instance_eval {@env}
+        @stack.expect :on, env, [:before, Hash]
+        @stack.expect :on, env, [:error, Hash]
+        @stack.expect :on, env, [:failure, Hash]
+
+        begin
+          cmd.execute
+        rescue
+        end
+
+        @stack.verify
+      end
     end
 
+
   end
 end

data/test/test_middleware.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class TestMiddleware
+  def initialize(params=nil)
+    @opts = params
+  end
+
+  def on(event, env)
+    env
+  end
+end
+
+describe Rhod::Middleware do
+  it "inits with args passed in" do
+    stack = Rhod::Middleware.new
+
+    stack.use(TestMiddleware, 1)
+    stack.build_stack
+
+    stack.instance_eval{@stack}.first.instance_eval{@opts}.must_equal 1
+  end
+
+  it "calls each callback correctly" do
+    %I[before after error failure].each do |event|
+      stack = Rhod::Middleware.new
+
+      stack.use(TestMiddleware)
+      stack.build_stack
+
+      stack.send(:on, event, output: 0)[:output].must_equal 0
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rhod
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Paul Bergeron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 description: 
 email:
 - paul.d.bergeron@gmail.com
@@ -123,6 +123,7 @@ files:
 - test/helper.rb
 - test/test_backoffs.rb
 - test/test_command.rb
+- test/test_middleware.rb
 - test/test_profile.rb
 homepage: https://github.com/dinedal/rhod
 licenses:
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: A High Avalibility framework for Ruby
@@ -152,4 +153,6 @@ test_files:
 - test/helper.rb
 - test/test_backoffs.rb
 - test/test_command.rb
+- test/test_middleware.rb
 - test/test_profile.rb
+has_rdoc: