mongo-retry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfe67d1e2dd3025dab5b0747359076ca339d69ad
+  data.tar.gz: 46b973d9d74c40714c486cb1eabf8cd391b45655
+SHA512:
+  metadata.gz: 75ebd5a95c9741b9b02efaaa732bea9bc96f10a21827a08708e61ac43bcbfd1656c4e5c93a457326a08d4e50c4c166de8ea05cfc207db8e580628da152c63819
+  data.tar.gz: bb03c3e50de804ef8259fcf06ce6d12d692cd8bb2dea947bee1b4c95c21f50c34b30e20eb484264a0c437ad7f12fa6267013696202b3a5badc621be2260da254

data/README.md

@@ -0,0 +1,84 @@
+# Simple retry error handling on connection errors in for the [Mongo ruby driver](https://github.com/mongodb/mongo-ruby-driver)
+
+[![Build Status](https://travis-ci.org/burtcorp/mongo-retry.png?branch=master)](https://travis-ci.org/burtcorp/mongo-retry)
+[![Coverage Status](https://coveralls.io/repos/burtcorp/mongo-retry/badge.png)](https://coveralls.io/r/burtcorp/mongo-retry)
+
+In its simplest form
+```ruby
+require 'mongo'
+require 'mongo-retry'
+
+client = Mongo::MongoClient.new
+retryer = Mongo::Retry.new(client)
+
+# Will retry after 1, 5, 10 seconds and eventually fail
+# by throwing the exception thrown on the 4th attempt
+doc = retryer.connection_guard { client.db('foo')['bar'].find_one() }
+
+```
+
+You may also specify the following optional parameters here with the default values in place.
+
+```ruby
+
+retryer = Mongo::Retry.new(client,  delayer: Kernel.method(:sleep),
+    retries: DEFAULT_RETRY_SLEEPS,  # [1, 5, 10]
+    exceptions: DEFAULT_RETRYABLE_EXCEPTIONS, # [::Mongo::ConnectionError,::Mongo::ConnectionTimeoutError,::Mongo::ConnectionFailure,::Mongo::OperationTimeout]
+    retry_exceptions: DEFAULT_RETRYABLE_EXCEPTIONS, # [::Mongo::ConnectionError,::Mongo::ConnectionTimeoutError,::Mongo::ConnectionFailure,::Mongo::OperationTimeout]
+    logger: nil)
+
+```
+
+## A note on logger
+
+logger should be a lambda with two arguments
+
+```ruby
+logger = lambda { |reason, e|
+  # Where reason may be :retry, :fail, :reconnect_fail
+  p reason
+  p e
+}
+```
+
+In the default case where mongo would be down the following is expected to be received by the logger
+
+```ruby
+
+doc = retryer.connection_guard {
+  client.db('foo')['bar'].find_one()
+}
+# Would be identical have the same effect in respect to the logger as
+logger.call(:retry, exception)
+logger.call(:reconnect_fail, exception)
+logger.call(:retry, exception)
+logger.call(:reconnect_fail, exception)
+logger.call(:retry, exception)
+logger.call(:reconnect_fail, exception)
+logger.call(:fail, exception)
+
+```
+
+
+(The MIT License)
+
+Copyright (c) 2011 Burt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/mongo/retry.rb

@@ -0,0 +1,54 @@
+require 'mongo'
+
+module Mongo
+  class Retry
+    DEFAULT_RETRY_SLEEPS = [1, 5, 10].freeze
+    DEFAULT_RETRYABLE_EXCEPTIONS = [
+      ::Mongo::ConnectionError,
+      ::Mongo::ConnectionTimeoutError,
+      ::Mongo::ConnectionFailure,
+      ::Mongo::OperationTimeout
+    ]
+
+    DEFAULT_OPTIONS = {
+      delayer: Kernel.method(:sleep),
+      retries: DEFAULT_RETRY_SLEEPS,
+      exceptions: DEFAULT_RETRYABLE_EXCEPTIONS,
+      retry_exceptions: DEFAULT_RETRYABLE_EXCEPTIONS,
+      logger: nil
+    }
+
+    def initialize(connection, options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+      @connection = connection
+    end
+
+    def connection_guard(retries = @options[:retries].dup)
+      yield
+    rescue *@options[:exceptions] => e
+      if retry_timeout = retries.pop
+        log(:retry, e)
+        @options[:delayer].call(retry_timeout)
+        reconnect!
+        retry
+      else
+        log(:fail, e)
+        raise e
+      end
+    end
+
+    private
+
+    def log(reason, exception)
+      if @options[:logger]
+        @options[:logger].call(reason, exception)
+      end
+    end
+
+    def reconnect!
+      @connection.reconnect
+    rescue *@options[:retry_exceptions] => e
+      log(:reconnect_fail, e)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'mongo'
+require_relative '../lib/mongo/retry'
+RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: mongo-retry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Fonselius
+- Sofia Larsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies: []
+description: mongo-retry helper
+email:
+- fonsan@burtcorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mongo/retry.rb
+- spec/spec_helper.rb
+homepage: http://github.com/burtcorp/mongo-retry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: mongo-retry helper
+test_files:
+- spec/spec_helper.rb