upperkut 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91c4f06d58263b93f03a4c21abb41cb855a2ec79
+  data.tar.gz: e69b6d2c5fc335e34a49814af7bfa6e4225cd985
+SHA512:
+  metadata.gz: 503f1a51933df504062ae31e285e1471c857d3f52b61cb0310abfe43f60e54c4eee2f6cc670677d652cd49c868db503ba79f4b2c849b31dc1d5c896b76a9e81c
+  data.tar.gz: f20ef3064c8d3d861abba7de081399f67d91613e7c33b7ed6aad658dfc5155784a52bbfd33f8f2a2253ff3aa753885ddd293b763ce806a111a10b64b86fec143

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    upperkut (0.1.0)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fakeredis
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  upperkut!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,43 @@
+# Upperkut
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/upperkut`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## 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
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/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/[USERNAME]/upperkut/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/upperkut

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/upperkut/cli'
+require 'pry'
+
+begin
+  cli = Upperkut::CLI.new(ARGV)
+  cli.start
+rescue => e
+  raise e
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join('\n')
+  exit 1
+end
+

data/examples/basic.rb

@@ -0,0 +1,12 @@
+require_relative '../lib/upperkut/worker'
+
+class MyWorker
+  include Upperkut::Worker
+
+  def perform(items)
+    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"
+  end
+end

data/lib/upperkut/cli.rb

@@ -0,0 +1,64 @@
+require 'optparse'
+require_relative '../upperkut'
+require_relative 'manager'
+
+module Upperkut
+  class CLI
+    def initialize(args = ARGV)
+      @options = {}
+      parse_options(args)
+    end
+
+    def start
+      if file = @options[:file]
+        require file
+      end
+
+      manager = Manager.new(@options)
+
+      r, w = IO.pipe
+      signals = %w(INT TERM)
+
+      signals.each do |signal|
+        w.puts(signal)
+      end
+
+      begin
+        manager.run
+
+        while readable_io = IO.select([r])
+          signal = readable_io.first[0].gets.strip
+          handle_signal(signal)
+        end
+      rescue Interrupt
+        puts 'Shutting down'
+        manager.stop
+        exit(0)
+      end
+    end
+
+    private
+
+   def handle_signal(sig)
+      Upperkut.logger.debug "Got #{sig} signal"
+      case sig
+      when 'INT'
+        raise Interrupt
+      when 'TERM'
+        raise Interrupt
+      end
+   end
+
+    def parse_options(args)
+      OptionParser.new do |o|
+        o.on('-w', '--worker WORKER', 'Define worker to be processed') do |arg|
+          @options[:worker] = arg
+        end
+        o.on('-r', '--require FILE', 'Indicate a file to be required') do |arg|
+          @options[:file] = arg
+        end
+
+      end.parse!(args)
+    end
+  end
+end

data/lib/upperkut/core_ext.rb

@@ -0,0 +1,17 @@
+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?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+  end if !"".respond_to?(:constantize)
+end
+

data/lib/upperkut/manager.rb

@@ -0,0 +1,25 @@
+require_relative 'core_ext'
+require_relative 'processor'
+
+module Upperkut
+  class Manager
+
+    attr_accessor :worker, :redis
+    attr_reader :stopped
+
+    def initialize(opts = {})
+      self.worker = opts.fetch(:worker).constantize
+      self.redis  = worker.setup.redis
+
+      @stopped = false
+    end
+
+    def run
+      Processor.new(self).process
+    end
+
+    def stop
+      @stopped = true
+    end
+  end
+end

data/lib/upperkut/processor.rb

@@ -0,0 +1,45 @@
+module Upperkut
+  class Processor
+
+    def initialize(manager)
+      @manager = manager
+      @worker  = @manager.worker
+      @sleeping_time = 0
+    end
+
+    def process
+      loop do
+        if should_process?
+          @sleeping_time = 0
+          process_batch
+          next
+        end
+
+        puts "sleeping for #{@worker.setup.polling_interval} seconds"
+        @sleeping_time += sleep(@worker.setup.polling_interval)
+      end
+    end
+
+    private
+
+    def should_process?
+      return false if @manager.stopped
+
+      # TODO: rename #setup by config
+      @worker.size >= @worker.setup.batch_size ||
+        @sleeping_time >= @worker.setup.max_wait
+    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
+    end
+  end
+end

data/lib/upperkut/strategy.rb

@@ -0,0 +1,41 @@
+require_relative 'util'
+
+module Upperkut
+  class Strategy
+    include Upperkut::Util
+
+    attr_accessor :worker, :redis
+
+    def initialize(worker, redis)
+      self.worker = worker
+      self.redis  = redis
+    end
+
+    def push_items(items = [])
+      return false if items.empty?
+      redis.lpush(key, encode_json_items(items))
+    end
+
+    def fetch_items(batch_size = 1000)
+      stop = [batch_size, size].min
+
+      items = redis.multi do
+        stop.times do
+          redis.lpop(key)
+        end
+      end
+
+      decode_json_items(items)
+    end
+
+    def size
+      redis.llen(key)
+    end
+
+    private
+
+    def key
+      "upperkut:buffers:#{to_underscore(worker.name)}"
+    end
+  end
+end

data/lib/upperkut/util.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+module Upperkut
+  module Util
+    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.downcase!
+      klass_name
+    end
+
+    def decode_json_items(items)
+      items.collect {|i| JSON.parse(i) }
+    end
+
+    def encode_json_items(items)
+      items.collect {|i| JSON.generate(i) }
+    end
+  end
+end

data/lib/upperkut/version.rb

@@ -0,0 +1,3 @@
+module Upperkut
+  VERSION = "0.1.0"
+end

data/lib/upperkut/worker.rb

@@ -0,0 +1,46 @@
+require 'forwardable'
+require_relative 'strategy'
+require_relative './util'
+require_relative '../upperkut'
+
+module Upperkut
+  module Worker
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def process
+      items = self.class.fetch_items
+      perform(items)
+    end
+
+    module ClassMethods
+      extend Forwardable
+
+      def_delegators :setup, :strategy
+      def_delegators :strategy, :push_items, :fetch_items, :size
+
+      def push_items(items)
+        strategy.push_items(items)
+      end
+
+      def fetch_items
+        strategy.fetch_items(setup.batch_size)
+      end
+
+      def setup_upperkut(&block)
+        yield(setup) if block_given?
+      end
+
+      def setup
+        @@setup ||=
+          begin
+            default = Upperkut::Configuration.default.clone
+            default.strategy ||= Upperkut::Strategy.new(self, default.redis)
+            default
+          end
+      end
+    end
+  end
+end

data/lib/upperkut.rb

@@ -0,0 +1,18 @@
+require_relative "upperkut/version"
+require_relative 'upperkut/worker'
+require 'redis'
+
+module Upperkut
+  class Configuration
+    attr_accessor :batch_size, :redis, :strategy, :max_wait, :polling_interval
+
+    def self.default
+      new.tap do |config|
+        config.batch_size       = 1_000
+        config.redis            = Redis.new
+        config.max_wait         = Integer(ENV['UPPERKUT_MAX_WAIT'] || 20)
+        config.polling_interval = Integer(ENV['UPPERKUT_POLLING_INTERVAL'] || 5)
+      end
+    end
+  end
+end

data/upperkut.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$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       = %q{Batch background processing tool}
+  spec.description   = %q{Batch background processing tool}
+  spec.homepage      = "http://shipit.resultadosdigitais.com.br/open-source/"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "all"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redis'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: upperkut
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Sousa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Batch background processing tool
+email:
+- nandosousafr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/upperkut
+- examples/basic.rb
+- lib/upperkut.rb
+- lib/upperkut/cli.rb
+- lib/upperkut/core_ext.rb
+- lib/upperkut/manager.rb
+- lib/upperkut/processor.rb
+- lib/upperkut/strategy.rb
+- lib/upperkut/util.rb
+- lib/upperkut/version.rb
+- lib/upperkut/worker.rb
+- upperkut.gemspec
+homepage: http://shipit.resultadosdigitais.com.br/open-source/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Batch background processing tool
+test_files: []