kicks 3.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff0690a8caadf3b1b4c80039e0893f8f2484f29fec0a19278f9d855ace73355a
+  data.tar.gz: 4d69ee1e6a93f08df18cd2abbc8969bb2f7a854be45405a1be0c3c770c2bdd2f
+SHA512:
+  metadata.gz: e8991f96df285bfff54de0a9ce2bbcee0c8233fc81b8fc66d1ba617061650ea3badd5cc5270aaf2c95ec5103b85079e95e3095f05c7335b9681861cb44f90f0f
+  data.tar.gz: 43d85d3b660bd36802487769b0c518e60998227b418d427c0c69e9ce3748fc2516d574e34e5014fab3d06141d54d707f15d895e6a5648c6558a374e786e4c276

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 3.1, 3.2]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+sneakers.yaml
+Gemfile.lock
+*.log
+sneakers.pid
+sneakers.log.*
+pkg/
+coverage/
+tmp/
+.ruby-version
+.ruby-gemset
+.bundle/*
+*.gem

data/ChangeLog.md

@@ -0,0 +1,142 @@
+# Change Log
+
+## Changes Between 2.12.0 and 2.13.0 (unreleased)
+
+### Minimum Required Ruby Version
+
+Sneakers now requires Ruby 2.5 or later.
+
+### Content Encoding Support
+
+Similar to already supported content type.
+
+Contributed by @ansoncat.
+
+GitHub issue: [#449](https://github.com/jondot/sneakers/pull/449)
+
+## Changes Between 2.10.0 and 2.11.0
+
+This releases includes bug fixes, support for more queue-binding options, better
+management of the Bunny dependency, and improved documentation. Following is a
+list of the notable changes:
+
+### Rescue from ScriptError
+
+Fixes a bug that would cause Sneakers workers to freeze if an exception
+descending from `ScriptError`, such as `NotImplementedError`, is raised
+
+Contributed by @sharshenov
+
+GitHub Pull Request: [373](https://github.com/jondot/sneakers/pull/373)
+
+### Loosen Bunny dependency to minor version
+
+The dependency on Bunny is now pinned to the minor version instead of patch,
+allowing users to benefit from non-breaking updates to Bunny without having to
+wait for a Sneakers release.
+
+Contributed by @olivierlacan
+
+GitHub Pull Request: [#372](https://github.com/jondot/sneakers/pull/372)
+
+### Support `:bind_arguments` on bind
+
+It is now possible to set arguments on a queue when connecting to a headers
+exchange
+
+Contributed by @nerikj
+
+GitHub Pull Request: [#358](https://github.com/jondot/sneakers/pull/358)
+
+### Other contributions
+
+This release also contains contributions from @ivan-kolmychek (bumping up Bunny
+dependency), @michaelklishin (improving code style), and @darren987469 (adding
+examples to the README)
+
+## Changes Between 2.8.0 and 2.10.0
+
+This release contains **minor breaking API changes**.
+
+### Worker Timeouts are No Longer Enforced
+
+This is a **breaking change** for `Sneakers::Worker` implementations.
+
+Timeouts can be disruptive and dangerous depending on what the workers do but not having them can also
+lead to operational headaches.
+
+The outcome of [a lengthy discussion](https://github.com/jondot/sneakers/issues/343) on possible
+alternatives to the timeout mechanisms is that only applications
+can know where it is safe to enforce a timeout (and how).
+
+`Sneakers::Worker` implementations are now expected to enforce timeouts
+in a way that makes sense (and is safe) to them.
+
+GitHub issues: [#343](https://github.com/jondot/sneakers/issues/343).
+
+
+## Changes Between 2.6.0 and 2.7.0
+
+This release requires Ruby 2.2 and has **breaking API changes**
+around custom error handlers.
+
+### Use Provided Connections in WorkerGroup
+
+It is now possible to use a custom connection instance in worker groups.
+
+Contributed by @pomnikita.
+
+GitHub issue: [#322](https://github.com/jondot/sneakers/pull/322)
+
+
+### Worker Context Available to Worker Instances
+
+Contributed by Jason Lombardozzi.
+
+GitHub issue: [#307](https://github.com/jondot/sneakers/pull/307)
+
+
+### Ruby 2.2 Requirement
+
+Sneakers now [requires Ruby 2.2](https://github.com/jondot/sneakers/commit/f33246a1bd3b5fe53ee662253dc5bac7864eec97).
+
+
+### Bunny 2.9.x
+
+Bunny was [upgraded](https://github.com/jondot/sneakers/commit/c7fb0bd23280082e43065d7199668486db005c13) to 2.9.x.
+
+
+
+### Server Engine 2.0.5
+
+Server Engine dependency was [upgraded to 2.0.5](https://github.com/jondot/sneakers/commit/3f60fd5e88822169fb04088f0ce5d2f94f803339).
+
+
+### Refactored Publisher Connection
+
+Contributed by Christoph Wagner.
+
+GitHub issue: [#325](https://github.com/jondot/sneakers/pull/325)
+
+
+### New Relic Reporter Migrated to the Modern API
+
+Contributed by @adamors.
+
+GitHub issue: [#324](https://github.com/jondot/sneakers/pull/324)
+
+
+### Configuration Logged at Debug Level
+
+To avoid potentially leaking credentials in the log.
+
+Contributed by Kimmo Lehto.
+
+GitHub issue: [#301](https://github.com/jondot/sneakers/pull/301).
+
+
+### Comment Corrections
+
+Contributed by Andrew Babichev
+
+GitHub issue: [#346](https://github.com/jondot/sneakers/pull/346)

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.4-alpine
+
+RUN apk add --no-cache git
+
+RUN apk --update add --virtual build_deps \
+                               build-base \
+                               ruby-dev \
+                               libc-dev \
+                               linux-headers \
+                               openssl-dev
+
+WORKDIR /sneakers
+
+COPY lib/sneakers/version.rb lib/sneakers/version.rb
+
+COPY sneakers.gemspec .
+
+COPY Gemfile* ./
+
+RUN bundle install --retry=3
+
+COPY . .
+
+CMD rake test

data/Dockerfile.slim

@@ -0,0 +1,20 @@
+FROM ruby:2.3-alpine
+
+RUN apk add --no-cache git
+
+ADD . /sneakers
+
+WORKDIR /sneakers
+
+RUN apk --update add --virtual build_deps \
+                               build-base \
+                               ruby-dev \
+                               libc-dev \
+                               linux-headers \
+                               openssl-dev && \
+
+    bundle --jobs=4 --retry=3 && \
+
+    apk del build_deps
+
+CMD rake test

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'ruby-prof', platforms: [:ruby_22, :ruby_23, :ruby_24]
+
+gem 'rake', '>= 12.3', '< 14.0'
+gem 'metric_fu', github: 'metricfu/metric_fu', branch: 'main'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+
+guard :minitest do
+  watch(%r{^spec/(.*)_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2016 Dotan Nahum
+
+MIT License
+
+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/README.md

@@ -0,0 +1,209 @@
+# Kicks, né Sneakers
+
+[![CI](https://github.com/ruby-amqp/kicks/actions/workflows/ci.yml/badge.svg)](https://github.com/ruby-amqp/kicks/actions/workflows/ci.yml)
+
+```
+      __
+  ,--'  >
+  `=====
+
+```
+
+## What is Kicks?
+
+Kicks is a high-performance RabbitMQ background processing framework for
+Ruby, originally developed by @jondot 👏 under the name of [Sneakers](https://github.com/jondot/sneakers).
+The original repo was abandoned by the person who has exclusive control
+over the RubyGems project, so the community of users has decided to move it
+to this "fork" (continuation) under the new name.
+
+By virtue of its Sneakers lineage, Kicks is a mature project that has been around since 2016.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Important: this name will change once Kicks 3.0.0 (the initial release) is published
+gem 'sneakers'
+```
+
+And then execute:
+
+```shell-session
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell-session
+$ gem install sneakers
+```
+
+## Documentation
+
+A quick start guide is available in the section below.
+
+Visit the [wiki](https://github.com/jondot/sneakers/wiki) for more detailed
+documentation and [GitHub releases](https://github.com/jondot/sneakers/releases) for release
+notes.
+
+A [change log](./ChangeLog.md) is also available.
+
+## Quick start
+
+Set up a Gemfile
+
+```ruby
+source 'https://rubygems.org'
+gem 'sneakers'
+gem 'json'
+gem 'redis'
+```
+
+How do we add a worker? Firstly create a file and name it as `boot.rb`
+then create a worker named as `Processor`.
+
+> touch boot.rb
+
+```ruby
+require 'sneakers'
+require 'redis'
+require 'json'
+
+$redis = Redis.new
+
+class Processor
+  include Sneakers::Worker
+  from_queue :logs
+
+  def work(msg)
+    err = JSON.parse(msg)
+    if err["type"] == "error"
+      $redis.incr "processor:#{err["error"]}"
+    end
+
+    ack!
+  end
+end
+```
+
+Let's test it out quickly from the command line:
+
+```shell-session
+$ sneakers work Processor --require boot.rb
+```
+
+We just told Sneakers to spawn a worker named `Processor`, but first `--require` a file that we dedicate to setting up environment, including workers and what-not.
+
+If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was created. Push a couple messages like below:
+
+```javascript
+{
+   "type": "error",
+   "message": "HALP!",
+   "error": "CODE001"
+}
+```
+
+Publish a message with the [bunny](https://github.com/ruby-amqp/bunny) gem RabbitMQ client:
+
+```ruby
+require 'bunny'
+
+conn = Bunny.new
+conn.start
+
+ch = conn.create_channel
+ch.default_exchange.publish({ type: 'error', message: 'HALP!', error: 'CODE001' }.to_json, routing_key: 'logs')
+
+conn.close
+```
+
+And this is the output you should see at your terminal.
+
+```
+2013-10-11T19:26:36Z p-4718 t-ovqgyb31o DEBUG: [worker-logs:1:213mmy][#<Thread:0x007fae6b05cc58>][logs][{:prefetch=>10, :durable=>true, :ack=>true, :heartbeat_interval=>2, :exchange=>"sneakers"}] Working off: log log
+2013-10-11T19:26:36Z p-4718 t-ovqgyrxu4 INFO: log log
+2013-10-11T19:26:40Z p-4719 t-ovqgyb364 DEBUG: [worker-logs:1:h23iit][#<Thread:0x007fae6b05cd98>][logs][{:prefetch=>10, :durable=>true, :ack=>true, :heartbeat_interval=>2, :exchange=>"sneakers"}] Working off: log log
+2013-10-11T19:26:40Z p-4719 t-ovqgyrx8g INFO: log log
+```
+
+We'll count errors and error types with Redis.
+
+``` shell-session
+$ redis-cli monitor
+1381520329.888581 [0 127.0.0.1:49182] "incr" "processor:CODE001"
+```
+
+We're basically done with the ceremonies and all is left is to do some real work.
+
+### Looking at metrics
+
+Let's use the `logging_metrics` provider just for the sake of fun of seeing the metrics as they happen.
+
+```ruby
+# boot.rb
+require 'sneakers'
+require 'redis'
+require 'json'
+require 'sneakers/metrics/logging_metrics'
+Sneakers.configure(metrics: Sneakers::Metrics::LoggingMetrics.new)
+
+# ... rest of code
+```
+
+Now push a message again and you'll see:
+
+```
+2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: INC: work.Processor.started
+2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: TIME: work.Processor.time 0.00242
+2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: INC: work.Processor.handled.ack
+```
+
+Which increments `started` and `handled.ack`, and times the work unit.
+
+From here, you can continue over to the
+[Wiki](https://github.com/jondot/sneakers/wiki)
+
+# Docker
+
+If you use Docker, there's some benefits to be had and you can use both
+`docker` and `docker-compose` with this project, in order to run tests,
+integration tests or a sample worker without setting up RabbitMQ or the
+environment needed locally on your development box.
+
+* To build a container run `docker build . -t sneakers_sneakers`
+* To run non-integration tests within a docker container, run `docker run --rm
+  sneakers_sneakers:latest`
+* To run full integration tests within a docker topology including RabbitMQ,
+  Redis (for integration worker) run `scripts/local_integration`, which will
+  use docker-compose to orchestrate the topology and the sneakers Docker image
+  to run the tests
+* To run a sample worker within Docker, try the `TitleScraper` example by
+  running `script/local_worker`. This will use docker-compose as well. It will
+  also help you get a feeling for how to run Sneakers in a Docker based
+  production environment
+* Use `Dockerfile.slim` instead of `Dockerfile` for production docker builds.
+  It generates a more compact image, while the "regular" `Dockerfile` generates
+  a fatter image - yet faster to iterate when developing
+
+# Compatibility
+
+* Sneakers main branch: Ruby 3.0+
+* Sneakers 2.7.x and later (using Bunny 2.9): Ruby 2.2.x
+* Sneakers 1.1.x and later (using Bunny 2.x): Ruby 2.x
+* Sneakers 1.x.x and earlier: Ruby 1.9.x, 2.x
+
+# Contributing
+
+Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
+
+### Thanks:
+
+To all Sneakers [Contributors](https://github.com/jondot/sneakers/graphs/contributors) - you make this happen, thanks!
+
+# Copyright
+
+Copyright (c) 2015-2018 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'metric_fu'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.warning = false
+end
+
+task default: :test
+

data/bin/sneakers

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'sneakers'
+require 'sneakers/cli'
+
+Sneakers.server = true
+Sneakers::CLI.start

data/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3'
+
+services:
+  sneakers:
+    build: .
+    volumes:
+      - .:/sneakers
+    depends_on:
+      - rabbitmq
+      - redis
+    environment:
+      - RABBITMQ_URL=amqp://guest:guest@rabbitmq:5672
+
+  rabbitmq:
+    image: rabbitmq:management-alpine
+    ports:
+      - "5672:5672"
+      - "15672:15672"
+
+  redis:
+    image: redis:alpine
+    ports:
+      - "6379:6379"
+

data/examples/benchmark_worker.rb

@@ -0,0 +1,22 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'sneakers'
+
+class BenchmarkWorker
+  include Sneakers::Worker
+  from_queue 'downloads',
+             exchange_options: { durable: false },
+             queue_options: { durable: false },
+             :ack => true,
+             :threads => 50,
+             :prefetch => 50,
+             :timeout_job_after => 1,
+             :exchange => 'dummy',
+             :heartbeat => 5,
+             :amqp_heartbeat => 10
+  def work(msg)
+    ack!
+  end
+end
+
+
+

data/examples/max_retry_handler.rb

@@ -0,0 +1,68 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'sneakers'
+require 'sneakers/runner'
+require 'sneakers/handlers/maxretry'
+require 'logger'
+
+Sneakers.configure(:handler => Sneakers::Handlers::Maxretry,
+                   :workers => 1,
+                   :threads => 1,
+                   :prefetch => 1,
+                   :exchange => 'sneakers',
+                   :exchange_options => { :type => 'topic', durable: true },
+                   :routing_key => ['#', 'something']
+                   )
+Sneakers.logger.level = Logger::DEBUG
+
+WORKER_OPTIONS = {
+  :ack => true,
+  :threads => 1,
+  :prefetch => 1,
+  :timeout_job_after => 60,
+  :heartbeat => 5,
+  :amqp_heartbeat => 10,
+  :retry_timeout => 5000
+}
+
+# Example of how to write a retry worker. If your rabbit system is empty, then
+# you must run this twice. Once to setup the exchanges, queues and bindings a
+# second time to have the sent message end up on the downloads queue.
+#
+# Run this via:
+#   bundle exec ruby examples/max_retry_handler.rb
+#
+class MaxRetryWorker
+  include Sneakers::Worker
+  from_queue 'downloads', WORKER_OPTIONS
+
+  def work(msg)
+    logger.info("MaxRetryWorker rejecting msg: #{msg.inspect}")
+
+    # We always want to reject to see if we do the proper timeout
+    reject!
+  end
+end
+
+# Example of a worker on the same exchange that does not fail, so it should only
+# see the message once.
+class SucceedingWorker
+  include Sneakers::Worker
+  from_queue 'uploads', WORKER_OPTIONS
+
+  def work(msg)
+    logger.info("SucceedingWorker succeeding on msg: #{msg.inspect}")
+    ack!
+  end
+end
+
+messages = 1
+puts "feeding messages in"
+messages.times {
+  Sneakers.publish(" -- message -- ",
+                   :to_queue => 'anywhere',
+                   :persistence => true)
+}
+puts "done"
+
+r = Sneakers::Runner.new([MaxRetryWorker, SucceedingWorker])
+r.run

data/examples/metrics_worker.rb

@@ -0,0 +1,34 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'sneakers'
+require 'sneakers/runner'
+require 'sneakers/metrics/logging_metrics'
+require 'open-uri'
+
+
+class MetricsWorker
+  include Sneakers::Worker
+
+  from_queue 'downloads'
+
+  def work(msg)
+    title = extract_title(open(msg))
+    logger.info "FOUND <#{title}>"
+    ack!
+  end
+
+  private
+
+  def extract_title(html)
+    html =~ /<title>(.*?)<\/title>/
+    $1
+  end
+end
+
+
+Sneakers.configure(:metrics => Sneakers::Metrics::LoggingMetrics.new)
+r = Sneakers::Runner.new([ MetricsWorker ])
+r.run
+
+
+
+

data/examples/middleware_worker.rb

@@ -0,0 +1,36 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'sneakers'
+require 'sneakers/runner'
+
+class MiddlewareWorker
+  include Sneakers::Worker
+
+  from_queue 'middleware-demo',
+    ack: false
+
+  def work(message)
+    puts "******** MiddlewareWorker -> #{message}"
+  end
+end
+
+class DemoMiddleware
+  def initialize(app, *args)
+    @app = app
+    @args = args
+  end
+
+  def call(deserialized_msg, delivery_info, metadata, handler)
+    puts "******** DemoMiddleware - before; args #{@args}"
+    res = @app.call(deserialized_msg, delivery_info, metadata, handler)
+    puts "******** DemoMiddleware - after"
+    
+    res
+  end
+end
+
+Sneakers.configure
+Sneakers.middleware.use(DemoMiddleware, foo: :bar)
+
+Sneakers.publish("{}", :to_queue => 'middleware-demo')
+r = Sneakers::Runner.new([MiddlewareWorker])
+r.run