resque-restriction 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a9aca569bec8f4f56affc4d804245a9fe335e7
-  data.tar.gz: '019f6b3d2bb70ea8fea85fbbcc194a00288382c2'
+  metadata.gz: 135cae91708b3d84ff8c6feafdb715e7043893ec
+  data.tar.gz: c4d04692d1b62a3b0bf8dc797a1c679965e05c69
 SHA512:
-  metadata.gz: b2f1e27d8a499374a074b525c8ea64d57503ddd2a3d9a4f018ecc54639af1bb468d31f84c16c246fb00b8ee3718e2418cfc497b119f753513906ad2778569e6a
-  data.tar.gz: 11dda9dc7c6629f268d55c1b7a7856d86db329e2e58c5db380cc84d9bd8a05d3c02cc19cbbcafd7b54b5d9d5776a7463286082698f61b988d66a31d14c10e1a0
+  metadata.gz: e0640880f52054dcfee91e434373a2db2b1cd5f61997fbaaefedce2d59f3647fb10ca0d921afd541c0fb2310ad8b29befe5d7f35c080e55be8d50183db089130
+  data.tar.gz: ecb9750f0198139276220ccb85178d09c44f824eba13bf83c3b11e8f3313c837f83f24064a65ca8a43de3b34f6fffc546ade0f5bc890052a88283e1075924876

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 ### Unreleased
 
-* prepend restriction to cache_key
+# 0.6.0
+
+* support customized period like `per_minute_and_user_id`
+* prepend restriction to `cache_key`
 
 # 0.5.0
 

data/README.md

@@ -59,6 +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:
 
+
+```ruby
+class GenerateFacebookShares
+  extend Resque::Plugins::Restriction
+
+  restrict :per_day_and_user_id => 40
+
+  # rest of your class here
+  def self.perform(options)
+    # options["user_id"] exists
+  end
+end
+```
+
 ```ruby
 class GenerateFacebookShares
   extend Resque::Plugins::Restriction

data/lib/resque/plugins/restriction.rb

@@ -64,13 +64,15 @@ module Resque
       end
 
       def redis_key(period, *args)
-        period_str = case period
+        period_key, custom_key = period.to_s.split('_and_')
+        period_str = case period_key.to_sym
                      when :concurrent then "*"
-                     when :per_minute, :per_hour, :per_day, :per_week then (Time.now.to_i / SECONDS[period]).to_s
+                     when :per_minute, :per_hour, :per_day, :per_week then (Time.now.to_i / SECONDS[period_key.to_sym]).to_s
                      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
-        [RESTRICTION_QUEUE_PREFIX, self.restriction_identifier(*args), period_str].compact.join(":")
+                     else period_key =~ /^per_(\d+)$/ and (Time.now.to_i / $1.to_i).to_s end
+        custom_value = (custom_key && args.first && args.first.is_a?(Hash)) ? args.first[custom_key] : nil
+        [RESTRICTION_QUEUE_PREFIX, self.restriction_identifier(*args), custom_value, period_str].compact.join(":")
       end
 
       def restriction_identifier(*args)
@@ -83,10 +85,11 @@ module Resque
       end
 
       def seconds(period)
-        if SECONDS.keys.include? period
-          SECONDS[period]
+        period_key, _ = period.to_s.split('_and_')
+        if SECONDS.keys.include?(period_key.to_sym)
+          SECONDS[period_key.to_sym]
         else
-          period.to_s =~ /^per_(\d+)$/ and $1.to_i
+          period_key =~ /^per_(\d+)$/ and $1.to_i
         end
       end
 

data/lib/resque/restriction/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-restriction
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Richard Huang