resque-restriction 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d5a68d3642ec0f119a7b0a5ab5765c9e8120ecd
-  data.tar.gz: 0ce7caaf81c7e7c709b918b908e26f8848a4eb29
+  metadata.gz: 86a9aca569bec8f4f56affc4d804245a9fe335e7
+  data.tar.gz: '019f6b3d2bb70ea8fea85fbbcc194a00288382c2'
 SHA512:
-  metadata.gz: 2d84c124557820fb0defd27dd1e49d93919248d19949037a1f1208734b6857b3509f5a2c49a914111e959ead96e35dae54cb9ca2795b13ee45057753a1398920
-  data.tar.gz: 40c497e72004494edde919e59f3dfdbf4fb26e7ef3d2382db6111cd3affde8bde4a6e8995b9d10a57f6e814f7f880001e0564650d3131175b1a1e94323e37367
+  metadata.gz: b2f1e27d8a499374a074b525c8ea64d57503ddd2a3d9a4f018ecc54639af1bb468d31f84c16c246fb00b8ee3718e2418cfc497b119f753513906ad2778569e6a
+  data.tar.gz: 11dda9dc7c6629f268d55c1b7a7856d86db329e2e58c5db380cc84d9bd8a05d3c02cc19cbbcafd7b54b5d9d5776a7463286082698f61b988d66a31d14c10e1a0

data/.gitignore

@@ -4,3 +4,4 @@ pkg/**
 .rvmrc
 spec/stdout
 .rspec_status
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ### Unreleased
 
+* prepend restriction to cache_key
+
 # 0.5.0
 
 * drop activejob support

data/README.md

@@ -9,6 +9,10 @@ Resque Restriction is a plugin for the [Resque](https://github.com/resque/resque
 
 Resque Restriction requires Resque 1.7.0.
 
+*Please make sure your workers are checking restriction_xxx queue.*.
+e.g., if you add restriction plugin to high_priority queue, you need to
+check restriction_high_priority queue.
+
 Attention
 ---------
 
@@ -36,13 +40,15 @@ To use
 
 It is especially useful when a system has an email invitation resque job, because sending emails too frequentyly will be treated as a spam. What you should do for the InvitationJob is to inherit it from Resque::Plugins::RestrictionJob class and add restrict definition. Example:
 
-  class InvitationJob
-    extend Resque::Plugins::RestrictionJob
+```ruby
+class InvitationJob
+  extend Resque::Plugins::Restriction
 
-    restrict :per_day => 1000, :per_hour => 100, :per_300 => 30
+  restrict :per_day => 1000, :per_hour => 100, :per_300 => 30
 
-    #rest of your class here
-  end
+  # rest of your class here
+end
+```
 
 That means the InvitationJob can not be executed more than 1000 times per day, 100 times per hour and 30 times per 300 seconds.  All restrictions have to be met for the job to execute.
 
@@ -53,18 +59,20 @@ Advance
 
 You can also add customized restriction as you like. For example, we have a job to restrict the facebook post numbers 40 times per user per day, we can define as:
 
-  class GenerateFacebookShares
-    extend Resque::Plugins::RestrictionJob
-
-    restrict :per_day => 40
+```ruby
+class GenerateFacebookShares
+  extend Resque::Plugins::Restriction
 
-    def self.restriction_identifier(options)
-      [self.to_s, options["user_id"]].join(":")
-    end
+  restrict :per_day => 40
 
-    #rest of your class here
+  def self.restriction_identifier(options)
+    [self.to_s, options["user_id"]].join(":")
   end
 
+  # rest of your class here
+end
+```
+
 options["user_id"] returns the user's facebook uid, the key point is that the different restriction_identifiers can restrict different job execution numbers.
 
 

data/lib/resque/plugins/restriction.rb

@@ -70,7 +70,7 @@ module Resque
                      when :per_month then Date.today.strftime("%Y-%m")
                      when :per_year then Date.today.year.to_s
                      else period.to_s =~ /^per_(\d+)$/ and (Time.now.to_i / $1.to_i).to_s end
-        [self.restriction_identifier(*args), period_str].compact.join(":")
+        [RESTRICTION_QUEUE_PREFIX, self.restriction_identifier(*args), period_str].compact.join(":")
       end
 
       def restriction_identifier(*args)

data/lib/resque/restriction/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Restriction
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-restriction
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,6 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    resque-restriction (0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    mono_logger (1.1.0)
-    multi_json (1.11.2)
-    rack (1.6.4)
-    rack-protection (1.5.3)
-      rack
-    rake (10.5.0)
-    redis (3.2.1)
-    redis-namespace (1.5.1)
-      redis (~> 3.0, >= 3.0.4)
-    resque (1.25.2)
-      mono_logger (~> 1.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.3)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    sinatra (1.4.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
-    tilt (1.4.1)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  resque (>= 1.7.0)
-  resque-restriction!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.0