sidekiq-debounce 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52ea839929c2e0277e8236cab80a64b00c65cf76
+  data.tar.gz: 60714587a6390bcc45f422b1d80606e8b3192cad
+SHA512:
+  metadata.gz: 99cde08138a0ad4dada1b1fa728e4c55f4919205265969dc218b2e74d3851f1320b615f4159eec7c7dda034c447dc1b43b977e47eaf885ba8a3c64ae71513653
+  data.tar.gz: a9bf32f2596ddb3365bdae2eeefc9e79ef70942ae57e0ae3d626e68eabd321c32c0cee889a05f6cb508f9277dc71cc37a775e8746d49325024a7b557f74479e8

data/.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig file
+# http://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,259 @@
+AllCops:
+  RunRailsCops: false
+  DisplayCopNames: false
+  DisplayStyleGuide: true
+  StyleGuideCopsOnly: false
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    inject: reduce
+    detect: find
+    find_all: select
+Style/CommentAnnotation:
+  Enabled: true
+  Keywords:
+  - TODO
+  - FIXME
+  - OPTIMIZE
+  - HACK
+  - REVIEW
+  - DEPRECATED
+Style/DotPosition:
+  EnforcedStyle: leading
+Style/FileName:
+  Enabled: true
+Style/FormatString:
+  Enabled: true
+  EnforcedStyle: format
+Style/GlobalVars:
+  Enabled: true
+Style/GuardClause:
+  Enabled: true
+  MinBodyLength: 3
+Style/IfUnlessModifier:
+  Enabled: true
+  MaxLineLength: 80
+Style/LambdaCall:
+  Enabled: true
+Style/Next:
+  Enabled: true
+  MinBodyLength: 3
+Style/NumericLiterals:
+  Enabled: true
+  MinDigits: 5
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+Style/RaiseArgs:
+  Enabled: true
+  EnforcedStyle: exploded
+Style/SingleLineMethods:
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+  EnforcedStyle: space
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Style/SymbolProc:
+  Enabled: true
+Style/TrailingBlankLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+Style/TrailingComma:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Style/TrivialAccessors:
+  Enabled: true
+  AllowDSLWriters: true
+Style/VariableName:
+  Enabled: true
+  EnforcedStyle: snake_case
+Style/WordArray:
+  Enabled: true
+  MinSize: 2
+Metrics/AbcSize:
+  Enabled: true
+  Max: 25
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 5
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 500
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 10
+Metrics/LineLength:
+  Enabled: true
+  Max: 80
+  AllowURI: true
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 20
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: false
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 8
+Lint/AssignmentInCondition:
+  Enabled: true
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Style/AccessorMethodName:
+  Enabled: true
+Style/Alias:
+  Enabled: true
+Style/ArrayJoin:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: true
+Style/AsciiIdentifiers:
+  Enabled: true
+Style/Attr:
+  Enabled: true
+Style/BlockComments:
+  Enabled: true
+Style/ColonMethodCall:
+  Enabled: true
+Style/DeprecatedHashMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/EmptyLiteral:
+  Enabled: true
+Style/EvenOdd:
+  Enabled: true
+Style/FlipFlop:
+  Enabled: true
+Style/IfWithSemicolon:
+  Enabled: true
+Style/Lambda:
+  Enabled: true
+Style/LeadingCommentSpace:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: true
+Style/MultilineTernaryOperator:
+  Enabled: true
+Style/NegatedIf:
+  Enabled: true
+Style/NestedTernaryOperator:
+  Enabled: true
+Style/NilComparison:
+  Enabled: true
+Style/Not:
+  Enabled: true
+Style/OneLineConditional:
+  Enabled: true
+Style/PerlBackrefs:
+  Enabled: true
+Style/RedundantBegin:
+  Enabled: true
+Style/RedundantSelf:
+  Enabled: true
+Style/RescueModifier:
+  Enabled: true
+Style/SelfAssignment:
+  Enabled: true
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: true
+Style/SpaceAfterColon:
+  Enabled: true
+Style/SpaceAfterComma:
+  Enabled: true
+Style/SpaceAfterControlKeyword:
+  Enabled: true
+Style/SpaceAfterMethodName:
+  Enabled: true
+Style/SpaceAfterNot:
+  Enabled: true
+Style/SpaceAfterSemicolon:
+  Enabled: true
+Style/SpaceBeforeComma:
+  Enabled: true
+Style/SpaceBeforeComment:
+  Enabled: true
+Style/SpaceBeforeSemicolon:
+  Enabled: true
+Style/SpaceAroundOperators:
+  Enabled: true
+Style/SpaceBeforeModifierKeyword:
+  Enabled: true
+Style/SpaceInsideBrackets:
+  Enabled: true
+Style/SpaceInsideParens:
+  Enabled: true
+Style/SpaceInsideRangeLiteral:
+  Enabled: true
+Style/SpecialGlobalVars:
+  Enabled: true
+Style/TrailingWhitespace:
+  Enabled: true
+Style/UnlessElse:
+  Enabled: true
+Style/VariableInterpolation:
+  Enabled: true
+Style/WhenThen:
+  Enabled: true
+Lint/Debugger:
+  Enabled: true
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Lint/Eval:
+  Enabled: true
+Lint/HandleExceptions:
+  Enabled: true
+Lint/LiteralInInterpolation:
+  Enabled: true
+Lint/Loop:
+  Enabled: true
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+Lint/RequireParentheses:
+  Enabled: false
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+Lint/UselessSetterCall:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 2.0.0
+ - 2.1.2
+ - jruby-9.0.0.0.pre1
+script: bundle exec rake test
+addons:
+ code_climate:
+  repo_token: b11e6d8ed83dd2e01424b088c469e2cef525a89e887414f81e6ee7f36b937a1d

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Peter Lejeck
+
+MIT License
+
+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 @@
+Sidekiq::Debounce
+=================
+ [![Travis CI](http://img.shields.io/travis/NuckChorris/sidekiq-debounce/master.svg)](https://travis-ci.org/NuckChorris/sidekiq-debounce)
+ [![CodeClimate](http://img.shields.io/codeclimate/github/NuckChorris/sidekiq-debounce.svg)](https://codeclimate.com/github/NuckChorris/sidekiq-debounce)
+ [![Coverage](http://img.shields.io/codeclimate/coverage/github/NuckChorris/sidekiq-debounce.svg)](https://codeclimate.com/github/NuckChorris/sidekiq-debounce)
+ [![RubyGems](http://img.shields.io/gem/v/sidekiq-debounce.svg)](https://rubygems.org/gems/sidekiq-debounce)
+ [![Gittip](http://img.shields.io/gittip/Nuck.svg)](https://www.gittip.com/Nuck/)
+
+Sidekiq::Debounce is a client-side Sidekiq middleware which provides a way to
+easily rate-limit creation of Sidekiq jobs.
+
+When you create a job via `#perform_in` on a Worker with debounce enabled,
+Sidekiq::Debounce will prevent other jobs with the same arguments from being
+created until the job has run.  Every time you create another job with those
+same arguments prior to the job being run, the timer is reset and the entire
+period must pass again before the job is executed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-debounce'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-debounce
+
+## Usage
+
+Add `Sidekiq::Debounce` to your client middleware chain, and then add
+`sidekiq_options debounce: true` to the worker you wish to debounce.
+
+Use `#perform_in` instead of `#perform_async` to set the timeframe.
+
+## Contributing
+
+1. Fork it ( https://github.com/nuckchorris/sidekiq-debounce/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs << 'spec'
+end

data/lib/sidekiq/debounce.rb

@@ -0,0 +1,52 @@
+require 'sidekiq/debounce/version'
+require 'sidekiq/api'
+
+module Sidekiq
+  class Debounce
+    def call(worker, msg, _queue, redis_pool)
+      @worker = worker
+      @msg = msg
+
+      return yield unless debounce?
+
+      redis_pool.with do |conn|
+        # Get JID of the already-scheduled job, if there is one
+        scheduled_jid = conn.get(debounce_key)
+
+        # Reschedule the old job to when this new job is scheduled for
+        # Or yield if there isn't one scheduled yet
+        jid = scheduled_jid ? reschedule(scheduled_jid, @msg['at']) : yield
+
+        store_expiry(conn, jid, @msg['at'])
+        return false if scheduled_jid
+        jid
+      end
+    end
+
+    private
+
+    def store_expiry(conn, jid, time)
+      conn.set(debounce_key, jid)
+      conn.expireat(debounce_key, time.to_i)
+    end
+
+    def debounce_key
+      hash = Digest::MD5.hexdigest(@msg['args'].to_json)
+      @debounce_key ||= "sidekiq_debounce:#{@worker.name}:#{hash}"
+    end
+
+    def scheduled_set
+      @scheduled_set ||= Sidekiq::ScheduledSet.new
+    end
+
+    def reschedule(jid, at)
+      job = scheduled_set.find_job(jid)
+      job.reschedule(at)
+      jid
+    end
+
+    def debounce?
+      (@msg['at'] && @worker.get_sidekiq_options['debounce']) || false
+    end
+  end
+end

data/lib/sidekiq/debounce/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Debounce
+    VERSION = '1.0.0'
+  end
+end

data/sidekiq-debounce.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/debounce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-debounce'
+  spec.version       = Sidekiq::Debounce::VERSION
+  spec.authors       = ['Peter Lejeck']
+  spec.email         = ['me@plejeck.com']
+  spec.summary       = 'A client-side middleware for debouncing Sidekiq jobs'
+  spec.description   = <<-DESC
+Sidekiq::Debounce provides a way to rate-limit creation of Sidekiq jobs.  When
+you create a job on a Worker with debounce enabled, Sidekiq::Debounce will
+delay the job until the debounce period has elapsed with no additional debounce
+calls. If you make another job with the same arguments before the specified
+time has elapsed, the timer is reset and the entire period must pass again
+before the job is executed.
+DESC
+  spec.homepage      = 'https://github.com/NuckChorris/sidekiq-debounce'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq', '>= 3.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'mock_redis'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/spec/sidekiq/debounce_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'sidekiq/api'
+require 'sidekiq/debounce/middleware'
+
+class DebouncedWorker
+  include Sidekiq::Worker
+
+  sidekiq_options debounce: true
+
+  def perform(_a, _b); end
+end
+
+describe Sidekiq::Debounce do
+  before do
+    stub_scheduled_set
+  end
+
+  after do
+    Sidekiq.redis(&:flushdb)
+  end
+
+  let(:set) { Sidekiq::ScheduledSet.new }
+  let(:sorted_entry) { Sidekiq::SortedEntry.new(set, 0, 'jid' => '54321') }
+
+  it 'queues a job normally at first' do
+    DebouncedWorker.perform_in(60, 'foo', 'bar')
+    set.size.must_equal 1, 'set.size must be 1'
+  end
+
+  it 'ignores repeat jobs within the debounce time and reschedules' do
+    sorted_entry.expects(:reschedule)
+
+    DebouncedWorker.perform_in(60, 'foo', 'bar')
+    DebouncedWorker.perform_in(60, 'foo', 'bar')
+    set.size.must_equal 1, 'set.size must be 1'
+  end
+
+  it 'debounces jobs based on their arguments' do
+    DebouncedWorker.perform_in(60, 'boo', 'far')
+    DebouncedWorker.perform_in(60, 'foo', 'bar')
+    set.size.must_equal 2, 'set.size must be 2'
+  end
+
+  it 'creates the job immediately when given an instant job' do
+    DebouncedWorker.perform_async('foo', 'bar')
+    set.size.must_equal 0, 'set.size must be 0'
+  end
+
+  def stub_scheduled_set
+    set.stubs(:find_job).returns(sorted_entry)
+    Sidekiq::Debounce.any_instance.stubs(:scheduled_set).returns(set)
+  end
+end

data/spec/sidekiq_helper.rb

@@ -0,0 +1,13 @@
+require 'sidekiq'
+require 'sidekiq/testing'
+require 'mock_redis'
+
+# Disable Sidekiq's testing mocks and use MockRedis instead
+Sidekiq::Testing.disable!
+
+Sidekiq.configure_server do |config|
+  config.redis = ConnectionPool.new(size: 1) { MockRedis.new }
+end
+Sidekiq.configure_client do |config|
+  config.redis = ConnectionPool.new(size: 1) { MockRedis.new }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'sidekiq_helper'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-debounce
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Lejeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Sidekiq::Debounce provides a way to rate-limit creation of Sidekiq jobs.  When
+  you create a job on a Worker with debounce enabled, Sidekiq::Debounce will
+  delay the job until the debounce period has elapsed with no additional debounce
+  calls. If you make another job with the same arguments before the specified
+  time has elapsed, the timer is reset and the entire period must pass again
+  before the job is executed.
+email:
+- me@plejeck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/debounce.rb
+- lib/sidekiq/debounce/version.rb
+- sidekiq-debounce.gemspec
+- spec/sidekiq/debounce_spec.rb
+- spec/sidekiq_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/NuckChorris/sidekiq-debounce
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A client-side middleware for debouncing Sidekiq jobs
+test_files:
+- spec/sidekiq/debounce_spec.rb
+- spec/sidekiq_helper.rb
+- spec/spec_helper.rb