resque-one 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c0556c80e549f3e8633256222bc399828b978bbd6f948fe546d26cd3ceadde2
+  data.tar.gz: bedb58a9c4a9f4d856f021389b0d7c51122bc444c6cca1720228c1e3b857396b
+SHA512:
+  metadata.gz: 847b705d23d9f02cb36646f96ba38bdfaf606d41dcf39cd28e66bf6f95178cca2d486b778b528dcc83d8b5077a7613be16d778e94569c359739b480cb1ca9179
+  data.tar.gz: ef95240af85388fd81ae1ff6c4db0ccc6cb173fdf4b2fd68db4670254b5a4a542106134ef9edbe1afe6a0c4af9ef122c3f6bfb52b170dc2ff037f5c14d10ebb3

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: github-actions
+repo_token: rbqp7Q8NEyVxbjc0dulpiHIKNVQMdmkcM

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.0', '2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0', 'jruby-9.2.9.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: zhulik/redis-action@1.1.0
+      with:
+        redis version: '6'
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+resque-one

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Gabriel Naiman
+
+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,51 @@
+# Resque::One
+
+[![Gem Version](https://badge.fury.io/rb/resque-one.svg)](https://rubygems.org/gems/resque-one)
+[![CI](https://github.com/gabynaiman/resque-one/actions/workflows/ci.yml/badge.svg)](https://github.com/gabynaiman/resque-one/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/gabynaiman/resque-one/badge.svg?branch=master)](https://coveralls.io/r/gabynaiman/resque-one?branch=master)
+[![Code Climate](https://codeclimate.com/github/gabynaiman/resque-one.svg)](https://codeclimate.com/github/gabynaiman/resque-one)
+
+Resque plugin to specify uniq jobs with the same payload per queue. Have support for resque-status.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-one'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-one
+
+## Usage
+
+```ruby
+class MyJob
+  extend Resque::Plugins::One
+end
+```
+
+or
+
+```ruby
+class MyJob
+  def self.one?
+    true
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/resque-one.
+
+
+## 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,25 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.pattern = ENV['DIR'] ? File.join(ENV['DIR'], '**', '*_spec.rb') : 'spec/**/*_spec.rb'
+  t.verbose = false
+  t.warning = false
+  t.loader = nil if ENV['TEST']
+  ENV['TEST'], ENV['LINE'] = ENV['TEST'].split(':') if ENV['TEST'] && !ENV['LINE']
+  t.options = ''
+  t.options << "--name=/#{ENV['NAME']}/ " if ENV['NAME']
+  t.options << "-l #{ENV['LINE']} " if ENV['LINE'] && ENV['TEST']
+end
+
+task default: :spec
+
+desc 'Pry console'
+task :console do
+  require 'resque-one'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/lib/resque/one/job_info.rb

@@ -0,0 +1,43 @@
+module Resque
+  module One
+    class JobInfo
+
+      attr_reader :klass, :id, :args
+
+      def self.parse(job_payload)
+        new job_payload['class'], job_payload['args']
+      end
+
+      def initialize(klass, args)
+        @klass = klass.is_a?(Class) ? klass : Consty.get(klass)
+
+        if include_plugin_status?
+          @id = args.first
+          @args = args[1..-1]
+        else
+          @id = nil
+          @args = args
+        end
+      end
+
+      def key
+        @key ||= "#{klass.name}:#{args_digest}"
+      end
+
+      def one?
+        klass.respond_to?(:one?) ? klass.one? : false
+      end
+
+      private
+
+      def args_digest
+        Digest::SHA1.hexdigest JSON.dump(args)
+      end
+
+      def include_plugin_status?
+        klass.ancestors.include? Resque::Plugins::Status
+      end
+
+    end
+  end
+end

data/lib/resque/one/queue_locker.rb

@@ -0,0 +1,50 @@
+module Resque
+  module One
+    class QueueLocker
+
+      PREFIX = 'resque-one'.freeze
+
+      attr_reader :redis, :queue
+
+      def initialize(redis, queue)
+        @redis = redis
+        @queue = queue
+      end
+
+      def locked?(job_info)
+        redis.keys(key_for(job_info)).any?
+      end
+
+      def lock(job_info)
+        return false if locked? job_info
+
+        job_key = key_for job_info
+        redis.set job_key, job_info.id
+
+        true
+      end
+
+      def unlock(job_info)
+        redis.del key_for(job_info)
+      end
+
+      def unlock_all(klass=nil)
+        filter = klass ? "#{queue_key}:#{klass.to_s}:*" : "#{queue_key}:*"
+        redis.keys(filter).each do |key|
+          redis.del key
+        end
+      end
+
+      private
+
+      def queue_key
+        "#{PREFIX}:#{queue}"
+      end
+
+      def key_for(job_info)
+        "#{queue_key}:#{job_info.key}"
+      end
+
+    end
+  end
+end

data/lib/resque/one/resque_ext.rb

@@ -0,0 +1,54 @@
+module Resque
+  module One
+    module ResqueExt
+
+      def enqueue_to(queue, klass, *args)
+        job_info = JobInfo.new klass, args
+        queue_locker = QueueLocker.new redis, queue
+
+        if !job_info.one? || queue_locker.lock(job_info)
+          super queue, job_info.klass, *args
+        else
+          nil
+        end
+      end
+
+      def reserve(queue)
+        job = super queue
+        return nil if job.nil?
+
+        job_info = JobInfo.parse job.payload
+
+        if job_info.one?
+          queue_locker = QueueLocker.new redis, queue
+          queue_locker.unlock job_info
+        end
+
+        job
+      end
+
+      def dequeue(klass, *args)
+        job_info = JobInfo.new klass, args
+
+        if job_info.one?
+          queue_locker = QueueLocker.new redis, Resque.queue_from_class(job_info.klass)
+          if args.empty?
+            queue_locker.unlock_all job_info.klass
+          else
+            queue_locker.unlock job_info
+          end
+        end
+
+        super job_info.klass, *args
+      end
+
+      def remove_queue(queue)
+        queue_locker = QueueLocker.new redis, queue
+        queue_locker.unlock_all
+
+        super queue
+      end
+
+    end
+  end
+end

data/lib/resque/one/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module One
+    VERSION = '1.0.0'
+  end
+end

data/lib/resque/one.rb

@@ -0,0 +1,11 @@
+require 'resque'
+require 'consty'
+require_relative 'one/version'
+require_relative 'one/job_info'
+require_relative 'one/queue_locker'
+require_relative 'one/resque_ext'
+require_relative 'plugins/one'
+
+module Resque
+  extend One::ResqueExt
+end

data/lib/resque/plugins/one.rb

@@ -0,0 +1,11 @@
+module Resque
+  module Plugins
+    module One
+
+      def one?
+        true
+      end
+
+    end
+  end
+end

data/lib/resque-one.rb

@@ -0,0 +1 @@
+require_relative 'resque/one'

data/resque-one.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/one/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resque-one'
+  spec.version       = Resque::One::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+
+  spec.summary       = 'Resque plugin to specify uniq jobs with the same payload per queue'
+  spec.description   = 'Resque plugin to specify uniq jobs with the same payload per queue'
+  spec.homepage      = 'https://github.com/gabynaiman/resque-one'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'resque', '~> 1.25'
+  spec.add_runtime_dependency 'consty', '~> 1.0'
+
+  spec.add_development_dependency 'resque-status', '~> 0.5'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'minitest', '~> 5.0', '< 5.11'
+  spec.add_development_dependency 'minitest-colorin', '~> 0.1'
+  spec.add_development_dependency 'minitest-line', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: resque-one
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: consty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: resque-status
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Resque plugin to specify uniq jobs with the same payload per queue
+email:
+- gabynaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque-one.rb
+- lib/resque/one.rb
+- lib/resque/one/job_info.rb
+- lib/resque/one/queue_locker.rb
+- lib/resque/one/resque_ext.rb
+- lib/resque/one/version.rb
+- lib/resque/plugins/one.rb
+- resque-one.gemspec
+homepage: https://github.com/gabynaiman/resque-one
+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: []
+rubygems_version: 3.3.14
+signing_key: 
+specification_version: 4
+summary: Resque plugin to specify uniq jobs with the same payload per queue
+test_files: []