rhod 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48eaf0e214a15e8bbedf592f83cdac4f5ad24af8
-  data.tar.gz: c58dedc35eb28bd9247516b64dee33d8083e69ae
+  metadata.gz: 99aa65709753429dc68b3979f9397bf2502e13ad
+  data.tar.gz: cd2856de21b568e00fa7bb7b097125ff722704b5
 SHA512:
-  metadata.gz: 67aca7d1a71afb19bc469c07ad193054c7df1ab1aa0e31dae5ed522bd9b04eb91cec3fea0f6d259c8f3c3ef0673e46ee8f82468ae50ecbb64029c269ee9a1f3f
-  data.tar.gz: 8cb15b2867eb6b00c1574841508e31317b8791b0f16e545b4a7df6da7ed5759c2a56b4a24ae0b2d088e795d3bde087c02960bd2e29f68b54369098aa7bc1547a
+  metadata.gz: 2245e308b5b535497b54e24681d7f512ca906b3dd1936897568b2022715063b66ed972ccb33cf0f68efdd81df5ec970533f0e67845aa01cbebd4e11762de4217
+  data.tar.gz: f8b786cde49e380879e0339513d9470f8a9c222e62e3f21eea915a3f821931b43e1b4a22752f64a9fdc8d4de8c76483b961f5fcc6a5326f58bf12f8480301df4

data/README.md

@@ -39,6 +39,17 @@ Or install it yourself as:
 
     $ gem install rhod
 
+## Configuration
+
+To configure Rhod's defaults, change any of the keys in `Rhod.defaults`
+
+```ruby
+Rhod.defaults
+=> {:retries=>0,
+ :backoffs=>#<Enumerator: ...>,
+ :fallback=>nil}
+```
+
 ## Usage
 
 Rhod has a very simple API. Design your application as you would normally, then enclose network accessing portions of your code with:
@@ -60,6 +71,29 @@ require 'rhod'
 Rhod.execute { open("http://google.com").read }
 ```
 
+## An Important note about arguments:
+
+Do not reach into the outer scope when using Rhod, instead you can pass arguments into your block like so:
+
+```ruby
+address = "http://google.com"
+
+Rhod.execute(address) do |url|
+   open(url).read
+end
+```
+
+If you need to pass options to Rhod, pass them as the last argument:
+
+```ruby
+# Works the same as the above, with but with retires.
+address = "http://google.com"
+
+Rhod.execute(address, :retries => 5) do |url|
+   open(url).read
+end
+```
+
 ### Retries with and without backoffs
 
 #### Idempotence Caution
@@ -117,6 +151,18 @@ Rhod.execute(:retries => 10, :backoffs => 0) do
 end
 ```
 
+Example, open a remote reasource, fail once it has failed 10 times, with a random wait between 1 and 5 seconds on each attempt
+
+```ruby
+require 'open-uri'
+require 'rhod'
+
+Rhod.execute(:retries => 10, :backoffs => 'r1..5') do
+  open("http://google.com").read
+end
+```
+
+
 ### Fail Silent
 
 In the event of a failure, Rhod falls back to a `fallback`. The most basic case is to fall back to a constant value.
@@ -176,6 +222,28 @@ search_engine_html = SearchEngineHTML.new
 search_engine_html.fetch
 ```
 
+## Connection Pools
+
+Sometimes you're connecting to a remote reasource using a driver that doesn't support connection pooling, which will limit the amount of strain your application puts on that reasource, and allow for reuse of existing connections instead of increasing overhead by reconnecting each time. Connection Pool support in Rhod is provided by the [connection_pool](https://github.com/mperham/connection_pool) gem.
+
+```ruby
+require 'rhod'
+require 'redis'
+require 'connection_pool'
+
+Rhod.connection_pools[:redis] = ConnectionPool.new(size:3, timeout:5) { Redis.new }
+
+Rhod.execute(:pool => :redis) {|redis| redis.set("foo", "bar") }
+```
+
+The connection is always the first argument passed into the block, the other arguments are passed in their original order after.
+
+```ruby
+key   = "foo"
+value = "bar"
+Rhod.execute(key, value, :pool => :redis) {|redis, k, v| redis.set(k, v) }
+```
+
 ## Contributing
 
 1. Fork it

data/lib/rhod.rb

@@ -1,9 +1,27 @@
 require_relative "rhod/version"
 require_relative "rhod/backoffs"
 require_relative "rhod/command"
+require 'connection_pool'
 
 module Rhod
   def self.execute(*args, &block)
     Rhod::Command.execute(*args, &block)
   end
+
+  class << self
+    attr_accessor :defaults
+
+    attr_accessor :connection_pools
+  end
+
+  self.defaults = {
+    retries: 0,
+    backoffs: Rhod::Backoffs.default,
+    fallback: nil,
+  }
+
+  self.connection_pools = {
+    default: ConnectionPool.new(size: 1, timeout: 0) { nil }
+  }
+
 end

data/lib/rhod/backoffs.rb

@@ -7,13 +7,19 @@ module Rhod::Backoffs
       backoff
     elsif backoff.is_a?(Numeric)
       constant_backoff(backoff)
+    elsif backoff.is_a?(Range)
+      random_backoffs(backoff)
     elsif backoff.is_a?(String)
-      n = (backoff[1..-1].to_i)
+      n = (backoff[1..-1].to_f)
       case backoff[0]
       when "^"
         expoential_backoffs(n)
       when "l"
         logarithmic_backoffs(n)
+      when "r"
+        min = backoff[1..-1].split("..")[0].to_f
+        max = backoff[1..-1].split("..")[1].to_f
+        random_backoffs((min..max))
       end
     elsif backoff.is_a?(Symbol)
       case backoff
@@ -21,6 +27,8 @@ module Rhod::Backoffs
         expoential_backoffs
       when :l
         logarithmic_backoffs
+      when :r
+        random_backoffs
       end
     end
   end
@@ -46,6 +54,7 @@ module Rhod::Backoffs
       end
     end
   end
+  alias default logarithmic_backoffs
 
   # Always the same backoff
   def constant_backoff(n)
@@ -56,5 +65,14 @@ module Rhod::Backoffs
     end
   end
 
-  alias default logarithmic_backoffs
+  # Returns a generator of random numbers falling inside of a range
+  def random_backoffs(range=(0..10))
+    float_range = (range.min.to_f..range.max.to_f)
+    Enumerator.new do |yielder|
+      loop do
+        yielder << rand(float_range)
+      end
+    end
+  end
+
 end

data/lib/rhod/command.rb

@@ -10,13 +10,17 @@ class Rhod::Command
     @request = block
 
     @retries = opts[:retries]
-    @retries ||= 0
+    @retries ||= Rhod.defaults[:retries]
     @attempts = 0
 
     @backoffs = Rhod::Backoffs.backoff_sugar_to_enumerator(opts[:backoffs])
-    @backoffs ||= Rhod::Backoffs.default
+    @backoffs ||= Rhod.defaults[:backoffs]
 
     @fallback = opts[:fallback]
+    @fallback ||= Rhod.defaults[:fallback]
+
+    @pool = Rhod.connection_pools[opts[:pool]]
+    @pool ||= Rhod.connection_pools[:default]
   end
 
   ### Class methods
@@ -30,7 +34,12 @@ class Rhod::Command
 
   def execute
     begin
-      @request.call(*@args)
+      @pool.with do |conn|
+        @args = [conn].concat(@args)
+        @args[0] == nil ? @args.shift : nil
+
+        @request.call(*@args)
+      end
     rescue *EXCEPTIONS
       @attempts += 1
       if @attempts <= @retries

data/lib/rhod/version.rb

@@ -1,3 +1,3 @@
 module Rhod
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/rhod.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.0.4"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "turn"
+  spec.add_development_dependency "minitest", "~> 4.4.0"
+  spec.add_development_dependency "turn", "~> 0.9.6"
+
+  spec.add_dependency "connection_pool", "~> 1.0.0"
 end

data/test/test_backoffs.rb

@@ -22,6 +22,13 @@ describe Rhod::Backoffs do
         take(3).must_equal [3.169925001442312, 4.0, 4.643856189774724]
     end
 
+    it "generates random backoffs with 'r' syntax" do
+      sample = Rhod::Backoffs.backoff_sugar_to_enumerator("r1..2").
+        take(3)
+      sample.min.floor.must_equal 1
+      sample.max.ceil.must_equal 2
+    end
+
     it "generates expoential backoffs with :^ syntax" do
       Rhod::Backoffs.backoff_sugar_to_enumerator(:^).take(3).must_equal [2.0, 4.0, 8.0]
     end
@@ -30,5 +37,12 @@ describe Rhod::Backoffs do
       Rhod::Backoffs.backoff_sugar_to_enumerator(:l).
         take(3).must_equal [0.7570232465074598, 2.403267722339301, 3.444932048942182]
     end
+
+    it "generates random backoffs with :r syntax" do
+      sample = Rhod::Backoffs.backoff_sugar_to_enumerator(:r).
+        take(100)
+      sample.min.floor.must_equal 0
+      sample.max.ceil.must_equal 10
+    end
   end
 end

data/test/test_command.rb

@@ -72,5 +72,19 @@ describe Rhod::Command do
         end
       end
     end
+
+    describe "with connection pools" do
+      it "uses the provided pool" do
+        Rhod.connection_pools[:test] = ConnectionPool.new(size: 1, timeout: 0) { :conn }
+        Rhod::Command.new {|a| a}.execute.must_equal nil
+        Rhod::Command.new(pool: :test) {|a| a}.execute.must_equal :conn
+      end
+
+      it "correctly handles arguements" do
+        Rhod.connection_pools[:test] = ConnectionPool.new(size: 1, timeout: 0) { :conn }
+        Rhod::Command.new(1, pool: :test) {|a, b| [a,b]}.execute.must_equal [:conn, 1]
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rhod
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Paul Bergeron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +56,44 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: 
 email:
 - paul.d.bergeron@gmail.com