sidekiq-glass 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96f70026aa4ae013f1f265fab9d7c16300b9ecaf
+  data.tar.gz: b3620f7ee2035edc7b37147da00074161f968eee
+SHA512:
+  metadata.gz: d4d33e313fc5b06a027c8a3a5243223809d1b23c722a3348b9166b5f3bfe1003f9b4ba98ebca3e571993bc05427c6e4188a599d5834a30e6db384ceb059068dc
+  data.tar.gz: a39226e4845b8cfe3e5b2e0c351d46c08ddaaeb11d41eb6867e457c83692cb761c349f4332e4f92453b8a733a462f9f47efce305763bf9548a503dfcbde0aa06

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 @@
+sidekiq_glass

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.2
+script:
+  - bundle exec rake

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,214 @@
+GIT
+  remote: git://github.com/polishgeeks/polishgeeks-dev-tools.git
+  revision: 6799827c21bb2e066a7f6be28f66d413ff60c69b
+  specs:
+    polishgeeks-dev-tools (1.0.0)
+      brakeman
+      faker
+      haml-lint
+      mongoid-rspec
+      pry
+      rspec
+      rubocop
+      rubycritic (= 1.2.1)
+      shoulda
+      simplecov
+      timecop
+      yard
+
+PATH
+  remote: .
+  specs:
+    sidekiq-glass (0.1.0)
+      sidekiq (= 3.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activesupport (4.2.3)
+      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.0.5)
+      erubis (~> 2.6)
+      fastercsv (~> 1.5)
+      haml (>= 3.0, < 5.0)
+      highline (~> 1.6.20)
+      multi_json (~> 1.2)
+      ruby2ruby (~> 2.1.1)
+      ruby_parser (~> 3.7.0)
+      sass (~> 3.0)
+      terminal-table (~> 1.4)
+    bson (3.2.1)
+    builder (3.2.2)
+    celluloid (0.16.1)
+      timers (~> 4.0.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)
+    connection_pool (2.2.0)
+    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.4.3)
+      i18n (~> 0.5)
+    fastercsv (1.5.5)
+    flay (2.4.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.2.1)
+      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.6.21)
+    hitimes (1.2.2)
+    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.0)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-rspec (2.2.0)
+      mongoid (~> 4.0.0)
+      rake
+      rspec (~> 3.1)
+    moped (2.0.6)
+      bson (~> 3.0)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.11.2)
+    optionable (0.2.0)
+    origin (2.1.1)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    procto (0.0.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    redis (3.2.1)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    reek (1.6.3)
+      parser (~> 2.2.0.pre.7)
+      rainbow (>= 1.99, < 3.0)
+      unparser (~> 0.2.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.33.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    ruby2ruby (2.1.4)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.7.1)
+      sexp_processor (~> 4.1)
+    rubycritic (1.2.1)
+      flay (= 2.4.0)
+      flog (= 4.2.1)
+      parser (>= 2.2.0, < 3.0)
+      reek (= 1.6.3)
+      ruby2ruby (>= 2.1.1, < 3.0)
+      virtus (~> 1.0)
+    sass (3.4.16)
+    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)
+    sidekiq (3.4.1)
+      celluloid (~> 0.16.0)
+      connection_pool (>= 2.1.1)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sysexits (1.2.0)
+    terminal-table (1.5.2)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    timecop (0.8.0)
+    timers (4.0.1)
+      hitimes
+    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!
+  sidekiq (= 3.4.1)
+  sidekiq-glass!

data/README.md

@@ -0,0 +1,50 @@
+# Sidekiq Glass
+
+[![Build Status](https://travis-ci.org/karafka/sidekiq-glass.svg?branch=master)](https://travis-ci.org/karafka/sidekiq-glass) [![Code Climate](https://codeclimate.com/github/karafka/sidekiq-glass/badges/gpa.svg)](https://codeclimate.com/github/karafka/sidekiq-glass)
+
+  Sidekiq worker wrapper that provides optional timeout and after failure (reentrancy).
+  
+## 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
+When creating a worker that inherits from SidekiqGlass::Worker, the perform_async method provided by Sidekiq is overriden in order to provide
+flexibility in the max number of params a background job can be created with and in the time a background job can take to finish.
+For this, the following methods can be defined:
+
+| Method           | Arguments | Description                                                                                                   |
+|------------------|-----------|---------------------------------------------------------------------------------------------------------------|
+| self.timeout=    | Integer   | Set the number of seconds that a job can take to finish (if not defined, Sidekiq timeout will be applied)     |
+| execute          | any_args  | Required method that will be invoked when calling Worker::perform_async                                       |
+| after_failure    | any_args  | Optional method that will be invoked if the execute method fails                                              |
+
+## Usage
+
+Once you've set the gem, you can start using the SidekiqGlass::Worker as following:
+
+```ruby
+class Worker1 < SidekiqGlass::Worker
+  self.timeout = 3600 # job can run for 1 hour max
+
+  def execute(*ids)
+    SomeService.new.process(ids)
+  end
+
+  def after_failure(*ids)
+    SomeService.new.expire!(ids)
+  end
+end
+
+Worker1.perform_async('id1', 'id2', 'id3')
+```
+
+```ruby
+class Worker2 < SidekiqGlass::Worker
+  def execute(first_param, second_param, third_param)
+    SomeService.new.process(first_param, second_param, third_param)
+  end
+end
+
+Worker2.perform_async(example1, example2, example3)
+```

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/sidekiq_glass.rb

@@ -0,0 +1,7 @@
+require 'sidekiq'
+
+base_path = File.dirname(__FILE__) + '/sidekiq_glass'
+
+%w( worker timeout version ).each do |file|
+  require File.join(base_path, file)
+end

data/lib/sidekiq_glass/timeout.rb

@@ -0,0 +1,21 @@
+# Module encapsulating Reentrant specific code
+module SidekiqGlass
+  # Timeout class
+  class Timeout
+    # Raised when timeout occurs
+    class TimeoutError < StandardError; end
+
+    # Executed given method and raises exception if it takes to much time
+    # @param [Integer] time in seconds that we allow given block to run
+    # @param [Block] block of code that we want to execute with timeout
+    # @return Value returned by block
+    # @raise [TimeoutError] error when method runs for too long
+    # @example Execute a block of code for max 5 seconds
+    #   ::System::Timeout.perform(5) do
+    #     # code that should run max 5 seconds
+    #   end
+    def self.perform(time, &block)
+      ::Timeout.timeout(time, TimeoutError) { block.call }
+    end
+  end
+end

data/lib/sidekiq_glass/version.rb

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

data/lib/sidekiq_glass/worker.rb

@@ -0,0 +1,43 @@
+require 'sidekiq_glass/version'
+
+module SidekiqGlass
+  # Base worker class for all other workers
+  # @abstract Subclass can be used for all workers in app
+  # @note Please use the execute method instead of perform - because of the extra
+  #   reentracy layer that has been introduced. Also if you define additional
+  #   after_failure method you can handle any timeout (or any other) errors and ensure
+  #   reentrancy for your workers
+  # @example Create a worker that will have a reentrancy for its task, that will
+  #   run for max 15 seconds
+  #
+  #   class LazyWorker < SidekiqGlass::Worker
+  #     self.timeout = 15
+  #
+  #     def execute(arg)
+  #       # do some stuff here
+  #     end
+  #
+  #    def after_failure(arg)
+  #      # do something if there is a timeout or any other error
+  #    end
+  #  end
+  class Worker
+    include Sidekiq::Worker
+
+    class << self
+      attr_accessor :timeout
+    end
+
+    # @param args Any arguments that we can get from Sidekiq
+    def perform(*args)
+      if self.class.timeout
+        ::SidekiqGlass::Timeout.perform(self.class.timeout) { execute(*args) }
+      else
+        execute(*args)
+      end
+    rescue => exception
+      after_failure(*args) if respond_to?(:after_failure)
+      raise exception
+    end
+  end
+end

data/sidekiq-glass.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake'
+require 'sidekiq_glass/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-glass"
+  spec.version       = SidekiqGlass::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Maciej Mensfeld', 'Pavlo Vavruk']
+  spec.email         = %w( maciej@mensfeld.pl pavlo.vavruk@gmail.com )
+
+  spec.summary       = ''
+  spec.description   = 'Sidekiq worker wrapper that provides optional timeout and after failure (reentrancy)'
+  spec.homepage      = ''
+
+  spec.add_dependency 'sidekiq', '3.4.1'
+
+  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,74 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-glass
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+- Pavlo Vavruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+description: Sidekiq worker wrapper 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"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/sidekiq_glass.rb
+- lib/sidekiq_glass/timeout.rb
+- lib/sidekiq_glass/version.rb
+- lib/sidekiq_glass/worker.rb
+- sidekiq-glass.gemspec
+homepage: ''
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []
+has_rdoc: