lepus 0.0.1.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aecb8b8247c618b92702f4d38ddd12662dbb5e8d4b1c18782796ab7caf790c6b
+  data.tar.gz: 3da8d288fad18c9174db8e18c989e1f6e861d0ced3116e6ea20c6ce892d80f53
+SHA512:
+  metadata.gz: eb553b2b3b980b9d64c5a04f9c4c56634003e7f3e850b17a2437343ebc9834019d5778673e891ce2f0ec8abec02b2f54155fbf5b3c9766a80348497139a47995
+  data.tar.gz: cbea89d36fffc882720d0f148549c39a5f0d7211ff38035218e387549c14d2a716012ddafa616599c4e819a6346ccb5b9ed794c8b73369aaf5e223af6dc0449e

data/.github/workflows/specs.yml

@@ -0,0 +1,44 @@
+name: Specs
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0']
+        gemfile:
+          - Gemfile
+          - gemfiles/rails61.gemfile
+    name: ${{ matrix.ruby }}-${{ matrix.gemfile }}
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    services:
+      rabbitmq:
+        image: rabbitmq:3-management
+        options: >-
+          --health-cmd "rabbitmq-diagnostics ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5672:5672
+          - 15672:15672
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+      env:
+        RABBITMQ_URL: amqp://localhost:5672

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.env
+/.rspec_status
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/app/consumers/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.8

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2024-08-01
+The first release of the gem
+* Added: Initial implementation with support to Sidekiq and Faktory backends
+* UniqueJob middleware to avoid duplicated jobs

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lepus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    lepus (0.0.1.beta2)
+      bunny
+      concurrent-ruby
+      multi_json
+      thor
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    amq-protocol (2.3.2)
+    ast (2.4.2)
+    bigdecimal (3.1.8)
+    bunny (2.23.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    dotenv (2.8.1)
+    hashdiff (1.1.1)
+    json (2.7.5)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    multi_json (1.15.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.1.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rbtree (0.4.6)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.33.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.2.0)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    set (1.0.4)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    standard (1.37.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    thor (1.3.2)
+    unicode-display_width (2.6.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  lepus!
+  pry
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  standard
+  webmock
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Marcos G. Zimmermann
+
+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,213 @@
+# Lepus
+
+
+Lepus is a simple and lightweight Ruby library to help you to consume and produce messages to [RabbitMQ](https://www.rabbitmq.com/) using the [Bunny](https://github.com/ruby-amqp/bunny) gem. It's similar to the Sidekiq, Faktory, ActiveJob, SolidQueue, and other libraries, but using RabbitMQ as the message broker.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lepus'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install lepus
+```
+
+## Usage
+
+
+## Configuration
+
+You can configure the Lepus using the `Lepus.configure` method. The configuration options are:
+
+- `rabbitmq_url`: The RabbitMQ host. Default: to `RABBITMQ_URL` environment variable or `amqp://guest:guest@localhost:5672`.
+- `connection_name`: The connection name. Default: `Lepus`.
+- `recovery_attempts`: The number of attempts to recover the connection. Nil means infinite. Default: `10`.
+- `recover_from_connection_close`: If the connection should be recovered when it's closed. Default: `true`.
+- `app_executor`: The [Rails executor](https://guides.rubyonrails.org/threading_and_code_execution.html#executor) used to wrap asynchronous operations. Only available if you are using Rails. Default: `nil`.
+- `on_thread_error`: The block to be executed when an error occurs on the thread. Default: `nil`.
+- `process_heartbeat_interval`: The interval in seconds between heartbeats. Default is `60 seconds`.
+- `process_alive_threshold`: the threshold in seconds to consider a process alive. Default is `5 minutes`.
+
+
+```ruby
+Lepus.configure do |config|
+  config.connection_name = 'MyApp'
+  config.rabbitmq_url = ENV.fetch('RABBITMQ_URL', 'amqp://guest:guest@localhost:5672')
+end
+```
+
+## Defining a Consumer
+
+To define a consumer, you need to create a class inheriting from `Lepus::Consumer` and implement the `perform` method. The `perform` method will be called when a message is received. Use the `configure` method to set the queue name, exchange name, and other options.
+
+The example below defines a consumer with required settings:
+
+```ruby
+class MyConsumer < Lepus::Consumer
+  configure(
+    queue: "queue_name",
+    exchange: "exchange_name",
+    routing_key: %w[routing_key1 routing_key2],
+  )
+
+  def perform(message)
+    puts "delivery_info: #{message.delivery_info}"
+    puts "metadata: #{message.metadata}"
+    puts "payload: #{message.payload}"
+
+    ack!
+  end
+end
+```
+
+### Consumer Configuration
+
+The `configure` method accepts the following options:
+
+- **\*** `queue`: . The queue name or a Hash with the queue options. Default: `nil`.
+- **\*** `exchange`: The exchange name or a Hash with the exchange options. Default: `nil`.
+- `routing_key`: One or more routing keys. Default: `nil`.
+- `bind`: The binding options. Default: `nil`.
+- `retry_queue`: Boolean or a Hash to configure the retry queue. Default: `false`.
+- `error_queue`: Boolean or a Hash to configure the error queue. Default: `false`.
+
+Options marked with `*` are required.
+
+You can pass a more descriptive configuration using a Hash with custom options for each part of message broker:
+
+```ruby
+class MyConsumer < Lepus::Consumer
+  configure(
+    queue: {
+      name: "queue_name",
+      durable: true,
+      # You can set any other exchange options here
+      # arguments: { 'x-message-ttl' => 60_000 }
+    },
+    exchange: {
+      name: "exchange_name",
+      type: :direct, # You may use :direct, :fanout, :topic, or :headers
+      durable: true,
+      # You can set any other exchange options here
+      # arguments: { 'x-message-ttl' => 60_000 }
+    },
+    bind: {
+      routing_key: %w[routing_key1 routing_key2]
+    },
+    retry_queue: { # As shortcut, you can just pass `true` to create a retry queue with default options below.
+      name: "queue_name.retry",
+      durable: true,
+      delay: 5000,
+    },
+    error_queue: { # As shortcut, you can just pass `true` to create an error queue with default options below.
+      name: "queue_name.error",
+      durable: true,
+    }
+  )
+  # ...
+end
+```
+
+By declaring the `retry_queue` option, it will automatically create a queue named `queue_name.retry` and use the arguments `x-dead-letter-exchange` and `x-dead-letter-routing-key` to route rejected messages to it. When routed to the retry queue, messages will wait there for the number of milliseconds specified in `delay`, after which they will be redelivered to the original queue.
+**Note that this will not automatically catch unhandled errors. You still have to catch any errors yourself and reject your message manually for the retry mechanism to work.**
+
+It may result in a infinite loop if the message is always rejected. To avoid this, you can use the `error_queue` option to route the message to an `queue_name.error` queue after a number of attempts by using the `MaxRetry` middleware covered in the next section.
+
+Refer to the [Dead Letter Exchanges](https://www.rabbitmq.com/docs/dlx) documentation for more information about retry.
+
+### Middlewares
+
+Consumers can use middlewares for recurring tasks like logging, error handling, parsing, and others. It comes with a few built-in middlewares:
+
+* `:max_retry`: Rejects the message and routes it to the error queue after a number of attempts.
+* `:json`: Parses the message payload as JSON.
+
+You can use the `use` method to add middlewares to the consumer:
+
+```ruby
+class MyConsumer < Lepus::Consumer
+  use(
+    :max_retry,
+    retries: 6,
+    error_queue: "queue_name.error" # The queue to route the message after the number of retries
+  )
+
+  use(
+    :json,
+    symbolize_keys: true,
+    on_error: proc { :nack } # The default is :reject on parsing error
+  )
+
+  def perform(message)
+    puts message.payload[:name]
+    ack!
+  end
+end
+```
+
+You can also create your own middlewares, just create subclasses of `Lepus::Middleware` and implement the `call` method:
+
+```ruby
+class MyMiddleware < Lepus::Middleware
+  def initialize(**options)
+    @options = options
+  end
+
+  def call(message, app
+    # Do something before calling the next middleware
+    app.call(message)
+  end
+end
+```
+
+## Starting the Consumer Process
+
+To start the consumer, can use the `lepus` CLI:
+
+```bash
+bundle exec lepus
+```
+
+You can pass one or more consumers to the `lepus` CLI:
+
+```bash
+bundle exec lepus start MyConsumer1 MyConsumer2 --debug
+```
+
+Each consumer will run in a separate process, and a supervisor will monitor them. If a consumer crashes, the supervisor will restart it.
+
+### Puma Plugin
+
+We provide a Puma plugin if you want to run the Lepus's supervisor together with Puma and have Puma monitor and manage it. You just need to add
+
+```ruby
+plugin :lepus
+```
+
+**Note**: The Puma plugin is only available if you are using Puma 6.x or higher.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/marcosgz/lepus.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dotenv/load"
+require "pry"
+require "lepus"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+find gemfiles -type f \( -iname "*.gemfile" ! -iname "*.lock" \) -exec bundle install --gemfile {} \;

data/docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  rabbitmq:
+    image: rabbitmq
+    ports:
+      - 5672:5672
+      - 15672:15672
+    command: >
+      sh -c "rabbitmq-plugins enable rabbitmq_management && rabbitmq-server"

data/exec/lepus

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "lepus"
+require "lepus/cli"
+
+Lepus::CLI.start

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 5.2", ">= 5.2.8.1"