upperkut 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ec2e461543486232e5fef688a00cbcef1a605fa
-  data.tar.gz: 6a4dbf806dcf5f8e9833b2e8062dcb39b8d6f184
+  metadata.gz: 63f529ffa09940fb3f2a582ffa78481ad7d89f92
+  data.tar.gz: 12053d8b945ffb8de49042d65900de5733f99b5a
 SHA512:
-  metadata.gz: c67e94633c0f33071724af9f939bc0b0ba3db29262c97526a386daba2cb66a0c89101c34ab42f284ee9bacd7b43a6664b55ffa5fbf79e91fbc7fe112e1a0d196
-  data.tar.gz: 06ceffd02b4bb83bdf1e2dfad936def7dbad1d6d7b2cab2c6d7faf965c119f7bda3e1bc7d7b4957ed732049f0b7851a887a281b8b2ee90683d40def39b64ba3a
+  metadata.gz: 51c9e0e67d3382964a5f88172765f8c940ca71c6c4532bbc180a750636d68c110509469ab963bbeb1921e7b596b6bd5e6bd47d677f6dda2eec478d0f2c5766f2
+  data.tar.gz: 11144703a803d44935b71f896e2d423c7f51ecdc19b30468476e0fddc7751b1429df66d016300da92bf41a20c3766fefa523b8f84f60bffe60f9a0a54759a654

data/.rspec

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

data/Gemfile

@@ -1,9 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in upperkut.gemspec
 gemspec
 
-gem 'pry'
 gem 'fakeredis'
+gem 'pry'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    upperkut (0.1.1)
+    upperkut (0.1.3)
       redis (>= 3.3.5, < 5)
 
 GEM
@@ -43,4 +43,4 @@ DEPENDENCIES
   upperkut!
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -20,45 +20,45 @@ Or install it yourself as:
 
 ## Usage
 Examples:
-                                                                                                        
+
 1) Create a Worker class and the define how to process the batch;
-  ```ruby                                                                                                      
+  ```ruby
   class MyWorker
     include Upperkut::Worker
-                                                                                                        
+
     # This is optional
-                                                                                                        
-    setup_upperkut do |s|
+
+    setup_upperkut do |config|
       # Define which redis instance you want to use
-      s.redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
-                                                                                                        
+      config.redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
+
       # Define the amount of items must be accumulated
-      s.batch_size = 2_000 # The default value is 1_000
-                                                                                                        
+      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. You can also set the env
+      # batch. The default value is 5 seconds. You can also set the env
       # UPPERKUT_POLLING_INTERVAL.
-      s.polling_interval = 4
-                                                                                                        
-      # How long the Processor should wait to process batch even though
-      # the amount of items did not reached the batch_size.
-      s.max_wait = 300
+      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;
-  ```ruby                                                                                                
-  Myworker.push([{'id' => SecureRandom.uuid}, 'name' => 'Robert C Hall',  'action' => 'EMAIL_OPENNED'])
+  ```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

data/Rakefile

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

data/bin/upperkut

@@ -5,9 +5,8 @@ require_relative '../lib/upperkut/cli'
 begin
   cli = Upperkut::CLI.new(ARGV)
   cli.start
-rescue => e
+rescue StandardError => e
   STDERR.puts e.message
   STDERR.puts e.backtrace.join('\n')
   exit 1
 end
-

data/examples/basic.rb

@@ -4,7 +4,7 @@ class MyWorker
   include Upperkut::Worker
 
   def perform(items)
-    puts "starting performing"
+    puts 'starting performing'
     exec_time = rand(90..500)
     sleep (exec_time.to_f / 1000.to_f)
     puts "performed #{items.size} items in #{exec_time.to_f / 1000.to_f} ms"

data/lib/upperkut/cli.rb

@@ -19,7 +19,7 @@ module Upperkut
       manager = Manager.new(@options)
 
       r, w = IO.pipe
-      signals = %w(INT TERM)
+      signals = %w[INT TERM]
 
       signals.each do |signal|
         trap signal do
@@ -64,7 +64,6 @@ module Upperkut
         o.on('-c', '--concurrency INT', 'Numbers of threads to spawn') do |arg|
           @options[:concurrency] = Integer(arg)
         end
-
       end.parse!(args)
     end
   end

data/lib/upperkut/core_ext.rb

@@ -1,17 +1,18 @@
 begin
   require 'active_support/core_ext/string/inflections'
 rescue LoadError
-  class String
-    def constantize
-      names = self.split('::')
-      names.shift if names.empty? || names.first.empty?
+  unless ''.respond_to?(:constantize)
+    class String
+      def constantize
+        names = split('::')
+        names.shift if names.empty? || names.first.empty?
 
-      constant = Object
-      names.each do |name|
-        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
       end
-      constant
     end
-  end if !"".respond_to?(:constantize)
+  end
 end
-

data/lib/upperkut/manager.rb

@@ -3,7 +3,6 @@ require_relative 'processor'
 
 module Upperkut
   class Manager
-
     attr_accessor :worker, :redis
     attr_reader :stopped
 
@@ -26,9 +25,7 @@ module Upperkut
     end
 
     def kill
-      @processors.each do |processor|
-        processor.kill
-      end
+      @processors.each(&:kill)
     end
   end
 end

data/lib/upperkut/processor.rb

@@ -1,6 +1,5 @@
 module Upperkut
   class Processor
-
     def initialize(manager)
       @manager = manager
       @worker  = @manager.worker
@@ -12,8 +11,9 @@ module Upperkut
         process
       end
     end
+
     def kill
-      return if !@thread
+      return unless @thread
       @thread.raise Upperkut::Shutdown
     end
 
@@ -35,7 +35,7 @@ module Upperkut
       buffer_size = @worker.size
 
       return false if @manager.stopped
-      return false if buffer_size == 0
+      return false if buffer_size.zero?
 
       # TODO: rename #setup by config
       buffer_size >= @worker.setup.batch_size ||
@@ -43,15 +43,13 @@ module Upperkut
     end
 
     def process_batch
-      begin
-        @sleeping_time = 0
-        @worker.new.process
-      rescue Exception => ex
-        # Add to retry_queue
-        # if retry_limit is reached
-        # send to dead
-        raise ex
-      end
+      @sleeping_time = 0
+      @worker.new.process
+    rescue Exception => ex
+      # Add to retry_queue
+      # if retry_limit is reached
+      # send to dead
+      raise ex
     end
   end
 end

data/lib/upperkut/strategy.rb

@@ -12,8 +12,9 @@ module Upperkut
     end
 
     def push_items(items = [])
+      items = [items] if items.is_a?(Hash)
       return false if items.empty?
-      redis.lpush(key, encode_json_items(items))
+      redis.rpush(key, encode_json_items(items))
     end
 
     def fetch_items(batch_size = 1000)
@@ -41,6 +42,10 @@ module Upperkut
       lat
     end
 
+    def clear
+      redis.del(key)
+    end
+
     private
 
     def key

data/lib/upperkut/util.rb

@@ -5,9 +5,9 @@ module Upperkut
     def to_underscore(object)
       klass_name = object
       klass_name.gsub!(/::/, '_')
-      klass_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-      klass_name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      klass_name.tr!("-", "_")
+      klass_name.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      klass_name.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      klass_name.tr!('-', '_')
       klass_name.downcase!
       klass_name
     end
@@ -22,7 +22,7 @@ module Upperkut
     end
 
     def decode_json_items(items)
-      items.collect {|i| JSON.parse(i) }
+      items.collect { |i| JSON.parse(i) }
     end
   end
 end

data/lib/upperkut/version.rb

@@ -1,3 +1,3 @@
 module Upperkut
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'.freeze
 end

data/lib/upperkut/worker.rb

@@ -5,7 +5,6 @@ require_relative '../upperkut'
 
 module Upperkut
   module Worker
-
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -21,7 +20,7 @@ module Upperkut
       extend Forwardable
 
       def_delegators :setup, :strategy
-      def_delegators :strategy, :push_items, :size, :latency
+      def_delegators :strategy, :push_items, :size, :latency, :clear
 
       def push_items(items)
         strategy.push_items(items)
@@ -31,7 +30,7 @@ module Upperkut
         strategy.fetch_items(setup.batch_size)
       end
 
-      def setup_upperkut(&block)
+      def setup_upperkut
         yield(setup) if block_given?
       end
 

data/lib/upperkut.rb

@@ -13,21 +13,21 @@ require 'redis'
 #
 #     # This is optional
 #
-#     setup_upperkut do |s|
+#     setup_upperkut do |config|
 #       # Define which redis instance you want to use
-#       s.redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
+#       config.redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
 #
 #       # Define the amount of items must be accumulated
-#       s.batch_size = 2_000 # The default value is 1_000
+#       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. You can also set the env
+#       # batch. The default value is 5 seconds. You can also set the env
 #       # UPPERKUT_POLLING_INTERVAL.
-#       s.polling_interval = 4
+#       config.polling_interval = 4
 #
-#       # How long the Processor should wait to process batch even though
-#       # the amount of items did not reached the batch_size.
-#       s.max_wait = 300
+#       # 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)
@@ -40,7 +40,9 @@ require 'redis'
 #
 # 2) Start pushings items;
 #
-#   Myworker.push([{'id' => SecureRandom.uuid}, 'name' => 'Robert C Hall',  'action' => 'EMAIL_OPENNED'])
+#   Myworker.push_items(
+#     [{'id' => SecureRandom.uuid, 'name' => 'Robert C Hall',  'action' => 'EMAIL_OPENNED'}]
+#   )
 #
 # 3) Start Upperkut;
 #
@@ -61,5 +63,6 @@ module Upperkut
     end
   end
 
-  class Shutdown < StandardError ; end
+  # Error class responsible to signal the shutdown process
+  class Shutdown < StandardError; end
 end

data/upperkut.gemspec

@@ -1,5 +1,5 @@
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'upperkut/version'
 
@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Nando Sousa']
   spec.email         = ['nandosousafr@gmail.com']
 
-  spec.summary       = %q{Batch background processing tool}
-  spec.description   = %q{Batch background processing tool}
+  spec.summary       = 'Batch background processing tool'
+  spec.description   = 'Batch background processing tool'
   spec.homepage      = 'http://shipit.resultadosdigitais.com.br/open-source/'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upperkut
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Batch background processing tool