sneakers_requeue_on_error 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0778beaa123f85678b33e3b728b6b4294de124d5a5294616dca483df45080e98'
+  data.tar.gz: a48211b204a37184e9c7181bbf33d66592bbcd1f4c2d31db7670868dc1b75a88
+SHA512:
+  metadata.gz: 0acba9e24b9bafedd9af164d46b19c41c36d1a59fea0d66faeb552f66d396cb5a8e93a90a1ca5887f14ffe1c77a0a441dc0a8bd702e36cef2e326e1994dd6cc0
+  data.tar.gz: 4e693f12051a46b5540bae34c179c9da4423335a7f52811d3cb0602a20f6e5d081bb6647aec307664173b3ae11298c263ec1f7312d6c53122b96176606f5103a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.gem
+/spec/lib/tmp
+*.gem
+Gemfile.lock

data/.gitlab-ci.yml

@@ -0,0 +1,38 @@
+image: "ruby:2.7"
+
+stages:
+  - release
+  - test
+
+before_script:
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - mkdir -p ~/.gem
+    - touch ~/.gem/credentials
+    - cat $RUBYGEMS_CREDENTIALS > ~/.gem/credentials
+    - cat ~/.gem/credentials
+    - chmod 0600 ~/.gem/credentials
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - sed -i "s/0.0.0/$CI_COMMIT_TAG/g" lib/sneakers_requeue_on_error/version.rb
+    - gem build sneakers_requeue_on_error.gemspec
+    - gem push sneakers_requeue_on_error*.gem
+  artifacts:
+    paths:
+      - sneakers_requeue_on_error*.gem
+    expire_in: 30 days

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Style/GlobalVars:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop'
+gem 'rubocop-shopify', "~> 1.0.4", require: false
+
+gem 'rspec'

data/README.md

@@ -0,0 +1,61 @@
+# sneakers_requeue_on_error
+
+A Sneakers worker handler that will re-queue the message when encountering an error.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers_requeue_on_error'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sneakers_requeue_on_error
+```
+
+## Usage
+
+Given a Sneakers worker:
+
+```ruby
+class MyWorker
+  include Sneakers::Worker
+  
+  from_queue :a_queue,
+             handler: SneakersRequeueOnError::Handler,
+             prefetch: 10,
+
+  def work(message)
+    # Do something worthwhile
+    ack!
+  end
+end
+```
+
+Set the handler to be `SneakersRequeueOnError::Handler`.
+
+From now on, if the `work` method encounters an error, the message will be place back on the queue.
+
+Note that Sneakers has built in error handling around the `work` method, so you shouldn't attempt to catch any errors via `rescue` unless you want to bypass the error handling altogether.
+
+## Development
+
+To contribute to this gem, simple clone the repository, run `bundle install` and run tests:
+
+```shell script
+    bundle exec rspec
+    bundle exec rubocop
+```
+
+## Releasing
+
+The release process is tied to the git tags. Simply creating a new tag and pushing will trigger a new release to rubygems.

data/lib/sneakers_requeue_on_error.rb

@@ -0,0 +1 @@
+require 'sneakers_requeue_on_error/handler'

data/lib/sneakers_requeue_on_error/handler.rb

@@ -0,0 +1,27 @@
+module SneakersRequeueOnError
+  class Handler
+    def initialize(channel, _queue, opts)
+      @channel = channel
+      @opts = opts
+    end
+
+    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)
+      reject(hdr, props, msg, true)
+    end
+
+    def timeout(hdr, props, msg)
+      reject(hdr, props, msg)
+    end
+
+    def noop(hdr, props, msg)
+    end
+  end
+end

data/lib/sneakers_requeue_on_error/version.rb

@@ -0,0 +1,3 @@
+module SneakersRequeueOnError
+  VERSION = '0.0.4'
+end

data/sneakers_requeue_on_error.gemspec

@@ -0,0 +1,18 @@
+require_relative 'lib/sneakers_requeue_on_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sneakers_requeue_on_error'
+  spec.version       = SneakersRequeueOnError::VERSION
+  spec.authors       = ['Chris Harrison']
+  spec.email         = ['chris.harrison@nexusmods.com']
+
+  spec.summary       = 'A Sneakers worker handler that will re-queue the message when encountering an error.'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: sneakers_requeue_on_error
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Chris Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- chris.harrison@nexusmods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- lib/sneakers_requeue_on_error.rb
+- lib/sneakers_requeue_on_error/handler.rb
+- lib/sneakers_requeue_on_error/version.rb
+- sneakers_requeue_on_error.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.19
+signing_key: 
+specification_version: 4
+summary: A Sneakers worker handler that will re-queue the message when encountering
+  an error.
+test_files: []