resque-duplicateless 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc404ee81cf0ef2dfe4c9ae0defe27811529a5a9
+  data.tar.gz: 68ddd9acd5e4a57ce9a30c781b4e23ecc919c0ff
+SHA512:
+  metadata.gz: 81dff25c9928f776e3bf773b181a38d284938be1149e78de9e044d4d0c0aa3df19df3f5a002bd0856d859430d9141953621b9a71b558ea8d1399b3a4d42aa3fc
+  data.tar.gz: 0e9136afb45892a53519ac51dbcd8c0d9fac1ef77d71bd2a9c36ab3b35d74ad381c66eb464337d655f014ff097baca0c569ea0bff34fbd04a7285d59d90e098e

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

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 deathbyjer@gmail.com. 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,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in resque_unique_job.gemspec
+gemspec
+
+gem "redis"
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,67 @@
+# ResqueUniqueJob
+
+Resque is awesome. It's great at queuing up lots of jobs and processing them offline. It works making use of Redis, which is extraordinarily fast.
+
+However, Resque makes use of Redis's lists, which means that the entries are not unique. And this is usually what we want. But sometimes it's not. 
+
+ResqueUniqueJob gives us the option of uniquely adding a job to a queue. This will ensure that the job will only be added to the queue if no other job matching its class and arguments already exists on the queue.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque_unique_job'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque_unique_job
+
+## Usage
+
+Making a job unique is super easy.
+
+In a normal Resque environment, we would enqueue a job by using the following method
+
+    Resque.enqueue FooClass, argument_1, argument_2, ...
+
+In order to uniquely enqueue that class, we do the following.
+
+    Resque.enqueue_uniquely FooClass, argument_1, argument_2, ...
+
+Also, a correlated method to `enqueue_to` exists in `enqueue_uniquely_to`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+Please make sure to run `bundle exec rspec` if you make any changes to make sure they are not breaking. Rspec expects that there is a Redis process set up on the machine and makes use of the keys `ruj:rspec:queue_1` and `ruj:rspec:queue_1`
+
+*WARNING* - The Rspec will delete everything on the `ruj:rspec:queue_1` and `ruj:rspec:queue_2` queues. Please make sure you don't need them for anything before testing or change the redis database in the `spec/helpers/spec_init.rb` file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resque_unique_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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ResqueUniqueJob project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/resque_unique_job/blob/master/CODE_OF_CONDUCT.md).
+
+
+### Authors
+
+This gem was authored by the following:
+
+Jeremy Linder (deathbyjer)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,6 @@
+require "resque-duplicateless/version"
+
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each {|f| require f}
+
+module ResqueDuplicateless
+end

data/lib/resque-duplicateless/ext/resque.rb

@@ -0,0 +1,65 @@
+# We are going to make a extension that kludges a couple of methods into the Resque main object
+module ResqueDuplicateless
+  module Ext
+    module Resque
+      def unique_push(queue, item)
+        data_store.uniquely_push_to_queue queue, encode(item)
+      end 
+      
+      # This method is basically a copy of "enqueue", but it will make sure
+      # that the enqueue method happens uniquely using this plugin
+      def enqueue_uniquely(klass, *args)
+        enqueue_uniquely_to queue_from_class(klass), klass, *args
+      end
+      
+      # We need to rewrite enqueue_to in order to use enqueue_with-options
+      def enqueue_to(queue, klass, *args)
+        enqueue_with_options :queue => queue, :class => klass, :args => args
+      end
+      
+      # This is basically a copy of enqueue_to, but will make sure that the enqueue 
+      # happens uniquely using this plugin
+      def enqueue_uniquely_to(queue, klass, *args)
+        enqueue_with_options :queue => queue, :class => klass, :args => args, :unique => true
+      end
+      
+      # We are going to create a new "base" job creation method. This will allow us to send options 
+      # into the enqueue function and, eventually, the Job.create function
+      def enqueue_with_options(options = {})
+        surround_enqueue(options) do
+          ::Resque::Job.create_with_options(options)
+        end
+      end
+      
+      protected
+      
+      # We are goung to do a surrounding enqueue function so that the hooks are called in a separate function,
+      # should we need to make changes to them separately for some reason. We could have done this in two functions,
+      # but because the before and after hooks should have the same basic options and form, we do it in one
+      #
+      # The code here is basically ripped straight from Resque (commit 0420094)
+      def surround_enqueue(options)
+        queue, klass, args = options[:queue], options[:class], options[:args]
+        
+        # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false
+        before_hooks = ::Resque::Plugin.before_enqueue_hooks(klass).collect do |hook|
+          klass.send(hook, *args)
+        end
+        return nil if before_hooks.any? { |result| result == false }
+        
+        yield
+
+        ::Resque::Plugin.after_enqueue_hooks(klass).each do |hook|
+          klass.send(hook, *args)
+        end
+
+        return true
+      end
+    end
+  end
+end
+
+# Perform the actual kludge
+module Resque
+  extend ResqueDuplicateless::Ext::Resque
+end

data/lib/resque-duplicateless/ext/resque/data_store.rb

@@ -0,0 +1,85 @@
+# We need to kludge in the method to uniquely add an item into a queue
+#
+# This is a little bit complicated because of how Resque is built. It uses an internal object known
+# as the QueueAccess object to actually interact with the queues. Because of this, we want to extend
+# those objects to follow their practices
+module ResqueDuplicateless
+  module Ext
+    module Resque
+      module DataStore
+        
+        def uniquely_push_to_queue(queue, item)
+          @queue_access.uniquely_push_to_queue queue, item
+        end
+        
+        # This is the extension for the QueueAccess Object
+        module QueueAccess
+        
+          # This function calls our LUA script for evaluation.
+          def uniquely_push_to_queue(queue, item)
+            out = nil
+            # Ensure the script is loaded
+            @redis.redis.script(:load, uniquely_push_to_queue_script) unless @redis.redis.script(:exists, uniquely_push_to_queue_script_sha)
+            
+            # Now pipeline the watch and addition calls
+            @redis.pipelined do
+              watch_queue queue
+              out = @redis.evalsha uniquely_push_to_queue_script_sha, [redis_key_for_queue_also(queue)], [item]
+            end
+            out.value
+          end 
+          
+          protected
+          
+          # TODO: Resque queue names should really be protected, not private
+          def redis_key_for_queue_also(queue)
+            "queue:#{queue}"
+          end
+          
+          # Create the SHA once and save it to avoid doing it repeatedly for no reason
+          def uniquely_push_to_queue_script_sha
+            @uniquely_push_to_queue_script_sha = Digest::SHA1.hexdigest uniquely_push_to_queue_script unless @uniquely_push_to_queue_script_sha
+            @uniquely_push_to_queue_script_sha
+          end
+          
+          # The LUA script to uniquely add to queue
+          #
+          # It *always* runs O(n)
+          #
+          # It has two parts
+          # 1. Use RPOPLPUSH to cycle through the entire array. 
+          #    It must complete the cycle, even if it finds something, so that the list's order is maintained
+          # 1A. If the list is empty, then we don't need to do this. Non-existant lists are considered empty
+          #
+          # 2. If it does not find the item, then add it to the tail of the list
+          def uniquely_push_to_queue_script
+<<-FOO
+local list_size = redis.call('LLEN',KEYS[1])
+local response = 0
+if list_size > 0 then
+  for i=1,list_size
+  do
+    redis.call('RPOPLPUSH',KEYS[1],KEYS[1])
+    if ARGV[1] == redis.call('LINDEX',KEYS[1],0) then response = 1 end
+  end
+end
+if response == 0 then redis.call('RPUSH',KEYS[1],ARGV[1]) end
+return 1
+FOO
+          end
+          
+        end
+      end
+    end
+  end
+end
+
+# Now just kludge these methods in
+module Resque
+  class DataStore
+    include ResqueDuplicateless::Ext::Resque::DataStore
+    class QueueAccess
+      include ResqueDuplicateless::Ext::Resque::DataStore::QueueAccess
+    end
+  end
+end

data/lib/resque-duplicateless/ext/resque/job.rb

@@ -0,0 +1,40 @@
+# We have to overload the Job function to manufacture a new "create_with_options" method
+#
+# This method will allow us to actually perform the correct type of queuing, IE whether
+#     we want to do a unique enqueue or not
+module ResqueDuplicateless
+  module Ext
+    module Resque
+      module Job
+        def create(queue, klass, *args)
+          create_with_options :queue => queue, :class => klass, :args => args
+        end
+      
+        def create_with_options(options = {})
+          queue, klass, args = options[:queue], options[:class], options[:args]
+          ::Resque.validate(klass, queue)
+
+          if ::Resque.inline?
+            # Instantiating a Resque::Job and calling perform on it so callbacks run
+            # decode(encode(args)) to ensure that args are normalized in the same manner as a non-inline job
+            new(:inline, {'class' => klass, 'args' => decode(encode(args))}).perform
+          # FINALLY, a unique push!
+          elsif options[:unique]
+            ::Resque.unique_push(queue, :class => klass.to_s, :args => args)
+          else
+            ::Resque.push(queue, :class => klass.to_s, :args => args)
+          end
+        end
+      end
+    end
+  end
+end
+
+
+
+# Now just kludge these methods in
+module Resque
+  class Job
+    extend ResqueDuplicateless::Ext::Resque::Job
+  end
+end

data/lib/resque-duplicateless/version.rb

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

data/resque-duplicateless.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "resque-duplicateless/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-duplicateless"
+  spec.version       = ResqueDuplicateless::VERSION
+  spec.authors       = ["Jeremy Linder"]
+  spec.email         = ["jeremy@nomibeauty.com"]
+
+  spec.summary       = %q{Allow for unique Resque Jobs on the queue}
+  spec.description   = %q{Resque allows a single queue to have multiple jobs of the same time. This is because it uses a redis list, which does not have the concept of a unique entry. Sometimes, however, a particular value is only needed if it isn't already on the queue.}
+  spec.homepage      = "https://www.nomibeauty.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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 "resque", "~> 1.x"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: resque-duplicateless
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Linder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.x
+- !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'
+description: Resque allows a single queue to have multiple jobs of the same time.
+  This is because it uses a redis list, which does not have the concept of a unique
+  entry. Sometimes, however, a particular value is only needed if it isn't already
+  on the queue.
+email:
+- jeremy@nomibeauty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque-duplicateless.rb
+- lib/resque-duplicateless/ext/resque.rb
+- lib/resque-duplicateless/ext/resque/data_store.rb
+- lib/resque-duplicateless/ext/resque/job.rb
+- lib/resque-duplicateless/version.rb
+- resque-duplicateless.gemspec
+homepage: https://www.nomibeauty.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.2
+signing_key: 
+specification_version: 4
+summary: Allow for unique Resque Jobs on the queue
+test_files: []