sneakers_handlers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a3e5a73cc16eed57ed53952d2989b5d9dc18e47
+  data.tar.gz: ba629ecd84e6b69f8477746bbb57dd360c2cc06b
+SHA512:
+  metadata.gz: c81a40929c55500b25f811f62f1620c8b5df1202d6cba891896ec3225f8d6f5bcdfe557b55b0375cf71c9c5fda2a901fde613690f4a61b5ab1567d43530ebe5f
+  data.tar.gz: d483161d7bc28c32ab53e34ca349b5f80d955ae869907877ebe15be10d7539317ce7865b0cc0c18ceaf8f7e81fe39d15d50fd1132031429b618f37921a1638a7

data/.env-example

@@ -0,0 +1,2 @@
+RABBITMQ_VHOST="/"
+RABBITMQ_URL=amqp://guest:guest@localhost

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,63 @@
+# SneakersHandlers
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sneakers_handlers`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers_handlers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sneakers_handlers
+
+## Usage
+
+The gem introduces two handlers you can use as part of your sneaker workers: `SneakersHandlers::DeadLetter` and `SneakersHandlers::RetryHandler`
+
+## Using the `SneakersHandlers::RetryHandler` handler
+
+When defining your worker, you have the following extra options:
+
+`max_retry` [optional] : The number of times a message will be processed after a rejection
+
+`x-dead-letter-routing-key` [mandatory] : The routing key that the retry queue will be bound to, usually it is the name of the original queue, for example:
+
+```ruby
+class MyWorker
+  include Sneakers::Worker
+  from_queue "my-app.resource_processor",
+      durable: true,
+      ack: true,
+      exchange: "domain_events",
+      exchange_type: :topic,
+      routing_key: "resources.lifecycle.*",
+      handler: Sneakers::Handlers::RetryHandler,
+      max_retry: 6,
+      arguments: { "x-dead-letter-exchange" => "domain_events.dlx",
+                   "x-dead-letter-routing-key" => "my-app.resource_processor" }
+
+  def work(payload)
+    ...
+  end
+end                 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/sneakers_handlers.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sneakers_handlers"
+
+# 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/circle.yml

@@ -0,0 +1,5 @@
+machine:
+  services:
+    - rabbitmq-server
+  ruby:
+    version: 2.3.0

data/lib/sneakers_handlers.rb

@@ -0,0 +1,7 @@
+require "sneakers_handlers/version"
+require 'sneakers'
+require 'sneakers_handlers/dead_letter'
+require 'sneakers_handlers/retry_handler'
+module SneakersHandlers
+  # Your code goes here...
+end

data/lib/sneakers_handlers/dead_letter.rb

@@ -0,0 +1,23 @@
+module SneakersHandlers
+  class DeadLetter < ::Sneakers::Handlers::Oneshot
+    def initialize(channel, queue, options)
+      super
+
+      create_dead_letter_exchange!(channel, queue, options)
+    end
+
+    private
+
+    def create_dead_letter_exchange!(channel, queue, options)
+      arguments = options[:queue_options][:arguments]
+
+      dlx = channel.exchange(arguments.fetch("x-dead-letter-exchange"), {
+        type: options[:exchange_options][:type],
+        durable: options[:exchange_options][:durable],
+      })
+
+      dlx_queue = channel.queue("#{queue.name}.dlx", durable: options[:queue_options][:durable])
+      dlx_queue.bind(dlx, routing_key: arguments.fetch("x-dead-letter-routing-key"))
+    end
+  end
+end

data/lib/sneakers_handlers/retry_handler.rb

@@ -0,0 +1,86 @@
+# Using this handler, failed messages will be retried a certain number of times,
+# until they are dead-lettered.
+#
+# To use it you need to defined this handler in your worker:
+#
+# from_queue "my-app.queue_name",
+#   exchange: "domain_events",
+#   routing_key: "my_routing_key",
+#   handler: Sneakers::Handlers::RetryHandler,
+#   arguments: { "x-dead-letter-exchange" => "dlx.domain_events",
+#                "x-dead-letter-routing-key" => "my-app.queue_name" }}
+#
+# By default it will retry 5 times before dead-lettering a message, but you can
+# also customize that with the `max_retry` option:
+#
+# from_queue "my-app.queue_name",
+#   exchange: "domain_events",
+#   routing_key: "my_routing_key",
+#   handler: Sneakers::Handlers::RetryHandler,
+#   max_retry: 10,
+#   arguments: { "x-dead-letter-exchange" => "dlx.domain_events",
+#                "x-dead-letter-routing-key" => "my-app.queue_name" }}
+
+module SneakersHandlers
+  class RetryHandler
+
+    def initialize(channel, queue, options)
+      @channel = channel
+      @queue = queue
+      @routing_key = options[:routing_key]
+      @max_retry = options[:max_retry] || 5
+
+      create_dlx(channel, queue, options)
+    end
+
+    def acknowledge(hdr, _props, _msg)
+      @channel.acknowledge(hdr.delivery_tag, false)
+    end
+
+    def reject(hdr, props, msg, requeue = false)
+      retry_message(hdr, props, msg)
+    end
+
+    def error(hdr, props, msg, _err)
+      retry_message(hdr, props, msg)
+    end
+
+    def timeout(hdr, props, msg)
+      retry_message(hdr, props, msg)
+    end
+
+    def noop(_hdr, _props, _msg)
+    end
+
+    private
+
+    def create_dlx(channel, queue, options)
+      arguments = options[:queue_options][:arguments]
+
+      dlx_exchange_name = arguments.fetch("x-dead-letter-exchange")
+      dlx_exchange = channel.exchange(dlx_exchange_name, {
+        type: options[:exchange_options][:type],
+        durable: options[:exchange_options][:durable],
+      })
+
+      @dlx_queue = channel.queue("#{queue.name}.dlx", durable: options[:queue_options][:durable])
+      @dlx_queue.bind(dlx_exchange, routing_key: arguments.fetch("x-dead-letter-routing-key"))
+    end
+
+    def retry_message(hdr, props, msg)
+      headers = props[:headers] || {}
+      retry_count = headers["x-retry-count"] || 1
+      if retry_count >= @max_retry
+        @channel.reject(hdr.delivery_tag)
+      else
+        Sneakers.logger.info do
+          "Retrying message: queue=#{@queue.name} retry_count=#{retry_count}."
+        end
+        @channel.default_exchange.publish(msg,
+                                          routing_key: @queue.name,
+                                          headers: { "x-retry-count": retry_count + 1 })
+        @channel.acknowledge(hdr.delivery_tag, false)
+      end
+    end
+  end
+end

data/lib/sneakers_handlers/version.rb

@@ -0,0 +1,3 @@
+module SneakersHandlers
+  VERSION = "0.0.1"
+end

data/sneakers_handlers.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sneakers_handlers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sneakers_handlers"
+  spec.version       = SneakersHandlers::VERSION
+  spec.authors       = ["John Bohn, Abe Petrillo, Brian Storti"]
+  spec.email         = ["abe.petrillo@gmail.com"]
+
+  spec.summary       = %q{Adds Handlers to use with Sneakers}
+  spec.description   = %q{Adds handlers to support retry and custom shoveling}
+  spec.homepage      = "https://github.com/alphasights/sneakers_handlers"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  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_dependency "sneakers"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sneakers_handlers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Bohn, Abe Petrillo, Brian Storti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sneakers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds handlers to support retry and custom shoveling
+email:
+- abe.petrillo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env-example"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/sneakers_handlers.rb
+- lib/sneakers_handlers/dead_letter.rb
+- lib/sneakers_handlers/retry_handler.rb
+- lib/sneakers_handlers/version.rb
+- sneakers_handlers.gemspec
+homepage: https://github.com/alphasights/sneakers_handlers
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Adds Handlers to use with Sneakers
+test_files: []
+has_rdoc: