sneakers_exponential_retry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af906d8bafee5024ee77370c828d92a22628ecdc
+  data.tar.gz: 20a9007c85f5317d311f65a9a4f7a4988aebe6ae
+SHA512:
+  metadata.gz: a6df19505aeff4c55d4c13d32686543da6ad73a4ee4b2fe2ac7de38eb44c911c8b2becf996acbc01e31ac6734b3c98a4a43b184bfe1ab2b5d00d020cb7b5a9c0
+  data.tar.gz: f6ec2b59258761e81d0ca4f378762aa6129f278fcde47204ddd0b07c132dc4ae74ac1466730f0bd223dfec7752ae5c691fade4e74444bc9ab7a52c9fe4916037

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at yanghsing.lin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sneakers_exponential_retry.gemspec
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# SneakersExponentialRetry
+
+Exponential Retry Handler for [Sneakers](https://github.com/jondot/sneakers) that just works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers_exponential_retry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sneakers_exponential_retry
+
+## Usage
+
+Configure your Sneakers by the following:
+
+```ruby
+require 'sneakers_exponential_retry'
+
+Sneakers.configure :handler => SneakersExponentialRetry,
+                   :handler_options => {
+                     :max_retry_count => 3,
+                     :logger => Sneakers.logger
+                   },
+                   :exchange => 'MyExchangeName',
+                   :exchange_type => :topic
+```
+
+## Options:
+
+- `exchange`: Exchange name to be used, required for `SneakersExponentialRetry`
+- `handler_options`:
+  - `max_retry_count`: (optional) Max retry count, default to 14
+  - `logger`: (optional) logger instance, default to nil, which would not log anything related to retrying.
+
+## How it works:
+
+TODO
+
+## Testing:
+
+Run tests by:
+
+```
+$ bundle exec rspec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mz026/sneakers_exponential_retry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sneakers_exponential_retry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sneakers_exponential_retry.rb

@@ -0,0 +1,97 @@
+require "sneakers_exponential_retry/version"
+
+class ExponentialRetry
+  MINUTE = 60 * 1000
+  DEFAULT_MAX_RETRY_COUNT = 14
+
+  def initialize(channel, queue, opts)
+    @channel = channel
+    @max_retry_count = calculate_max_retry_count(opts)
+    @retry_exchange = create_retry_exchange(queue.name)
+    @logger = opts[:handler_options] ? opts[:handler_options][:logger] : nil
+
+    create_retry_queue(queue.name, opts[:exchange])
+      .bind(@retry_exchange, :routing_key => '#')
+  end
+
+  def calculate_max_retry_count opts
+    handler_options = opts[:handler_options] || {}
+    ( handler_options[:max_retry_count] || DEFAULT_MAX_RETRY_COUNT ).to_i
+  end
+  private :calculate_max_retry_count
+
+  def create_retry_exchange queue_name
+    @channel.exchange("#{queue_name}-retry-ex",
+                      :type => 'topic',
+                      :durable => true)
+  end
+  private :create_retry_exchange
+
+  def create_retry_queue queue_name, exchange_name
+    @channel.queue(
+      "#{queue_name}-retry-queue",
+      durable: true,
+      arguments: {
+        :'x-dead-letter-exchange' => exchange_name
+      }
+    )
+  end
+  private :create_retry_queue
+
+  def acknowledge(hdr, props, msg)
+    @channel.acknowledge(hdr.delivery_tag, false)
+  end
+
+  def reject(hdr, props, msg, requeue=false)
+    @channel.reject(hdr.delivery_tag, requeue)
+  end
+
+  def error(hdr, props, msg, err)
+    handle_failing_message(hdr, props, msg, err)
+  end
+
+  def handle_failing_message hdr, props, msg, error
+    retry_count = get_retry_count(props[:headers])
+    if retry_count >= @max_retry_count
+      reject(hdr, props, msg)
+      return
+    end
+
+
+    @retry_exchange.publish(msg,
+                            :headers => {
+                              'retry-count' => retry_count + 1
+                            },
+                            :routing_key => hdr.routing_key,
+                            :expiration => expiration_time(retry_count))
+    log_retry(retry_count)
+    acknowledge(hdr, props, msg)
+  end
+  private :handle_failing_message
+
+  def log_retry count
+    return unless @logger
+    @logger.info do
+      "retry_count: #{count + 1}"
+    end
+  end
+  private :log_retry
+
+  def get_retry_count headers
+    return 0 unless headers
+    headers['retry-count'].to_i
+  end
+  private :get_retry_count
+
+  def expiration_time retry_count
+    (2 ** retry_count) * MINUTE
+  end
+  private :expiration_time
+
+  def timeout(hdr, props, msg)
+    reject(hdr, props, msg)
+  end
+
+  def noop(hdr, props, msg)
+  end
+end

data/lib/sneakers_exponential_retry/version.rb

@@ -0,0 +1,3 @@
+module SneakersExponentialRetry
+  VERSION = "0.1.0"
+end

data/sneakers_exponential_retry.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sneakers_exponential_retry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sneakers_exponential_retry"
+  spec.version       = SneakersExponentialRetry::VERSION
+  spec.authors       = ["Yang-Hsing Lin"]
+  spec.email         = ["yanghsing.lin@gmail.com"]
+
+  spec.summary       = %q{Exponential Retry Handler for Sneakers that just works.}
+  spec.homepage      = "https://github.com/mz026/sneakers_exponential_retry"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sneakers_exponential_retry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yang-Hsing Lin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- yanghsing.lin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sneakers_exponential_retry.rb
+- lib/sneakers_exponential_retry/version.rb
+- sneakers_exponential_retry.gemspec
+homepage: https://github.com/mz026/sneakers_exponential_retry
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Exponential Retry Handler for Sneakers that just works.
+test_files: []
+has_rdoc: