delayed_job_active_record_unique 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a312fd580e5364d7fd29e8091d11b239ec993ae
+  data.tar.gz: 4155177e47c0c4801ee14e94455d9770d757378a
+SHA512:
+  metadata.gz: 85e8b3b6a8764141e503b077e2a7a2aa8eb4174f238f33bc2cbaa60e44ac5d8d9cdda06330b39280beee776d971d48fb719676cd05c134cdb117deebd1937e03
+  data.tar.gz: e9d700c83b72bcbc00c730da0f8f18183626c5acfb8a06ea0d12ac2c5426052b0926233b8f3d80b1fe133af3e011e06cb818788f44600a5964ebb489d0ea2456

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+## How to contribute
+
+If you find what looks like a bug:
+
+* Check the [GitHub issue tracker](http://github.com/rajiteh/delayed_job_active_record_unique/issues/) to see if anyone else has reported issue.
+* If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+* Fork the project on github.
+* Make your changes with tests.
+* Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
+* Send a pull request.

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rajitha Perera
+
+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,79 @@
+[![Build Status](https://travis-ci.org/rajiteh/delayed_job_active_record_unique.svg)](https://travis-ci.org/rajiteh/delayed_job_active_record_unique)
+[![Coverage Status](https://coveralls.io/repos/rajiteh/delayed_job_active_record_unique/badge.svg)](https://coveralls.io/r/rajiteh/delayed_job_active_record_unique)
+[![Dependency Status](https://gemnasium.com/rajiteh/delayed_job_active_record_unique.svg)](https://gemnasium.com/rajiteh/delayed_job_active_record_unique)
+
+# DelayedJobActiveRecordUnique
+
+This gem extends DelayedJob functionality by providing a simple interface to specify if the job being enqueued needs to
+be unique within the queue.
+
+## Motivation
+
+Given a situation where a Job may overwrite some value every time it gets run (ie: batch imports), it makes 
+sense to only keep the latest job on queue. DelayedJob provides named queues as a method to identify jobs however, 
+using queue names to identify a large number of jobs is not feasible as the number of queues will grow  
+and scaling will be difficult. This gem extends the DelayedJob table with a new column that will store a unique key 
+from the handler thus will be able to detect if the specific job is already queued.
+
+Example scenarios: Batching e-mail notifications or performing indexing tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_active_record_unique'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayed_job_active_record_unique
+
+If you're using Rails, run the generator to create the migration for the
+delayed_job table.
+
+    rails g delayed_job:active_record_unique
+    rake db:migrate
+
+## Usage
+
+Uniqueness of the job can be specified by passing the key `unique_job` to the DelayedJob enqueue call. 
+
+```ruby
+    unique_job: {
+        attr: :id # Required. A method name in the object that will be called to obtain a uniquely identifiable value.
+        replace: true # Optional. Default = false. # Default behaviour will not enqueue a job that already exists.
+                      # On true, Any job that is already queued under this unique ID will be replaced by the current.
+    }
+```
+
+It is possible to just supply a `Symbol` to `unique_job` to set the attr value and proceed with default options.
+
+*Note:* You must supply a `queue` name to enqueue options or via class method `queue_name` as the uniqueness is only global to the queue.  
+## Example
+
+If using `#handle_asynchronously`
+
+```ruby
+    handle_asynchronously :solr_index, queue: 'solr_indexing', priority: 50, unique_job: { attr: :id, replace: true }
+```
+
+If using a standalone class
+
+```ruby
+    Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.pluck(:email)), unique_job: :get_id
+    #NewsLetterJob must have a 'get_id' method that will return a unique value to it's context.
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/rajiteh/delayed_job_active_record_unique/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/delayed_job_active_record_unique.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "delayed_job_active_record_unique"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Rajitha Perera"]
+  spec.email         = ["rajiteh@gmail.com"]
+  spec.summary       = %q{Extend DelayedJob to support unique job indentification.}
+  spec.description   = %q{This gem extends DelayedJob functionality by providing a simple interface to specify if the job being enqueued needs to
+be unique within the queue.}
+  spec.homepage      = "http://github.com/rajiteh/delayed_job_active_record_unique"
+  spec.license       = "MIT"
+
+  spec.files         = %w(CONTRIBUTING.md LICENSE.md README.md delayed_job_active_record_unique.gemspec) + Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "delayed_job_active_record", [">= 4.0", "< 5.0"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/delayed/backend/base/class_methods/unique_job.rb

@@ -0,0 +1,88 @@
+module Delayed
+  module Backend
+    module Base
+      module ClassMethods
+        alias_method :uj_old_enqueue, :enqueue
+
+        class UniqueJob
+          ERROR_NO_QUEUE = ":queue MUST be specified in the options or a method "\
+                           "queue_name must exist in the object for unique_job enqueue."
+          ERROR_BAD_ARGS = "'unique_job' must be one of: Hash with 'attr' key, a Symbol "\
+                           "or non blank String."
+
+          attr_accessor :opts
+          def initialize(opts)
+            self.opts = opts
+
+            if self.opts.has_key?(:unique_job)
+              self.opts[:queue] ||= class_queue_name #get class queue if specified
+              raise ArgumentError.new ERROR_NO_QUEUE if opts[:queue].nil?
+            else
+              @attr = false
+            end
+          end
+
+          def attr
+            @attr ||= opts.has_key?(:unique_job) &&
+                begin
+                  candidate = opts[:unique_job].is_a?(Hash) ? opts[:unique_job][:attr] : opts[:unique_job]
+                  if (candidate.is_a?(String) || candidate.is_a?(Symbol)) && !candidate.blank?
+                    "#{candidate}"
+                  else
+                    raise ArgumentError.new ERROR_BAD_ARGS
+                  end
+                end
+          end
+
+          def require_unique?
+            attr != false
+          end
+
+          def replace_job?
+            opts[:unique_job].is_a?(Hash) &&
+                opts[:unique_job][:replace] == true
+          end
+
+          def can_proceed?
+            !require_unique? || if replace_job?
+                                  ready_to_run_uniquely.destroy_all
+                                  true
+                                else
+                                  !ready_to_run_uniquely.exists?
+                                end
+          end
+
+          def ready_to_run_uniquely
+            Delayed::Job.ready_to_run('', Delayed::Worker.max_run_time).where(:unique_id => generate_key)
+          end
+
+          def generate_key
+            @key ||= if opts[:payload_object].is_a? Delayed::PerformableMethod
+                       "#{opts[:queue]}_#{opts[:payload_object].object.send(attr)}"
+                     else
+                       "#{opts[:queue]}_#{opts[:payload_object].send(attr)}"
+                     end
+          end
+
+          def class_queue_name
+            unless opts[:payload_object].is_a? Delayed::PerformableMethod
+              opts[:payload_object].queue_name if opts[:payload_object].respond_to? :queue_name
+            end
+          end
+          def enqueue_opts
+            require_unique? ? opts.except(:unique_job).merge(unique_id: generate_key) : opts
+          end
+
+        end
+
+        def enqueue(*args)
+          opts = args.extract_options!
+          opts[:payload_object] ||= args.shift
+          unique_job = UniqueJob.new opts
+          unique_job.can_proceed? && uj_old_enqueue(unique_job.enqueue_opts)
+        end
+
+      end
+    end
+  end
+end

data/lib/delayed_job_active_record_unique.rb

@@ -0,0 +1,2 @@
+require "delayed_job_active_record"
+require "delayed/backend/base/class_methods/unique_job"

data/lib/generators/delayed_job/active_record_unique_generator.rb

@@ -0,0 +1,22 @@
+require "generators/delayed_job/delayed_job_generator"
+require "generators/delayed_job/next_migration_version"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+# Extend the DelayedJobGenerator so that it creates an AR migration
+module DelayedJob
+  class ActiveRecordUniqueGenerator < ::DelayedJobGenerator
+    include Rails::Generators::Migration
+    extend NextMigrationVersion
+
+    source_paths << File.join(File.dirname(__FILE__), "templates")
+
+    def create_migration_file
+      migration_template "unique_id.rb", "db/migrate/add_unique_id_to_delayed_jobs.rb"
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number dirname
+    end
+  end
+end

data/lib/generators/delayed_job/next_migration_version.rb

@@ -0,0 +1,14 @@
+module DelayedJob
+  module NextMigrationVersion
+    # while methods have moved around this has been the implementation
+    # since ActiveRecord 3.0
+    def next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      if ActiveRecord::Base.timestamped_migrations
+        [Time.now.utc.strftime("%Y%m%d%H%M%S"), format("%.14d", next_migration_number)].max
+      else
+        format("%.3d", next_migration_number)
+      end
+    end
+  end
+end

data/lib/generators/delayed_job/templates/unique_id.rb

@@ -0,0 +1,11 @@
+class AddUniqueIdToDelayedJobs < ActiveRecord::Migration
+  def self.up
+    add_column :delayed_jobs, :unique_id, :string
+    add_index :delayed_jobs, [:priority, :run_at, :unique_id], name: "delayed_jobs_priority_unique_id"
+  end
+
+  def self.down
+    remove_index :delayed_jobs, name: "delayed_jobs_priority_unique_id"
+    remove_column :delayed_jobs, :unique_id
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_active_record_unique
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rajitha Perera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: |-
+  This gem extends DelayedJob functionality by providing a simple interface to specify if the job being enqueued needs to
+  be unique within the queue.
+email:
+- rajiteh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- delayed_job_active_record_unique.gemspec
+- lib/delayed/backend/base/class_methods/unique_job.rb
+- lib/delayed_job_active_record_unique.rb
+- lib/generators/delayed_job/active_record_unique_generator.rb
+- lib/generators/delayed_job/next_migration_version.rb
+- lib/generators/delayed_job/templates/unique_id.rb
+homepage: http://github.com/rajiteh/delayed_job_active_record_unique
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Extend DelayedJob to support unique job indentification.
+test_files: []