prop 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5a9acb5c4023850aae92780dca0a51f4ec7e6cc
-  data.tar.gz: b237584c3a9d4e78d8f525d858bc8d1a7a6ecfc2
+  metadata.gz: 65fa8acae93ced0dce793a91e6e050268560387d
+  data.tar.gz: b5086f3161ff68f0f27907360861d602184de0d2
 SHA512:
-  metadata.gz: dab07c90b327eff3b46f96f2b7324aaeb9f63f3888fb2c61ab46b10b0403366f2cddfdf493bfdec32ee0e678df6ae0f7bbf9aaae792e91106a620c51f436d76a
-  data.tar.gz: e47254422205e73130f9c604d613d0e6cf39105c11ff8757fc2967237e81745a9b2cce95424d2931ad733c3bc2413586379f7e4446e3b72feb1270032153fb88
+  metadata.gz: 702914150a4438bfe43f5d4ef9ea3abc2686d4c1705d4072864b449790797fbecd8cb6133e89044286b5eab6ffc02d38807ee6393e245f93b692bedf4cbc3dee
+  data.tar.gz: 0d7cfde00a0c68bb2ac1ba644f603cc9ae91c6603e875df6b1eb5f0491473ec8db43411fcbb21116b69bbe2f318a7f60b45f9746b97899db921607d726cf14db

data/README.md

@@ -158,7 +158,6 @@ Prop.throttle!(:execute_time, account.id, increment: (Benchmark.realtime { execu
 ```
 
 Decrement can be used to for example throttle before an expensive action and then give quota back when some condition is met.
-`:decrement` is only supported for `IntervalStrategy` for now
 
 ```ruby
 Prop.throttle!(:api_counts, request.remote_ip, decrement: 1)

data/lib/prop.rb

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

data/lib/prop/interval_strategy.rb

@@ -13,10 +13,8 @@ module Prop
         Prop::Limiter.cache.read(cache_key).to_i
       end
 
-      def change(cache_key, options)
-        amount = options.key?(:decrement) ?
-          -(options.fetch(:decrement)) :
-          options.fetch(:increment, 1)
+      # options argument is kept for api consistency for all strategies
+      def change(cache_key, amount, options = {})
         raise ArgumentError, "Change amount must be a Fixnum, was #{amount.class}" unless amount.is_a?(Fixnum)
         cache = Prop::Limiter.cache
         cache.increment(cache_key, amount) || (cache.write(cache_key, amount, raw: true) && amount) # WARNING: potential race condition

data/lib/prop/leaky_bucket_strategy.rb

@@ -17,12 +17,9 @@ module Prop
 
       # WARNING: race condition
       # this increment is not atomic, so it might miss counts when used frequently
-      def change(cache_key, options)
-        # please open a PR if you know how to support this
-        raise ArgumentError, "decrement is not supported for LeakyBucketStrategy" if options.key?(:decrement)
-
+      def change(cache_key, amount, options)
         counter = counter(cache_key, options)
-        counter[:bucket] += options.fetch(:increment, 1)
+        counter[:bucket] += amount
         Prop::Limiter.cache.write(cache_key, counter)
         counter
       end

data/lib/prop/limiter.rb

@@ -146,7 +146,10 @@ module Prop
       def _throttle(handle, key, cache_key, options)
         return [false, @strategy.zero_counter] if disabled?
 
-        counter = @strategy.change(cache_key, options)
+        amount = options.key?(:decrement) ?
+          -(options.fetch(:decrement)) :
+          options.fetch(:increment, 1)
+        counter = @strategy.change(cache_key, amount, options)
 
         if @strategy.compare_threshold?(counter, :>, options)
           before_throttle_callback &&

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake