sidekiq-postpone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fdf4493b88792bf5b591d993db17eccb48ab7fe
+  data.tar.gz: da2de1a6c1b362a77107bd04bf5f38940f84bfaa
+SHA512:
+  metadata.gz: 2eb7a5a4c6bda21a99c6b59cea1ecd3e07e8b1c86dc22ffcd11c09b74cbacfc5c1c603b3d0b6cef544a3541c6dd88b125556117b84f5508f19a21415b8242a83
+  data.tar.gz: 9830d0b2f83c0f3606d00d0ce7b7fa43c20179c5c4b41f5871f6b3f267b5ea22d852b573cfcdcbc10b1bdc30288a055313264069b7762fd9316d9af2216feedb

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+sudo: false
+services:
+  - redis-server
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+gemfile:
+  - Gemfile
+  - gemfiles/sidekiq_3.0.gemfile
+  - gemfiles/sidekiq_3.1.gemfile
+  - gemfiles/sidekiq_3.2.gemfile
+  - gemfiles/sidekiq_3.3.gemfile
+  - gemfiles/sidekiq_3.4.gemfile
+  - gemfiles/sidekiq_3.5.gemfile
+  - gemfiles/sidekiq_4.0.gemfile
+  - gemfiles/sidekiq_4.1.0.gemfile
+  - gemfiles/sidekiq_4.1.1.gemfile
+  - gemfiles/sidekiq_4.1.2.gemfile
+  - gemfiles/sidekiq_4.1.3.gemfile
+
+before_install: gem install bundler -v 1.12
+script:
+  - bundle exec rake spec
+  - bundle exec rake spec:sidekiq_testing_integration

data/Appraisals

@@ -0,0 +1,43 @@
+appraise 'sidekiq-3.0' do
+  gem 'sidekiq', '~> 3.0.0'
+end
+
+appraise 'sidekiq-3.1' do
+  gem 'sidekiq', '~> 3.1.0'
+end
+
+appraise 'sidekiq-3.2' do
+  gem 'sidekiq', '~> 3.2.0'
+end
+
+appraise 'sidekiq-3.3' do
+  gem 'sidekiq', '~> 3.3.0'
+end
+
+appraise 'sidekiq-3.4' do
+  gem 'sidekiq', '~> 3.4.0'
+end
+
+appraise 'sidekiq-3.5' do
+  gem 'sidekiq', '~> 3.5.0'
+end
+
+appraise 'sidekiq-4.0' do
+  gem 'sidekiq', '~> 4.0.0'
+end
+
+appraise 'sidekiq-4.1.0' do
+  gem 'sidekiq', '4.1.0'
+end
+
+appraise 'sidekiq-4.1.1' do
+  gem 'sidekiq', '4.1.1'
+end
+
+appraise 'sidekiq-4.1.2' do
+  gem 'sidekiq', '4.1.2'
+end
+
+appraise 'sidekiq-4.1.3' do
+  gem 'sidekiq', '4.1.3'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-postpone.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vladimir Kochnev
+
+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,47 @@
+[![Build Status](https://travis-ci.org/marshall-lee/sidekiq-postpone.svg?branch=master)](https://travis-ci.org/marshall-lee/sidekiq-postpone)
+
+# sidekiq-postpone
+
+Bulk-pushes tasks to Redis when you need it to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-postpone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-postpone
+
+## Usage
+
+Typical use-case is with database transactions:
+
+```ruby
+Sidekiq::Postpone.wrap do
+  ActiveRecord::Base.transaction do
+    # ...
+    post = Post.create(params)
+    ImageProcess.perform_async(post.image)
+  end
+end
+# In fact, ImageProcess job will be pushed to the queue only after `wrap { ... }` block finishes.
+```
+
+## 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/marshall-lee/sidekiq-postpone.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |rspec|
+  rspec.exclude_pattern = 'spec/sidekiq-postpone_testing_integration_spec.rb'
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:sidekiq_testing_integration) do |rspec|
+    rspec.pattern = 'spec/sidekiq-postpone_testing_integration_spec.rb'
+  end
+end
+
+task :default => :spec

data/bin/appraisal

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'appraisal' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appraisal", "appraisal")

data/bin/bundler

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/postpone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/sidekiq_3.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.0.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_3.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.3.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_3.4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.4.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_3.5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 3.5.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.1.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "4.1.0"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.1.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "4.1.1"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.1.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "4.1.2"
+
+gemspec :path => "../"

data/gemfiles/sidekiq_4.1.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "4.1.3"
+
+gemspec :path => "../"

data/lib/sidekiq/postpone.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "sidekiq/postpone/version"
+require "sidekiq/postpone/core_ext"
+
+class Sidekiq::Postpone
+  def initialize(*client_args)
+    @client_args = client_args
+    setup_queues
+    setup_schedule
+  end
+
+  def wrap
+    start
+    yield
+    stop
+    flush
+  ensure
+    stop
+  end
+
+  def self.wrap(&block)
+    new.wrap(&block)
+  end
+
+  def push(payloads)
+    if payloads.first['at']
+      @schedule.concat(payloads)
+    else
+      q = payloads.first['queue']
+      @queues[q].concat(payloads)
+    end
+  end
+
+  private
+
+  def flush
+    client = Sidekiq::Client.new(*@client_args)
+    raw_push = client.method(:raw_push)
+    @queues.each_value(&raw_push)
+    raw_push.(@schedule) unless @schedule.empty?
+  end
+
+  def start
+    if Thread.current[:sidekiq_postpone]
+      raise 'Nested Sidekiq::Postpone is not supported'
+    end
+
+    Thread.current[:sidekiq_postpone] = self
+  end
+
+  def stop
+    Thread.current[:sidekiq_postpone] = nil
+  end
+
+  def setup_queues
+    @queues = Hash.new do |hash, key|
+      hash[key] = []
+    end
+  end
+
+  def setup_schedule
+    @schedule = []
+  end
+end

data/lib/sidekiq/postpone/core_ext.rb

@@ -0,0 +1,14 @@
+class Sidekiq::Postpone
+  module CoreExt
+    def raw_push(payloads)
+      postpone = Thread.current[:sidekiq_postpone]
+      if postpone
+        postpone.push(payloads)
+      else
+        super
+      end
+    end
+  end
+
+  Sidekiq::Client.prepend CoreExt
+end

data/lib/sidekiq/postpone/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Postpone
+    VERSION = "0.1.0"
+  end
+end

data/sidekiq-postpone.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/postpone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-postpone"
+  spec.version       = Sidekiq::Postpone::VERSION
+  spec.authors       = ["Vladimir Kochnev"]
+  spec.email         = ["hashtable@yandex.ru"]
+
+  spec.summary       = %q{Bulk-pushes jobs to Sidekiq when you need it to.}
+  spec.homepage      = "https://github.com/marshall-lee/sidekiq-postpone"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", ">= 3"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.1.0"
+  spec.add_development_dependency "redis-namespace", "~> 1.5.2"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-postpone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Kochnev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: 
+email:
+- hashtable@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/appraisal
+- bin/bundler
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- gemfiles/sidekiq_3.0.gemfile
+- gemfiles/sidekiq_3.1.gemfile
+- gemfiles/sidekiq_3.2.gemfile
+- gemfiles/sidekiq_3.3.gemfile
+- gemfiles/sidekiq_3.4.gemfile
+- gemfiles/sidekiq_3.5.gemfile
+- gemfiles/sidekiq_4.0.gemfile
+- gemfiles/sidekiq_4.1.0.gemfile
+- gemfiles/sidekiq_4.1.1.gemfile
+- gemfiles/sidekiq_4.1.2.gemfile
+- gemfiles/sidekiq_4.1.3.gemfile
+- lib/sidekiq/postpone.rb
+- lib/sidekiq/postpone/core_ext.rb
+- lib/sidekiq/postpone/version.rb
+- sidekiq-postpone.gemspec
+homepage: https://github.com/marshall-lee/sidekiq-postpone
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Bulk-pushes jobs to Sidekiq when you need it to.
+test_files: []