upperkut 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf84d6612f4c9577cfe53e578e16983e3936863379c7d4c1041e9c92637f867
-  data.tar.gz: ce0ad624fe65306bb8fe818b8018acfe519326cbb744ef9af0519b26fd25faed
+  metadata.gz: 731a0ea07d1228421c4c5a306f3de6217e11f2a594e25e28ebf333f85056c9cc
+  data.tar.gz: 35680bb770644d47331488900de47a8ba1f2848d90cd8437511c1809ed15be32
 SHA512:
-  metadata.gz: 3f6325ce299c9af7c50c9891acee2e771131d002c27b27fe6e245227d73ce177afd65451116daf7a5af5fc5e546b8b52b796ea82abf05bb8eae88966a16efa46
-  data.tar.gz: 482e700d0cd87b0f6de61c528ef42d7c57bbc96afce8d5d6b1593420a4fa9308f6be668cc8c183fc98b9347a6a33800be9df5bebc3da98ac7a673f2204440cc2
+  metadata.gz: 0521a72596013f4e2333bf28e2e189df95dd36a781375a90e45f0f59ee59c39d1026d80822fceb798cf9fb929335a82019f50ffe701cbd48d8dfe89daafa0b06
+  data.tar.gz: 3e0f9d1e0449aa4d6e70d76e9ea954b29624fca7efe549812d5aad3f76d653ef4fc787e70e371bd2c1b06a51e366fc8e0406f351cf9275fa008a948ee724e08d

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upperkut
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -39,7 +39,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,46 +100,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Dockerfile
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- Makefile
-- README.md
-- Rakefile
 - bin/upperkut
-- docker-compose.yml
-- examples/basic.rb
-- examples/priority_worker.rb
-- examples/scheduled_worker.rb
-- examples/with_middlewares.rb
-- lib/upperkut.rb
-- lib/upperkut/cli.rb
-- lib/upperkut/core_ext.rb
-- lib/upperkut/item.rb
-- lib/upperkut/logging.rb
-- lib/upperkut/manager.rb
-- lib/upperkut/middleware.rb
-- lib/upperkut/middlewares/datadog.rb
-- lib/upperkut/middlewares/new_relic.rb
-- lib/upperkut/middlewares/rollbar.rb
-- lib/upperkut/processor.rb
-- lib/upperkut/redis_pool.rb
-- lib/upperkut/strategies/base.rb
-- lib/upperkut/strategies/buffered_queue.rb
-- lib/upperkut/strategies/priority_queue.rb
-- lib/upperkut/strategies/scheduled_queue.rb
-- lib/upperkut/util.rb
-- lib/upperkut/version.rb
-- lib/upperkut/worker.rb
-- lib/upperkut/worker_thread.rb
-- upperkut.gemspec
 homepage: http://shipit.resultadosdigitais.com.br/open-source/
 licenses:
 - MIT
@@ -152,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Batch background processing tool

data/.circleci/config.yml

@@ -1,65 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.7.2
-        environment:
-          CC_TEST_REPORTER_ID: 03ab83a772148a577d29d4acf438d7ebdc95c632224122d0ba8dbb291eedebe6
-          COVERAGE: true
-          REDIS_URL: redis://localhost:6379
-      - image: redis:5.0
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: Setup Code Climate test-reporter
-          command: |
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-            chmod +x ./cc-test-reporter
-            ./cc-test-reporter before-build
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-
-            bundle exec rspec --format progress \
-                            --format RspecJunitFormatter \
-                            --out /tmp/test-results/rspec.xml \
-                            --format progress \
-                            $TEST_FILES
-      - run:
-          name: Submit coverage
-          command: |
-            ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results

data/.codeclimate.yml

@@ -1,15 +0,0 @@
-version: "2"
-plugins:
-  brakeman:
-    enabled: false
-  eslint:
-    enabled: false
-  csslint:
-    enabled: false
-  rubocop:
-    enabled: true
-    channel: rubocop-0-63
-  reek:
-    enabled: true
-  bundler-audit:
-    enabled: true

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-*.gem

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---require spec_helper
---order random

data/CHANGELOG.md

@@ -1,52 +0,0 @@
-# Upperkut changes
-
-1.0.x
--------
--  Add docker
-- Fix to_underscore bug for ruby 2.7.2 #83 @andrehjr;
-
-
-0.8.x
---------
-- Added exponential backoff when push_items #57
-- Introducing Item to avoid losing enqueued at and report wrong latency
-  metrics #56 thanks to @jeangnc
-
-0.7.x
----------
-- Fix logging timeout message #54 by @jeanmatheussouto
-- Add handle_error method #44
-- Added Datahog Middleware (#42)
-- Added Priority Queue (#39) thanks to @jeangnc and @jeanmatheussouto
-- Added Scheduled Queue Implementation thanks to @rodrigo-araujo #38
-- Added Datahog middleware #42 by @gabriel-augusto
-- Added redis to CI #40 by #henrich-m
-- Specs improvements #34 and #35, #37 by @gabriel-augusto
-- Enable Rubocop #32 by @henrich-m
-- Added codeclimate #31 by @henrich-m
-- Extract Buffered Queue behavior to its own strategy #29
-
-0.6.x
----------
-- Set redis url when env var REDIS_URL is set thanks to @lucaskds #22
-- Enable users to pass their own connection pool also thanks to @lucaskds #21
-- Sets default concurrency to 1
-- Creates connection pools by default;
-- Simplifies API to enable extension via Strategy;
-
-0.5.x
-----------
-- Introducing client middlewares.
-- Fix issue that prevented worker to run.
-- Fix thread-unsafe code that was overwriting worker configurations when
-multiples workers were configured in the same process.
-
-0.4.x
------------
-
-- Change redis versioning policy #17
-- Fixed error that prevented users from start upperkut from non Rails apps.
-- Added integration with Rollbar.
-- Added backtrace to logs when some error occurs.
-- Fixed NewRelic trace args
-

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-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.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nandosousafr@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -1,7 +0,0 @@
-FROM ruby:2.7.2
-
-WORKDIR /code
-COPY . .
-
-RUN gem install bundler
-RUN bundle install

data/Gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in upperkut.gemspec
-gemspec
-
-gem 'fivemat'
-gem 'pry'
-gem 'rspec_junit_formatter'
-gem 'simplecov', '< 0.18', require: false

data/Gemfile.lock

@@ -1,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    upperkut (1.0.2)
-      connection_pool (~> 2.2, >= 2.2.2)
-      redis (>= 4.1.0, < 5.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.3)
-    connection_pool (2.2.3)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    fivemat (1.3.7)
-    json (2.3.1)
-    method_source (1.0.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (13.0.1)
-    redis (4.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.16)
-  fivemat
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rspec_junit_formatter
-  simplecov (< 0.18)
-  upperkut!
-
-BUNDLED WITH
-   2.1.4

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Nando Sousa
-
-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/Makefile

@@ -1,4 +0,0 @@
-bash:
-	docker-compose run gem bash
-specs:
-	docker-compose run gem bundle exec rspec

data/README.md

@@ -1,162 +0,0 @@
-# Upperkut
-
-[![CircleCI](https://circleci.com/gh/ResultadosDigitais/upperkut/tree/master.svg?style=svg&circle-token=693e512de6985be3b3db12279ba6ed508fb5c6f6)](https://circleci.com/gh/ResultadosDigitais/upperkut/tree/master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ece40319b0db03af891d/maintainability)](https://codeclimate.com/repos/5b318a7c6d37b70272008676/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ece40319b0db03af891d/test_coverage)](https://codeclimate.com/repos/5b318a7c6d37b70272008676/test_coverage)
-
-[[Docs]](https://www.rubydoc.info/gems/upperkut/0.7.2/Upperkut)
-
-Background processing framework for Ruby applications.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'upperkut'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install upperkut
-
-## Usage
-
-### Example 1 - Buffered Queue:
-
-1) Create a Worker class and the define how to process the batch;
-  ```ruby
-  class MyWorker
-    include Upperkut::Worker
-
-    def perform(batch_items)
-      heavy_processing(batch_items)
-      process_metrics(batch_items)
-    end
-  end
-  ```
-
-2) Start pushing items;
-  ```ruby
-  MyWorker.push_items(
-    [
-      {
-        'id' => SecureRandom.uuid,
-        'name' => 'Robert C Hall',
-        'action' => 'EMAIL_OPENNED'
-      }
-    ]
-  )
-  ```
-
-3) Start Upperkut;
-  ```bash
-  $ bundle exec upperkut --worker MyWorker --concurrency 10
-  ```
-
-### Example 2 - Scheduled Queue:
-
-1) Create a Worker class and the define how to process the batch;
-  ```ruby
-  require 'upperkut/strategies/scheduled_queue'
-  class MyWorker
-    include Upperkut::Worker
-
-    setup_upperkut do |config|
-      config.strategy = Upperkut::Strategies::ScheduledQueue.new(self)
-    end
-
-    def perform(batch_items)
-      heavy_processing(batch_items)
-      process_metrics(batch_items)
-    end
-  end
-  ```
-
-2) Start pushing items with `timestamp` parameter;
-  ```ruby
-  # timestamp is 'Thu, 10 May 2019 23:43:58 GMT'
-  MyWorker.push_items(
-    [
-      {
-        'timestamp' => '1557531838',
-        'id' => SecureRandom.uuid,
-        'name' => 'Robert C Hall',
-        'action' => 'SEND_NOTIFICATION'
-      }
-    ]
-  )
-  ```
-
-3) Start Upperkut;
-  ```bash
-  $ bundle exec upperkut --worker MyWorker --concurrency 10
-  ```
-
-### Example 3 - Priority Queue:
-
-Note: priority queues requires redis 5.0.0+ as it uses ZPOP* commands.
-
-1) Create a Worker class and the define how to process the batch;
-  ```ruby
-  require 'upperkut/strategies/priority_queue'
-
-  class MyWorker
-    include Upperkut::Worker
-
-    setup_upperkut do |config|
-      config.strategy = Upperkut::Strategies::PriorityQueue.new(
-        self,
-        priority_key: -> { |item| item['tenant_id'] }
-      )
-    end
-
-    def perform(items)
-      items.each do |item|
-        puts "event dispatched: #{item.inspect}"
-      end
-    end
-  end
-  ```
-
-2) So you can enqueue items from different tenants;
-  ```ruby
-  MyWorker.push_items(
-    [
-      { 'tenant_id' => 1, 'id' => 1 },
-      { 'tenant_id' => 1, 'id' => 2 },
-      { 'tenant_id' => 1, 'id' => 3 },
-      { 'tenant_id' => 2, 'id' => 4 },
-      { 'tenant_id' => 3, 'id' => 5 },
-    ]
-  )
-  ```
-
-  The code above will enqueue items as follows `1, 4, 5, 2, 3`
-
-3) Start Upperkut;
-  ```bash
-  $ bundle exec upperkut --worker MyWorker --concurrency 10
-  ```
-
-## Development
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests.
-
-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/ResultadosDigitais/upperkut. 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.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Upperkut project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ResultadosDigitais/upperkut/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/docker-compose.yml

@@ -1,18 +0,0 @@
-services:
-  gem:
-    build: .
-    volumes:
-      - .:/code
-    environment:
-      - REDIS_URL=redis://redis:6379
-    depends_on:
-      - redis
-  redis:
-    image: redis:5.0.4-alpine
-    command: redis-server --save "" --appendonly yes --appendfsync everysec
-    ports:
-      - 6379:6379
-    volumes:
-      - redis-data:/data
-volumes:
-  redis-data:

data/examples/basic.rb

@@ -1,12 +0,0 @@
-require_relative '../lib/upperkut/worker'
-
-class MyWorker
-  include Upperkut::Worker
-
-  def perform(items)
-    puts 'starting performing'
-    exec_time = rand(9000..50_000)
-    sleep (exec_time.to_f / 1000.to_f)
-    puts "performed #{items.size} items in #{exec_time.to_f / 1000.to_f} ms"
-  end
-end

data/examples/priority_worker.rb

@@ -1,21 +0,0 @@
-require_relative '../lib/upperkut/worker'
-require_relative '../lib/upperkut/strategies/priority_queue'
-
-class PriorityWorker
-  include Upperkut::Worker
-
-  setup_upperkut do |config|
-    config.strategy = Upperkut::Strategies::PriorityQueue.new(
-      self,
-      priority_key: -> { |item| item['tenant_id'] },
-      batch_size: 1
-    )
-  end
-
-  def perform(items)
-    items.each do |item|
-      puts "event dispatched: #{item.inspect}"
-      sleep 1
-    end
-  end
-end