worker-glass 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f20197a329197164ab1cbd91a21d25180a871cc8
+  data.tar.gz: 56dbd94122c19db5ed9b2d90e16d102dc55324e9
+SHA512:
+  metadata.gz: e943604a60634a4c019043599e7d7b502cb9525add70048417d7e2dd2fe562fa1f84dc3f942b4b13d8b0d1223dd76df79939606adf5407ba068327f67ed9f6c6
+  data.tar.gz: e7aaa1fcaafe67f09a06c4bef79fdb258d5c61efa675369cd5858d0f7b9e4ecc9d28add7ab73d31be3c06aefe194f3d904783c58177dd8a413785474a4c6ccd4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+worker_glass

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3
+script:
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# WorkerGlass changelog
+
+## 0.2.0
+- Renamed from SidekiqGlass to WorkerGlass because if now does not require Sidekiq anymore to work. It will provide additional worker functionalities to any type of backend processing layer as long as it has a #perform method.
+- Switched to Mongoid like feature providing by including/prepending functionalities
+- WorkerGlass no longer required
+- WorkerGlass::Timeout
+- WorkerGlass::Reentrancy
+
+## 0.1.4
+
+- New Sidekiq (4.0.1) version dump
+
+## 0.1.3
+
+- Added null-logger gem
+
+## 0.1.2
+
+- SidekiqGlass logger implementation
+
+## 0.1.1
+
+- Celluloid lock due to some Celluloid internal issues
+
+## 0.1.0
+
+- Initial released version

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'polishgeeks-dev-tools'
+end

data/Gemfile.lock

@@ -0,0 +1,208 @@
+PATH
+  remote: .
+  specs:
+    worker-glass (0.2.0)
+      activesupport
+      null-logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (3.1.3)
+      erubis (~> 2.6)
+      fastercsv (~> 1.5)
+      haml (>= 3.0, < 5.0)
+      highline (>= 1.6.20, < 2.0)
+      multi_json (~> 1.2)
+      ruby2ruby (>= 2.1.1, < 2.3.0)
+      ruby_parser (~> 3.7.0)
+      safe_yaml (>= 1.0)
+      sass (~> 3.0)
+      slim (>= 1.3.6, < 4.0)
+      terminal-table (~> 1.4)
+    bson (4.0.0)
+    builder (3.2.2)
+    codeclimate-engine-rb (0.1.0)
+      virtus (~> 1.0)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    faker (1.6.1)
+      i18n (~> 0.5)
+    fastercsv (1.5.5)
+    flay (2.6.1)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.3.2)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    haml (4.0.7)
+      tilt
+    haml-lint (0.13.0)
+      haml (~> 4.0)
+      rubocop (>= 0.25.0)
+      sysexits (~> 1.1)
+    highline (1.7.8)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    minitest (5.8.3)
+    mongo (2.2.1)
+      bson (~> 4.0)
+    mongoid (5.0.1)
+      activemodel (~> 4.0)
+      mongo (~> 2.1)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-rspec (3.0.0)
+      mongoid (~> 5.0)
+      rake
+      rspec (~> 3.3)
+    multi_json (1.11.2)
+    null-logger (0.1.0)
+    origin (2.1.1)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    polishgeeks-dev-tools (1.2.1)
+      brakeman
+      faker
+      haml-lint
+      mongoid-rspec
+      pry
+      rspec
+      rubocop
+      rubycritic
+      shoulda
+      simplecov
+      timecop
+      yard
+    powerpack (0.1.1)
+    private_attr (1.1.0)
+    procto (0.0.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    reek (3.7.1)
+      codeclimate-engine-rb (~> 0.1.0)
+      parser (~> 2.2, >= 2.2.2.5)
+      private_attr (~> 1.1)
+      rainbow (~> 2.0)
+      unparser (~> 0.2.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
+    ruby2ruby (2.2.0)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.7.2)
+      sexp_processor (~> 4.1)
+    rubycritic (2.3.0)
+      flay (= 2.6.1)
+      flog (= 4.3.2)
+      parser (>= 2.2.0, < 3.0)
+      reek (= 3.7.1)
+      virtus (~> 1.0)
+    safe_yaml (1.0.4)
+    sass (3.4.20)
+    sexp_processor (4.6.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slop (3.6.0)
+    sysexits (1.2.0)
+    temple (0.7.6)
+    terminal-table (1.5.2)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    timecop (0.8.0)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unparser (0.2.4)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.2)
+      procto (~> 0.0.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  polishgeeks-dev-tools
+  worker-glass!
+
+BUNDLED WITH
+   1.10.6

data/MIT-LICENCE

@@ -0,0 +1,18 @@
+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,94 @@
+# Worker Glass
+
+[![Build Status](https://travis-ci.org/karafka/worker-glass.svg?branch=master)](https://travis-ci.org/karafka/worker-glass) [![Code Climate](https://codeclimate.com/github/karafka/worker-glass/badges/gpa.svg)](https://codeclimate.com/github/karafka/worker-glass)
+[![Gem Version](https://badge.fury.io/rb/worker-glass.svg)](http://badge.fury.io/rb/worker-glass)
+
+  WorkerGlass provides optional timeout and after failure (reentrancy) for background processing worker engines (like Sidekiq, Resque, etc).
+
+## Reentrancy
+
+If you don't know what is reentrancy, you can read about it [here](http://dev.mensfeld.pl/2014/05/ruby-rails-sinatra-background-processing-reentrancy-for-your-workers-is-a-must-be/).
+
+## Setup
+
+If you want to use timeout and/or reentrancy, please add appropriate modules into your worker.
+
+WorkerGlass allows to configure following options:
+
+| Method           | Arguments | Description                                                                              |
+|------------------|-----------|------------------------------------------------------------------------------------------|
+| self.logger=     | Logger    | Set logger which will be used by Worker Glass (if not defined, null logger will be used) |
+
+## Usage
+
+WorkerGlass has few submodules that you can prepend to your workers to obtain given functionalities:
+
+| Module                  | Description                                                       |
+|-------------------------|-------------------------------------------------------------------|
+| WorkerGlass::Reentrancy | Provides additional reentrancy layer if anything goes wrong       |
+| WorkerGlass::Timeout    | Allows to set a timeout after which a given worker task will fail |
+
+
+### WorkerGlass::Timeout
+
+If you want to provide timeouts for your workers, just prepend WorkerGlass::Timeout to your worker and set the timeout value:
+
+```ruby
+class Worker2 < WorkerGlass::Worker
+  prepend WorkerGlass::Timeout
+
+  self.timeout = 60 # 1 minute timeout
+
+  def perform(first_param, second_param, third_param)
+    SomeService.new.process(first_param, second_param, third_param)
+  end
+end
+
+Worker2.perform_async(example1, example2, example3)
+```
+
+### WorkerGlass::Reentrancy
+
+If you want to provide reentrancy for your workers, just include WorkerGlass::Reentrancy to your worker and define **after_failure** method that will be executed uppon failure:
+
+```ruby
+class Worker3 < WorkerGlass::Worker
+  include WorkerGlass::Reentrancy
+
+  def perform(first_param, second_param, third_param)
+    SomeService.new.process(first_param, second_param, third_param)
+  end
+
+  def after_failure(first_param, second_param, third_param)
+    SomeService.new.reset_state(first_param, second_param, third_param)
+  end
+end
+
+Worker3.perform_async(example1, example2, example3)
+```
+
+## References
+
+* [Sidekiq](http://sidekiq.org/)
+* [Karafka framework](https://github.com/karafka/karafka)
+* [Waterdrop](https://github.com/karafka/waterdrop)
+* [Worker Glass](https://github.com/karafka/worker-glass)
+* [Envlogic](https://github.com/karafka/envlogic)
+* [Null Logger](https://github.com/karafka/null-logger)
+* [Worker Glass Travis CI](https://travis-ci.org/karafka/worker-glass)
+* [Worker Glass Code Climate](https://codeclimate.com/github/karafka/worker-glass)
+
+## Note on Patches/Pull Requests
+
+Fork the project.
+Make your feature addition or bug fix.
+Add tests for it. This is important so I don't break it in a future version unintentionally.
+Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches.
+
+Each pull request must pass our quality requirements. To check if everything is as it should be, we use [PolishGeeks Dev Tools](https://github.com/polishgeeks/polishgeeks-dev-tools) that combine multiple linters and code analyzers. Please run:
+
+```bash
+bundle exec rake
+```
+
+to check if everything is in order. After that you can submit a pull request.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'polishgeeks-dev-tools'
+
+PolishGeeks::DevTools.setup do |config|
+  config.brakeman = false
+  config.haml_lint = false
+end
+
+desc 'Self check using polishgeeks-dev-tools'
+task :check do
+  PolishGeeks::DevTools::Runner.new.execute(
+    PolishGeeks::DevTools::Logger.new
+  )
+end
+
+task default: :check

data/lib/worker_glass/errors.rb

@@ -0,0 +1,11 @@
+module WorkerGlass
+  # Module enclosing all the errors that might be raised from this library
+  module Errors
+    # Base class for all the WorkerGlass internal errors
+    class BaseError < StandardError; end
+    # Raised when we use Timeout feature and timeout occurs
+    class TimeoutError < BaseError; end
+    # Raised when we use Timeout feature but we don't specify default timeout
+    class TimeoutNotDefined < BaseError; end
+  end
+end

data/lib/worker_glass/reentrancy.rb

@@ -0,0 +1,28 @@
+module WorkerGlass
+  # This module provides a reentrancy functionality for background processing engine
+  # @note If will reraise a given error - it does not silence them
+  # @example Example usage with Sidekiq - if something fails, after_failure will be executed
+  #   class Worker
+  #     include Sidekiq::Worker
+  #     prepend WorkerGlass::Reentrancy
+  #
+  #     def perform(*args)
+  #       FailingService.new.run(*args)
+  #     end
+  #
+  #     def after_failure(*args)
+  #       FailingService.new.reset(*args)
+  #     end
+  #   end
+  module Reentrancy
+    # Executes a business logic with additional timeouts
+    # @param args Any arguments that we passed when scheduling a background job
+    def perform(*args)
+      super
+    rescue => exception
+      WorkerGlass.logger.fatal(exception)
+      after_failure(*args)
+      raise exception
+    end
+  end
+end

data/lib/worker_glass/timeout.rb

@@ -0,0 +1,29 @@
+module WorkerGlass
+  # This module provides additional timeout functionality for background processing engine
+  # @example Example usage with Sidekiq - will fail with timeout error after 10 seconds
+  #   class Worker
+  #     include Sidekiq::Worker
+  #     prepend WorkerGlass::Timeout
+  #
+  #     self.timeout = 10
+  #
+  #     def perform(*args)
+  #       SlowService.new.run(*args)
+  #     end
+  #   end
+  module Timeout
+    # Adds a timeout class attribute to prepended class
+    # @param base [Class] base class to which we prepend this module
+    def self.prepended(base)
+      base.class_attribute :timeout
+    end
+
+    # Executes a business logic with additional timeouts
+    # @param args Any arguments that we passed when scheduling a background job
+    # @raise [WorkerGlass::Errors::TimeoutNotDefined] if we didn't define timeout
+    def perform(*args)
+      fail Errors::TimeoutNotDefined unless self.class.timeout
+      ::Timeout.timeout(self.class.timeout, Errors::TimeoutError) { super }
+    end
+  end
+end

data/lib/worker_glass/version.rb

@@ -0,0 +1,5 @@
+# Main wrapper
+module WorkerGlass
+  # Current version of WorkerGlass gem
+  VERSION = '0.2.0'
+end

data/lib/worker_glass.rb

@@ -0,0 +1,25 @@
+%w(
+  null_logger
+  active_support/core_ext/class/attribute
+).each { |lib| require lib }
+
+base_path = File.dirname(__FILE__) + '/worker_glass'
+
+%w(
+  version
+  errors
+  timeout
+  reentrancy
+).each { |lib| require File.join(base_path, lib) }
+
+# Background worker wrappers that provides optional timeout and after failure (reentrancy)
+module WorkerGlass
+  class << self
+    attr_writer :logger
+
+    # @return [Logger] logger that we want to use
+    def logger
+      @logger ||= NullLogger.new
+    end
+  end
+end

data/worker-glass.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake'
+require 'worker_glass/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "worker-glass"
+  spec.version       = WorkerGlass::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Maciej Mensfeld', 'Pavlo Vavruk']
+  spec.email         = %w( maciej@mensfeld.pl pavlo.vavruk@gmail.com )
+  spec.summary       = 'Timeout and Reentrancy for your background processing workers!'
+  spec.description   = 'Background worker wrappers that provides optional timeout and after failure (reentrancy)'
+  spec.homepage      = 'https://github.com/karafka/worker-glass'
+  spec.license       = 'MIT'
+
+  spec.add_dependency 'null-logger'
+  spec.add_dependency 'activesupport'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = %w( lib )
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: worker-glass
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+- Pavlo Vavruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: null-logger
+  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: activesupport
+  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'
+description: Background worker wrappers that provides optional timeout and after failure
+  (reentrancy)
+email:
+- maciej@mensfeld.pl
+- pavlo.vavruk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- Rakefile
+- lib/worker_glass.rb
+- lib/worker_glass/errors.rb
+- lib/worker_glass/reentrancy.rb
+- lib/worker_glass/timeout.rb
+- lib/worker_glass/version.rb
+- worker-glass.gemspec
+homepage: https://github.com/karafka/worker-glass
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Timeout and Reentrancy for your background processing workers!
+test_files: []
+has_rdoc: