sidekiq_lockable_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c4078ebd3f7c4c03e6167d73f0ec1c4510403045ad09f09bef28386321932ef
+  data.tar.gz: 87b5bb9b9f8a2b8a61b5b69b63487fa2a44d992e43aa2090db017c69bfdc0229
+SHA512:
+  metadata.gz: 72966453281278f758578bb8e904e9a61c0fab7e05e7cceaa47184a61974dc4277d4620185d592410f042a2b98f5650d2595b310aeb14554e5cd90890c2ece6b
+  data.tar.gz: 7b194fced1ac5ec4e12f148c67b70202680bc88bfe0a03dfd720dcddc6aa2ba2c725791c417f9341399b0211192d375b7aed7a0e54a65f53ddffaee9705772ed

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2

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 hugues@xdev.fr. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sidekiq_lockable_job.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    sidekiq_lockable_job (0.1.0)
+      redis (= 4.0.1)
+      sidekiq (= 5.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
+    rack (2.0.8)
+    rack-protection (2.0.5)
+      rack
+    rake (12.3.3)
+    redis (4.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sidekiq (5.0.5)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.4, < 5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fakeredis (= 0.7.0)
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+  sidekiq_lockable_job!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hugues Bernet-Rollande
+
+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,231 @@
+# SidekiqLockableJob
+
+Prevent a job to run until another one complete.
+
+[Sidekiq](https://github.com/mperham/sidekiq) includes a jobs dependencies mechanism to prevent a job from running before another one when enqueued.
+
+But sometime your jobs will be enqueued independently, then for you do not know the job id on which you depend on (you could parse Sidekiq queue, but...)
+
+`SidekiqLockableJob` allows you to set some locks ( based on job params ) when a job is enqueued or processed (store in redis), to prevent any other jobs to run if locked ( based on job params ) and will unlock any previously set locks ( based on job params ) when a job is **succesfully** completed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq_lockable_job'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_lockable_job
+
+## Usage
+
+The gem is compose of four parts:
+
+- Setting locks when job is **enqueued**
+- Setting locks when job is **processed**
+- Raising `LockableJob::LockedJobError` when job **start** to processed but is locked
+- Unsetting locks when job is **succesfully** processed
+
+### Setting locks when job is **enqueued**
+
+> happens in the sidekiq client middleware (on you rails app)
+> including `Sidekiq::LockableJob` auto set the middleware chain
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::LockableJob
+
+  def self.lockable_job_client_lock_keys(args)
+    # jobs args are always in an array like **args
+    lock_key = args.first['a_key']
+    "some_context_prefix:#{lock_key}"
+  end
+
+  def perform
+  end
+end
+```
+
+When your job is **ENQUEUED** (`Worker.perform_async`), sidekiq LockableJob client middleware, will call `lockable_job_client_lock_keys` (before enqueuing the job) with the jobs arguments and set a lock for any returned keys
+
+### Setting locks when job is processed
+
+> happens in the sidekiq server middleware (on you rails worker)
+> including `Sidekiq::LockableJob` auto set the middleware chain
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::LockableJob
+
+  def self.lockable_job_server_lock_keys(args)
+    # jobs args are always in an array like **args
+    lock_key = args.first['a_key']
+    "some_context_prefix:#{lock_key}"
+  end
+
+  def perform
+  end
+end
+```
+
+When your job is **PROCESSED**, sidekiq LockableJob server middleware, will call `lockable_job_client_lock_keys` (before running the job) with the jobs arguments and set a lock for any returned keys
+
+### Raising `LockableJob::LockedJobError` when job start to processed but is locked
+
+> happens in the sidekiq server middleware (on you rails worker)
+> including `Sidekiq::LockableJob` auto set the middleware chain
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::LockableJob
+
+  def self.lockable_job_locked_by_keys(args)
+    # jobs args are always in an array like **args
+    lock_key = args.first['a_key']
+    "some_context_prefix:#{lock_key}"
+  end
+
+  def perform
+  end
+end
+```
+
+When your job is **about** to be **processed**, sidekiq LockableJob server middleware, will call `lockable_job_locked_by_keys` (before processing the job) with the jobs arguments and raise `Sidekiq::LockableJob::LockedJobError` if any of the returned keys is locked
+
+### Unsetting locks when job is **succesfully** processed
+
+> happens in the sidekiq server middleware (on you rails worker)
+> including `Sidekiq::LockableJob` auto set the middleware chain
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::LockableJob
+
+  def self.lockable_job_unlock_keys(args)
+    # jobs args are always in an array like **args
+    lock_key = args.first['a_key']
+    "some_context_prefix:#{lock_key}"
+  end
+
+  def perform
+  end
+end
+```
+
+When your job is **successfully** to be **performed**, sidekiq LockableJob server middleware, will call `lockable_job_unlock_keys` (after processing the job) with the jobs arguments and unset lock for any returned keys
+
+## Specs
+
+```
+Sidekiq::LockableJob
+  .lock
+    lock
+  .unlock
+    unlock
+  .locked?
+    true if locked
+    false if NOT locked
+  .raise_if_locked_by
+    raise if locked by any key
+    raise if locked by single key
+    DOT NOT raise if not locked by
+  .included
+    include middlewares
+
+Sidekiq::LockableJob::Middleware::Client::SetLocks
+  LockableJob
+    behaves like it yield
+      is expected to eq true
+    behaves like set locks
+      set locks
+    with single lock key
+      behaves like it yield
+        is expected to eq true
+      behaves like set locks
+        set locks
+
+Sidekiq::LockableJob::Middleware::Server::RaiseIfLocked
+  with no lock
+    behaves like perform the job
+      example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+    behaves like it yield
+      is expected to eq true
+  with lock set
+    behaves like raise an error
+      is expected to raise Sidekiq::LockableJob::LockedJobError
+    with another lock key
+      behaves like raise an error
+        is expected to raise Sidekiq::LockableJob::LockedJobError
+    with a non lock key
+      behaves like perform the job
+        example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+    with single lock key
+      behaves like raise an error
+        is expected to raise Sidekiq::LockableJob::LockedJobError
+
+Sidekiq::LockableJob::Middleware::Server::SetLocks
+  LockableJob
+    set locks
+    behaves like it yield
+      is expected to eq true
+    behaves like perform the job
+      example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+    with single lock key
+      set lock
+      behaves like it yield
+        is expected to eq true
+      behaves like perform the job
+        example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+
+Sidekiq::LockableJob::Middleware::Server::UnsetLocks
+  with previous locks
+    behaves like lock keys
+      remove all locks
+      behaves like it yield
+        is expected to eq true
+      behaves like perform the job
+        example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+      for another job
+        DOES NOT remove the lock
+    with single lock key
+      behaves like lock keys
+        remove all locks
+        behaves like it yield
+          is expected to eq true
+        behaves like perform the job
+          example at ./spec/sidekiq/lockable_job/middleware/server/shared.rb:13
+        for another job
+          DOES NOT remove the lock
+
+SidekiqLockableJob
+  has a version number
+```
+
+## 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/huguesbr/sidekiq_lockable_job. 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 sidekiq_lockable_job project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/huguesbr/sidekiq_lockable_job/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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq_lockable_job"
+
+# 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(__FILE__)

data/bin/rspec

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+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/lib/sidekiq/lockable_job/lockable_job.rb

@@ -0,0 +1,69 @@
+require 'sidekiq'
+require 'redis'
+require_relative 'middleware/middleware.rb'
+
+module Sidekiq
+  module LockableJob
+    class Error < StandardError; end
+    class LockedJobError < StandardError; end
+
+    LOCKABLE_JOB_REDIS_PREFIX_KEY = 'sidekiq_locks'
+
+    def self.lock(key)
+      redis.set(redis_key(key), Time.now)
+    end
+
+    def self.unlock(key)
+      redis.del(redis_key(key))
+    end
+
+    def self.locked?(key)
+      redis.exists(redis_key(key))
+    end
+
+    def self.raise_if_locked_by(keys)
+      keys = [keys] unless keys.nil? || keys.is_a?(Array)
+      keys&.each do |key|
+        # perform in instead of retry?
+        # perform_in(2.minutes, *args)
+        raise LockedJobError.new("Locked by #{key}") if locked?(key)
+      end
+    end
+
+    def self.redis_key(key)
+      "#{LOCKABLE_JOB_REDIS_PREFIX_KEY}:#{key}"
+    end
+
+    def self.redis
+      $redis = Redis.new
+    end
+
+    def self.included(base)
+      unless base.ancestors.include? Sidekiq::Worker
+        raise ArgumentError, "Sidekiq::LockableJob can only be included in a Sidekiq::Worker"
+      end
+
+      # base.extend(ClassMethods)
+
+      # Automatically add sidekiq middleware when we're first included
+      #
+      # This might only occur when the worker class is first loaded in a
+      # development rails environment, but that happens before the middleware
+      # chain is invoked so we're all good.
+      #
+      Sidekiq.configure_server do |config|
+        unless config.server_middleware.exists? Sidekiq::LockableJob::Middleware::Server::RaiseIfLocked
+          config.server_middleware.add Sidekiq::LockableJob::Middleware::Server::RaiseIfLocked
+        end
+        unless config.server_middleware.exists? Sidekiq::LockableJob::Middleware::Server::UnsetLocks
+          config.server_middleware.add Sidekiq::LockableJob::Middleware::Server::UnsetLocks
+        end
+      end
+      Sidekiq.configure_client do |config|
+        unless config.client_middleware.exists? Sidekiq::LockableJob::Middleware::Client::SetLocks
+          config.client_middleware.add Sidekiq::LockableJob::Middleware::Client::SetLocks
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/lockable_job/middleware/client/set_locks.rb

@@ -0,0 +1,31 @@
+# https://github.com/mperham/sidekiq/wiki/Middleware
+require 'sidekiq'
+
+module Sidekiq::LockableJob
+  module Middleware
+    module Client
+      class SetLocks
+        # @param [String, Class] worker_class the string or class of the worker class being enqueued
+        # @param [Hash] job the full job payload
+        #   * @see https://github.com/mperham/sidekiq/wiki/Job-Format
+        # @param [String] queue the name of the queue the job was pulled from
+        # @param [ConnectionPool] redis_pool the redis pool
+        # @return [Hash, FalseClass, nil] if false or nil is returned,
+        #   the job is not to be enqueued into redis, otherwise the block's
+        #   return value is returned
+        # @yield the next middleware in the chain or the enqueuing of the job
+        def call(worker_class, job, queue, redis_pool)
+          worker_klass = worker_class.is_a?(String) ? worker_class.constantize : worker_class
+          if worker_klass.respond_to?(:lockable_job_client_lock_keys)
+            keys = worker_klass.send(:lockable_job_client_lock_keys, job['args'])
+            keys = [keys] unless keys.nil? || keys.is_a?(Array)
+            keys&.compact&.each do |key|
+              Sidekiq::LockableJob.lock(key)
+            end
+          end
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/lockable_job/middleware/middleware.rb

@@ -0,0 +1,5 @@
+
+require_relative 'client/set_locks.rb'
+require_relative 'server/raise_if_locked.rb'
+require_relative 'server/unset_locks.rb'
+require_relative 'server/set_locks.rb'

data/lib/sidekiq/lockable_job/middleware/server/raise_if_locked.rb

@@ -0,0 +1,26 @@
+# https://github.com/mperham/sidekiq/wiki/Middleware
+require 'sidekiq'
+
+module Sidekiq::LockableJob
+  module Middleware
+    module Server
+      class RaiseIfLocked
+        # @param [Object] worker the worker instance
+        # @param [Hash] job the full job payload
+        #   * @see https://github.com/mperham/sidekiq/wiki/Job-Format
+        # @param [String] queue the name of the queue the job was pulled from
+        # @yield the next middleware in the chain or worker `perform` method
+        # @return [Void]
+        def call(worker, job, queue)
+          worker_klass = worker.class
+          if worker_klass.respond_to?(:lockable_job_locked_by_keys)
+            keys = worker_klass.send(:lockable_job_locked_by_keys, job['args'])
+            keys = [keys] unless keys.nil? || keys.is_a?(Array)
+            Sidekiq::LockableJob.raise_if_locked_by(keys)
+          end
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/lockable_job/middleware/server/set_locks.rb

@@ -0,0 +1,28 @@
+# https://github.com/mperham/sidekiq/wiki/Middleware
+require 'sidekiq'
+
+module Sidekiq::LockableJob
+  module Middleware
+    module Server
+      class SetLocks
+        # @param [Object] worker the worker instance
+        # @param [Hash] job the full job payload
+        #   * @see https://github.com/mperham/sidekiq/wiki/Job-Format
+        # @param [String] queue the name of the queue the job was pulled from
+        # @yield the next middleware in the chain or worker `perform` method
+        # @return [Void]
+        def call(worker, job, queue)
+          worker_klass = worker.class
+          if worker_klass.respond_to?(:lockable_job_server_lock_keys)
+            keys = worker_klass.send(:lockable_job_server_lock_keys, job['args'])
+            keys = [keys] unless keys.nil? || keys.is_a?(Array)
+            keys&.compact&.each do |key|
+              Sidekiq::LockableJob.lock(key)
+            end
+          end
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/lockable_job/middleware/server/unset_locks.rb

@@ -0,0 +1,28 @@
+# https://github.com/mperham/sidekiq/wiki/Middleware
+require 'sidekiq'
+
+module Sidekiq::LockableJob
+  module Middleware
+    module Server
+      class UnsetLocks
+        # @param [Object] worker the worker instance
+        # @param [Hash] job the full job payload
+        #   * @see https://github.com/mperham/sidekiq/wiki/Job-Format
+        # @param [String] queue the name of the queue the job was pulled from
+        # @yield the next middleware in the chain or worker `perform` method
+        # @return [Void]
+        def call(worker, job, queue)
+          yield
+          worker_klass = worker.class
+          if worker_klass.respond_to?(:lockable_job_unlock_keys)
+            keys = worker_klass.send(:lockable_job_unlock_keys, job['args'])
+            keys = [keys] unless keys.nil? || keys.is_a?(Array)
+            keys&.compact&.each do |key|
+              Sidekiq::LockableJob.unlock(key)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_lockable_job/version.rb

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

data/lib/sidekiq_lockable_job.rb

@@ -0,0 +1,7 @@
+require "sidekiq_lockable_job/version"
+require "sidekiq/lockable_job/lockable_job.rb"
+
+module SidekiqLockableJob
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sidekiq_lockable_job.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq_lockable_job/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_lockable_job"
+  spec.version       = SidekiqLockableJob::VERSION
+  spec.authors       = ["Hugues Bernet-Rollande"]
+  spec.email         = ["hugues@xdev.fr"]
+
+  spec.summary       = 'Prevent a job to run until another one complete'
+  spec.description   = <<~EOF
+  Sidekiq includes a jobs dependencies mechanism to prevent a job from running before another one when enqueued.
+
+  But sometime your jobs will be enqueued independently, then for you do not know the job id on which you depend on (you could parse Sidekiq queue, but...)
+
+  `SidekiqLockableJob` allows you to set some locks ( based on job params ) when a job is enqueued or processed (store in redis), to prevent any other jobs to run if locked ( based on job params ) and will unlock any previously set locks ( based on job params ) when a job is **succesfully** completed.
+  EOF
+  spec.homepage      = 'https://github.com/huguesbr/sidekiq_lockable_job'
+  spec.license       = "MIT"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/huguesbr/sidekiq_lockable_job'
+  spec.metadata["changelog_uri"] = 'https://github.com/huguesbr/sidekiq_lockable_job/README.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '5.0.5'
+  spec.add_dependency 'redis', '4.0.1'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "fakeredis", '0.7.0'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_lockable_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hugues Bernet-Rollande
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.5
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: |
+  Sidekiq includes a jobs dependencies mechanism to prevent a job from running before another one when enqueued.
+
+  But sometime your jobs will be enqueued independently, then for you do not know the job id on which you depend on (you could parse Sidekiq queue, but...)
+
+  `SidekiqLockableJob` allows you to set some locks ( based on job params ) when a job is enqueued or processed (store in redis), to prevent any other jobs to run if locked ( based on job params ) and will unlock any previously set locks ( based on job params ) when a job is **succesfully** completed.
+email:
+- hugues@xdev.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/sidekiq/lockable_job/lockable_job.rb
+- lib/sidekiq/lockable_job/middleware/client/set_locks.rb
+- lib/sidekiq/lockable_job/middleware/middleware.rb
+- lib/sidekiq/lockable_job/middleware/server/raise_if_locked.rb
+- lib/sidekiq/lockable_job/middleware/server/set_locks.rb
+- lib/sidekiq/lockable_job/middleware/server/unset_locks.rb
+- lib/sidekiq_lockable_job.rb
+- lib/sidekiq_lockable_job/version.rb
+- sidekiq_lockable_job.gemspec
+homepage: https://github.com/huguesbr/sidekiq_lockable_job
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/huguesbr/sidekiq_lockable_job
+  source_code_uri: https://github.com/huguesbr/sidekiq_lockable_job
+  changelog_uri: https://github.com/huguesbr/sidekiq_lockable_job/README.md
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Prevent a job to run until another one complete
+test_files: []