activejob-lockable 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b13ca8541fb112296178a39c09d9ef7fa8e3146
+  data.tar.gz: 0fd8547b9e050bdaf2dea768ff3e4ed29920537e
+SHA512:
+  metadata.gz: 52ff57a0d672cb58afb292fd22c4e482396797e7b241d88e908290be7535d4217e1a0e22e8616ff900060e8215af20656b2a0c157b369d83a6348a498a5ad855
+  data.tar.gz: 3237db29230609de7750f29926f40535722b51a38ffa6684fb247b163985a4ffb66aed0e4bebb9b6ebc74c43c761b839216ecf164c8613f7319250e05db02871

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activejob-lockable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmytro Zakharov
+
+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,104 @@
+# ActiveJob::Lockable
+
+Gem to make to make jobs lockable. Useful when a job is called N times, but only a single execution is needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activejob-lockable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-lockable
+    
+## Configuration
+
+Create an initializer with redis connection:
+
+```ruby
+ActiveJob::Lockable.redis = Redis.current # if you have a redis instance
+
+# or
+ActiveJob::Lockable.redis = 'redis://localhost:6379/0'
+# or
+ActiveJob::Lockable.redis = {
+  host: '10.0.1.1',
+  port: 6380,
+  db: 15
+}
+```
+
+## Usage
+
+```ruby
+# job
+# nothing to change!
+```
+```ruby
+# code
+MyJob.set(lock: 10.seconds).perform_later(id)
+```
+
+Now, after the first enqueue (perform_later), a lock will be created and the following enqueues within 10 seconds will be rejected.
+
+### Lock key
+
+A lock key by default:
+
+`job_name_in_downcase:md5(arguments)`
+
+To override the key you can override method `lock_key`:
+
+```ruby
+# job
+def lock_key
+  'my-custom-key'
+end
+```
+
+### Lock period
+
+You can set a fixed `lock_period`, in that case `.set(lock: N)` will be ignored and the job will always be lockable:
+
+```ruby
+# job
+def lock_period
+  1.day
+end
+```
+
+### On lock action
+
+When a job is locked and another one is enqueued, you can set up a custom callback that will be called. This is useful if you want to raise exception or be notified:
+
+```ruby
+# job
+class MyJob < ApplicationJob
+  on_locked :raise_if_locked
+
+  def raise_if_locked
+    raise 'Job is locked'
+  end
+end
+```
+
+## Dependencies
+
+* [ActiveSupport](https://github.com/rails/rails/tree/master/activesupport)
+* [ActibeJob](https://github.com/rails/rails/tree/master/activejob)
+* [Redis](https://redis.io/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [qonto/activejob-lockable](https://github.com/qonto/activejob-lockable). 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activejob-lockable.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob/lockable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activejob-lockable'
+  spec.version       = ActiveJob::Lockable::VERSION
+  spec.authors       = ['Dmytro Zakharov']
+  spec.email         = ['dmytro@qonto.eu']
+
+  spec.summary       = %q{Prevents jobs from enqueuing with unique arguments for a certain period of time}
+  spec.homepage      = 'https://github.com/qonto/activejob-lockable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activejob'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'fakeredis'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activejob/lockable"
+
+# 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/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/activejob/lockable.rb

@@ -0,0 +1,40 @@
+require 'activejob/lockable/version'
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load :active_job do
+  require 'activejob/lockable/lockable'
+  ActiveJob::Base::ClassMethods.send(:include, ActiveJob::Lockable::ClassMethods)
+  ActiveJob::Base.send(:include, ActiveJob::Lockable)
+end
+
+module ActiveJob
+  module Lockable
+    extend self
+
+    # Accepts:
+    #   1. A redis URL (valid for `Redis.new(url: url)`)
+    #   2. an options hash compatible with `Redis.new`
+    #   3. or a valid Redis instance (one that responds to `#smembers`). Likely,
+    #      this will be an instance of either `Redis`, `Redis::Client`,
+    #      `Redis::DistRedis`, or `Redis::Namespace`.
+    def redis=(server)
+      @redis = if server.is_a?(String)
+        Redis.new(:url => server, :thread_safe => true)
+      elsif server.is_a?(Hash)
+        Redis.new(server.merge(:thread_safe => true))
+      elsif server.respond_to?(:smembers)
+        server
+      else
+        raise ArgumentError,
+          'You must supply a url, options hash or valid Redis connection instance'
+      end
+    end
+
+    # Returns the current Redis connection. If none has been created, will
+    # create a new one.
+    def redis
+      return @redis if @redis
+      raise 'Redis is not configured'
+    end
+  end
+end

data/lib/activejob/lockable/lockable.rb

@@ -0,0 +1,59 @@
+require 'activejob/lockable/redis_store'
+
+module ActiveJob
+  module Lockable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def on_locked(action)
+        self.on_locked_action = action
+      end
+    end
+
+    included do
+      attr_reader :options
+      class_attribute :on_locked_action
+
+      def enqueue(options = {})
+        @options = options
+        if locked?
+          logger.info "job is locked, expires in #{locked_ttl} second"
+          send(on_locked_action) if on_locked_action && respond_to?(on_locked_action)
+        else
+          lock!
+          super(options)
+        end
+      end
+
+      def lock!
+        return if lock_period.to_i <= 0
+        logger.info "locked with #{lock_key} for #{lock_period} seconds. Job_id: #{self.job_id} class_name: #{self.class}"
+        begin
+          ActiveJob::Lockable::RedisStore.setex(lock_key, lock_period, self.job_id)
+        rescue => e
+          logger.info "EXCEPTION: locked with #{lock_key} for #{lock_period} seconds. Job_id: #{self.job_id} class_name: #{self.class}"
+          raise e
+        end
+      end
+
+      def lock_key
+        md5 = Digest::MD5.hexdigest(self.arguments.join)
+        "#{self.class.name.downcase}:#{md5}"
+      end
+
+      def locked?
+        ActiveJob::Lockable::RedisStore.exists?(lock_key)
+      end
+
+      def locked_ttl
+        ActiveJob::Lockable::RedisStore.ttl(lock_key)
+      end
+
+      private
+
+      def lock_period
+        options[:lock]
+      end
+    end
+  end
+end

data/lib/activejob/lockable/redis_store.rb

@@ -0,0 +1,19 @@
+module ActiveJob
+  module Lockable
+    class RedisStore
+      class << self
+        def setex(cache_key, expiration, cache_value)
+          ActiveJob::Lockable.redis.setex(cache_key, expiration, cache_value)
+        end
+
+        def exists?(cache_key)
+          ActiveJob::Lockable.redis.exists(cache_key)
+        end
+
+        def ttl(cache_key)
+          ActiveJob::Lockable.redis.ttl(cache_key)
+        end
+      end
+    end
+  end
+end

data/lib/activejob/lockable/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Lockable
+    VERSION = '0.1.3'
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: activejob-lockable
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Dmytro Zakharov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: fakeredis
+  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: pry
+  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: 
+email:
+- dmytro@qonto.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob-lockable.gemspec
+- bin/console
+- bin/setup
+- lib/activejob/lockable.rb
+- lib/activejob/lockable/lockable.rb
+- lib/activejob/lockable/redis_store.rb
+- lib/activejob/lockable/version.rb
+homepage: https://github.com/qonto/activejob-lockable
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Prevents jobs from enqueuing with unique arguments for a certain period of
+  time
+test_files: []