resque-assurances 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc5d107fd8d5b3cabce5237c1ac5fb97ff6727d
-  data.tar.gz: 3c59a202d683fc50a0a26e6134dfbf333d2687d1
+  metadata.gz: c296188518096f9c7d0eef7dbb63132cb4bbfa54
+  data.tar.gz: 96f7d16922cbe2a37ec418f3e7f8c16b011df1c7
 SHA512:
-  metadata.gz: ad423fa22dd344cad5a70964355cca7daf871be4c33de2ed539f0924c59e4c05506ebffc3e599d13a850acd69ffabe5912c982f930660fa622559c3103161430
-  data.tar.gz: 9655608707479317b7c55a25b10abe5299ce6db1757af2746be7a68f92ddbd4f13522f2bee04dc9620bd4a64e66095def45ac8f7096fcdb5e7339bc5befe5cbd
+  metadata.gz: dd6a301c7bae1069638bc2e9893f56044abcf35fe7384cec98e5aca1b750fd1687e214c6236d569ad045576d585cbbb6e3aca23eac8fa832f04f37767b077448
+  data.tar.gz: b05eb5cc3fc367f87965ceb4129b8fa5f67506f065f26f77b69ac47be0db5225e4987a49436a44b4d03ebe05ed29d27747728be85564aa0562b31aec71416063

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Nathan Fixler
+Copyright (c) 2014 WegoWise Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/resque-assurances.rb

@@ -0,0 +1,31 @@
+require 'resque'
+require_relative 'resque-assurances/uniqueness'
+require_relative 'resque-assurances/job_key'
+
+module Resque
+  module Assurances
+    REDIS_UNIQUENESS_KEY = 'resque:assurances:uniqueness'
+
+    class << self
+      def reset!
+        redis.del(REDIS_UNIQUENESS_KEY)
+      end
+
+      def unique?(key)
+        !redis.sismember(REDIS_UNIQUENESS_KEY, key)
+      end
+
+      def set_key(key)
+        redis.sadd(REDIS_UNIQUENESS_KEY, key)
+      end
+
+      def remove_key(key)
+        redis.srem(REDIS_UNIQUENESS_KEY, key)
+      end
+
+      def redis
+        Resque.redis
+      end
+    end
+  end
+end

data/lib/resque-assurances/job_key.rb

@@ -0,0 +1,19 @@
+module Resque
+  module Assurances
+    class JobKey
+      def initialize(worker, *args)
+        @shash = generate_key(worker, *args)
+      end
+
+      def to_s
+        @shash
+      end
+
+      private
+
+      def generate_key(*args)
+        Digest::MD5.hexdigest(Resque.encode(args))
+      end
+    end
+  end
+end

data/lib/resque-assurances/uniqueness.rb

@@ -0,0 +1,23 @@
+module Resque
+  module Assurances
+    module Uniqueness
+      def before_enqueue_save_job_key(*args)
+        key = Resque::Assurances::JobKey.new(self, args)
+
+        if Resque::Assurances.unique?(key)
+          Resque::Assurances.set_key(key)
+          true
+        else
+          false
+        end
+      end
+
+      def around_perform_remove_job_key(*args)
+        key = Resque::Assurances::JobKey.new(self, args)
+        yield *args
+      ensure
+        Resque::Assurances.remove_key(key)
+      end
+    end
+  end
+end

data/lib/resque-assurances/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Assurances
-    VERSION = '0.0.0'
+    VERSION = '0.1.0'
   end
 end

data/resque-assurances.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.description = 'Collection of resque plugins that individually provide specific assurances about how resque workers will behave.'
 
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- spec/*`.split("n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
 
   s.add_runtime_dependency 'resque', '>= 1.0', '< 2'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'resque_spec'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'resque_spec', '~> 0.16'
 end

data/spec/lib/resque-assurances/job_key_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Resque::Assurances::JobKey do
+  it 'generates a unique key from different payloads' do
+    key1 = described_class.new(TestWorker, [42])
+    key2 = described_class.new(TestWorker, [43])
+    expect(key1.to_s).to_not eq key2.to_s
+  end
+
+  it 'generates a unique key from different worker classes' do
+    key1 = described_class.new(TestWorker, [42])
+    key2 = described_class.new(UniqueWorker, [42])
+    expect(key1.to_s).to_not eq key2.to_s
+  end
+
+  it 'generates the same key when worker and payloads are the same' do
+    key1 = described_class.new(TestWorker, [42])
+    key2 = described_class.new(TestWorker, [42])
+    expect(key1.to_s).to eq key2.to_s
+  end
+end

data/spec/lib/resque-assurances/uniqueness_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Resque::Assurances::Uniqueness do
+  it 'enqueues workers once' do
+    2.times { Resque.enqueue(UniqueWorker, 42) }
+    expect(UniqueWorker).to have_queue_size_of(1)
+    expect(UniqueWorker).to have_queued(42)
+  end
+
+  it 'enqueues workers without args once' do
+    2.times { Resque.enqueue(UniqueWorker) }
+    expect(UniqueWorker).to have_queue_size_of(1)
+  end
+
+  it 'enqueues workers with different args' do
+    Resque.enqueue(UniqueWorker, 42)
+    Resque.enqueue(UniqueWorker, 43)
+    expect(UniqueWorker).to have_queue_size_of(2)
+    expect(UniqueWorker).to have_queued(42)
+    expect(UniqueWorker).to have_queued(43)
+  end
+
+  it 'enqueues different workers with the same args' do
+    Resque.enqueue(UniqueWorker, 42)
+    Resque.enqueue(AnotherUniqueWorker, 42)
+    expect(UniqueWorker).to have_queued(42)
+    expect(AnotherUniqueWorker).to have_queued(42)
+  end
+
+  it 'can be queued again after the work is performed' do
+    Resque.enqueue(UniqueWorker)
+    expect(UniqueWorker).to have_queue_size_of(1)
+    ResqueSpec.perform_all(UniqueWorker.queue)
+    expect(UniqueWorker).to have_queue_size_of(0)
+    Resque.enqueue(UniqueWorker)
+    expect(UniqueWorker).to have_queue_size_of(1)
+  end
+
+  it 'can be queued again if the work fails' do
+    Resque.enqueue(UniqueWorker, 42)
+    expect(UniqueWorker).to have_queue_size_of(1)
+    expect(UniqueWorker).to receive(:do_some_work).and_raise(StandardError)
+    ResqueSpec.perform_all(UniqueWorker.queue) rescue StandardError
+    expect(UniqueWorker).to have_queue_size_of(0)
+    Resque.enqueue(UniqueWorker)
+    expect(UniqueWorker).to have_queue_size_of(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler.setup
+require 'resque-assurances'
+require 'resque_spec'
+require_relative 'support/test_worker'
+require_relative 'support/unique_worker'
+require_relative 'support/another_unique_worker'
+
+Resque.redis.namespace = 'resque:test'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ResqueSpec.reset!
+    Resque::Assurances.reset!
+  end
+end

data/spec/support/another_unique_worker.rb

@@ -0,0 +1,3 @@
+class AnotherUniqueWorker < TestWorker
+  extend Resque::Assurances::Uniqueness
+end

data/spec/support/test_worker.rb

@@ -0,0 +1,15 @@
+class TestWorker
+  class << self
+    def queue
+      '1'
+    end
+
+    def perform(*args)
+      do_some_work(*args)
+    end
+
+    def do_some_work(*_args)
+      # all done!
+    end
+  end
+end

data/spec/support/unique_worker.rb

@@ -0,0 +1,3 @@
+class UniqueWorker < TestWorker
+  extend Resque::Assurances::Uniqueness
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-assurances
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Fixler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -34,30 +34,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: resque_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 description: Collection of resque plugins that individually provide specific assurances
   about how resque workers will behave.
 email:
@@ -69,10 +69,19 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
+- lib/resque-assurances.rb
+- lib/resque-assurances/job_key.rb
+- lib/resque-assurances/uniqueness.rb
 - lib/resque-assurances/version.rb
 - resque-assurances.gemspec
+- spec/lib/resque-assurances/job_key_spec.rb
+- spec/lib/resque-assurances/uniqueness_spec.rb
+- spec/spec_helper.rb
+- spec/support/another_unique_worker.rb
+- spec/support/test_worker.rb
+- spec/support/unique_worker.rb
 homepage: https://rubygems.org/gems/resque-assurances
 licenses:
 - MIT
@@ -97,4 +106,10 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provide assurances for resque jobs.
-test_files: []
+test_files:
+- spec/lib/resque-assurances/job_key_spec.rb
+- spec/lib/resque-assurances/uniqueness_spec.rb
+- spec/spec_helper.rb
+- spec/support/another_unique_worker.rb
+- spec/support/test_worker.rb
+- spec/support/unique_worker.rb