prop 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0fe432ea00485ac163d99cc47cc62d515bf67fb
-  data.tar.gz: a6edac3e0e50fdaed49664fbdb4bd46419e81a27
+SHA256:
+  metadata.gz: bf33dac797d0f3b3cf7126709f1622e3069b7cf476f0bfde211178b3e4e743e1
+  data.tar.gz: e166a98af608dab54400289bb8fd28738b4ba8ab18ee0604613e75907ae4ec5c
 SHA512:
-  metadata.gz: 67390eaadb265153db7845785824a3f27b3bcb97db533b277d14b44a121c70deca9105bee5565541dabd53e374f67adff6da539346ea4f98f5bc8d730d156960
-  data.tar.gz: 66e0df0d0db24d5baf3ca3791b36dd0c9bf2f5bacc8d56637fb96d0f47266788483b752292e3b07337efc2d03c2e30d1b72e8330051ff64fa37984906566ad38
+  metadata.gz: 953571f21e59adbbd743490543fa4a7faf30b0e07951f3646bf7e3af5043ed2e24d0f93c6c5d375b1bb866ed5719e1eefe206bf4ce230b5001d80a7fc0f48cee
+  data.tar.gz: ca8960bee3c4f2789d4ddc9a07e489ee646c45cbbe9391da6b76f7e06f81711224093806e60a49f85cd5f1451389868f22b58f1259283b33cf7ffad21665948b

data/README.md

@@ -18,7 +18,7 @@ To store values, prop needs a cache:
 Prop.cache = Rails.cache # needs read/write/increment methods
 ```
 
-Prop does not expire its used keys, so use memcached or similar, not redis.
+When using the interval strategy, prop sets a key expiry to its interval.  Because the leaky bucket strategy does not set a ttl, it is best to use memcached or similar for all prop caching, not redis.
 
 ## Setting a Callback
 

data/lib/prop.rb

@@ -3,7 +3,7 @@ require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 
   # Short hand for accessing Prop::Limiter methods
   class << self

data/lib/prop/interval_strategy.rb

@@ -16,16 +16,16 @@ module Prop
       # options argument is kept for api consistency for all strategies
       def increment(cache_key, amount, options = {})
         raise ArgumentError, "Change amount must be a Integer, was #{amount.class}" unless amount.is_a?(Integer)
-        cache.increment(cache_key, amount) || (cache.write(cache_key, amount, raw: true) && amount) # WARNING: potential race condition
+        cache.increment(cache_key, amount) || (cache.write(cache_key, amount, raw: true, expires_in: options.fetch(:interval, nil)) && amount) # WARNING: potential race condition
       end
 
       def decrement(cache_key, amount, options = {})
         raise ArgumentError, "Change amount must be a Integer, was #{amount.class}" unless amount.is_a?(Integer)
-        cache.decrement(cache_key, amount) || (cache.write(cache_key, 0, raw: true) && 0) # WARNING: potential race condition
+        cache.decrement(cache_key, amount) || (cache.write(cache_key, 0, raw: true, expires_in: options.fetch(:interval, nil)) && 0) # WARNING: potential race condition
       end
 
-      def reset(cache_key)
-        cache.write(cache_key, zero_counter, raw: true)
+      def reset(cache_key, options = {})
+        cache.write(cache_key, zero_counter, raw: true, expires_in: options.fetch(:interval, nil))
       end
 
       def compare_threshold?(counter, operator, options)

data/lib/prop/leaky_bucket_strategy.rb

@@ -62,7 +62,7 @@ module Prop
         [false, bucket]
       end
 
-      def reset(cache_key)
+      def reset(cache_key, options = {})
         cache.write(cache_key, zero_counter, raw: true)
       end
 

data/lib/prop/limiter.rb

@@ -120,7 +120,7 @@ module Prop
       # Returns nothing
       def reset(handle, key = nil, options = {})
         _options, cache_key, strategy = prepare(handle, key, options)
-        strategy.reset(cache_key)
+        strategy.reset(cache_key, options)
       end
 
       # Public: Counts the number of times the given handle/key combination has been hit in the current window

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -115,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Gem for implementing rate limits.