upperkut 1.0.3 → 1.0.4

data/lib/upperkut/worker_thread.rb

@@ -0,0 +1,37 @@
+require_relative 'processor'
+
+module Upperkut
+  class WorkerThread
+    def initialize(manager, processor)
+      @manager = manager
+      @processor = processor
+    end
+
+    def run
+      @thread ||= Thread.new do
+        begin
+          @processor.blocking_process
+        rescue Exception => e
+          @manager.logger.debug(
+            action: :processor_killed,
+            reason: e,
+            stacktrace: e.backtrace
+          )
+
+          @manager.notify_killed_processor(self)
+        end
+      end
+    end
+
+    def stop
+      @processor.stop
+    end
+
+    def kill
+      return unless @thread
+
+      @thread.raise Upperkut::Shutdown
+      @thread.value # wait
+    end
+  end
+end

data/lib/upperkut.rb

@@ -0,0 +1,103 @@
+require_relative 'upperkut/version'
+require_relative 'upperkut/worker'
+require 'redis'
+
+# Public: Upperkut is a batch background processing tool for Ruby.
+#
+# Examples:
+#
+# 1) Create a Worker class and the define how to process the batch;
+#
+#   class MyWorker
+#     include Upperkut::Worker
+#
+#     # This is optional
+#
+#     setup_upperkut do |config|
+#       # Define which redis instance you want to use
+#       config.strategy = Upperkut::Strategy.new(
+#         self,
+#         redis: { url: ENV['ANOTHER_REDIS_URL'] }
+#       )
+#
+#       # Define the amount of items must be accumulated
+#       config.batch_size = 2_000 # The default value is 1_000
+#
+#       # How frequent the Processor should hit redis looking for elegible
+#       # batch. The default value is 5 seconds. You can also set the env
+#       # UPPERKUT_POLLING_INTERVAL.
+#       config.polling_interval = 4
+#
+#       # How long the Processor should wait in seconds to process batch
+#       # even though the amount of items did not reached the batch_size.
+#       config.max_wait = 300
+#     end
+#
+#     def perform(batch_items)
+#       SidekiqJobA.perform_async(batch_items)
+#       SidekiqJobB.perform_async(batch_items)
+#
+#       process_metrics(batch_items)
+#     end
+#   end
+#
+# 2) Start pushings items;
+#
+#   Myworker.push_items(
+#     [{'id' => SecureRandom.uuid, 'name' => 'Robert C Hall',  'action' => 'EMAIL_OPENNED'}]
+#   )
+#
+# 3) Start Upperkut;
+#
+#   $ bundle exec upperkut -worker MyWorker --concurrency 10
+#
+# 4) That's it :)
+module Upperkut
+  class Configuration
+    attr_accessor :strategy, :polling_interval
+
+    def self.default
+      new.tap do |config|
+        config.polling_interval = Float(ENV['UPPERKUT_POLLING_INTERVAL'] || 5)
+      end
+    end
+
+    def server_middlewares
+      @server_middlewares ||= init_middleware_chain
+      yield @server_middlewares if block_given?
+      @server_middlewares
+    end
+
+    def client_middlewares
+      @client_middlewares ||= Middleware::Chain.new
+      yield @client_middlewares if block_given?
+      @client_middlewares
+    end
+
+    private
+
+    def init_middleware_chain
+      chain = Middleware::Chain.new
+
+      if defined?(NewRelic::Agent)
+        require_relative 'upperkut/middlewares/new_relic'
+        chain.add(Upperkut::Middlewares::NewRelic)
+      end
+
+      if defined?(Rollbar::VERSION)
+        require_relative 'upperkut/middlewares/rollbar'
+        chain.add(Upperkut::Middlewares::Rollbar)
+      end
+
+      if defined?(Datadog)
+        require_relative 'upperkut/middlewares/datadog'
+        chain.add(Upperkut::Middlewares::Datadog)
+      end
+
+      chain
+    end
+  end
+
+  # Error class responsible to signal the shutdown process
+  class Shutdown < StandardError; end
+end

data/upperkut.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'upperkut/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'upperkut'
+  spec.version       = Upperkut::VERSION
+  spec.authors       = ['Nando Sousa']
+  spec.email         = ['nandosousafr@gmail.com']
+
+  spec.summary       = 'Batch background processing tool'
+  spec.description   = 'Batch background processing tool'
+  spec.homepage      = 'http://shipit.resultadosdigitais.com.br/open-source/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = ['upperkut']
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.add_dependency 'connection_pool', '~> 2.2', '>= 2.2.2'
+  spec.add_dependency 'redis', '>= 4.1.0', '< 6.0.0'
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upperkut
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -100,7 +100,49 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
 - bin/upperkut
+- catalog-info.yaml
+- 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