prop 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea6891496856bc79f150b138e0c771f613d2214d
-  data.tar.gz: 93efa5eb27652eb0c8bb907f3d7439bd5d4f8260
+  metadata.gz: a5a9acb5c4023850aae92780dca0a51f4ec7e6cc
+  data.tar.gz: b237584c3a9d4e78d8f525d858bc8d1a7a6ecfc2
 SHA512:
-  metadata.gz: 2690c81fcd19c6c292e7782f15347e0fcb80f3e60d19e34c073e4e0b4b7b20d7c83ca9eef7e9c0ffcf8bf87f42270171a7f96c68cddabff130e2ac88859ad01f
-  data.tar.gz: aa0ae06e67099a0b782404aa559c45af195e2f51967a1004d71dea15d98d3f88341ca47833f337a2f8b86a52b6b89dab9eac7b0df548fd8a67ccc4876d5bf405
+  metadata.gz: dab07c90b327eff3b46f96f2b7324aaeb9f63f3888fb2c61ab46b10b0403366f2cddfdf493bfdec32ee0e678df6ae0f7bbf9aaae792e91106a620c51f436d76a
+  data.tar.gz: e47254422205e73130f9c604d613d0e6cf39105c11ff8757fc2967237e81745a9b2cce95424d2931ad733c3bc2413586379f7e4446e3b72feb1270032153fb88

data/README.md

@@ -157,6 +157,13 @@ Prop.configure(:execute_time, threshold: 10, interval: 1.minute)
 Prop.throttle!(:execute_time, account.id, increment: (Benchmark.realtime { execute }).to_i)
 ```
 
+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)
+```
+
 ## Optional configuration
 
 You can add optional configuration to a prop and retrieve it using `Prop.configurations[:foo]`:

data/lib/prop.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 
   # Short hand for accessing Prop::Limiter methods
   class << self

data/lib/prop/interval_strategy.rb

@@ -1,4 +1,4 @@
-require 'prop/limiter'
+# frozen_string_literal: true
 require 'prop/options'
 require 'prop/key'
 
@@ -13,11 +13,13 @@ module Prop
         Prop::Limiter.cache.read(cache_key).to_i
       end
 
-      def increment(cache_key, options)
-        increment = options.fetch(:increment, 1)
-        raise ArgumentError, "Increment must be a Fixnum, was #{increment.class}" unless increment.is_a?(Fixnum)
+      def change(cache_key, options)
+        amount = options.key?(:decrement) ?
+          -(options.fetch(:decrement)) :
+          options.fetch(:increment, 1)
+        raise ArgumentError, "Change amount must be a Fixnum, was #{amount.class}" unless amount.is_a?(Fixnum)
         cache = Prop::Limiter.cache
-        cache.increment(cache_key, increment) || (cache.write(cache_key, increment, raw: true) && increment) # WARNING: potential race condition
+        cache.increment(cache_key, amount) || (cache.write(cache_key, amount, raw: true) && amount) # WARNING: potential race condition
       end
 
       def reset(cache_key)
@@ -55,8 +57,9 @@ module Prop
         validate_positive_integer(options[:threshold], :threshold)
         validate_positive_integer(options[:interval], :interval)
 
-        if options.key?(:increment)
-          raise ArgumentError.new(":increment must be zero or a positive Integer") if !options[:increment].is_a?(Fixnum) || options[:increment] < 0
+        amount = options[:increment] || options[:decrement]
+        if amount
+          raise ArgumentError.new(":increment or :decrement must be zero or a positive Integer") if !amount.is_a?(Fixnum) || amount < 0
         end
       end
 

data/lib/prop/key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "digest/md5"
 
 module Prop
@@ -13,4 +14,4 @@ module Prop
     end
 
   end
-end
+end

data/lib/prop/leaky_bucket_strategy.rb

@@ -1,7 +1,6 @@
-require 'prop/limiter'
+# frozen_string_literal: true
 require 'prop/options'
 require 'prop/key'
-require 'prop/interval_strategy'
 
 module Prop
   class LeakyBucketStrategy
@@ -18,7 +17,10 @@ module Prop
 
       # WARNING: race condition
       # this increment is not atomic, so it might miss counts when used frequently
-      def increment(cache_key, options)
+      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)
+
         counter = counter(cache_key, options)
         counter[:bucket] += options.fetch(:increment, 1)
         Prop::Limiter.cache.write(cache_key, counter)

data/lib/prop/limiter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'prop/rate_limited'
 require 'prop/key'
 require 'prop/options'
@@ -145,7 +146,7 @@ module Prop
       def _throttle(handle, key, cache_key, options)
         return [false, @strategy.zero_counter] if disabled?
 
-        counter = @strategy.increment(cache_key, options)
+        counter = @strategy.change(cache_key, options)
 
         if @strategy.compare_threshold?(counter, :>, options)
           before_throttle_callback &&
@@ -164,7 +165,7 @@ module Prop
       end
 
       def disabled?
-        !!@disabled
+        defined?(@disabled) && !!@disabled
       end
 
       def prepare(handle, key, params)

data/lib/prop/middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prop
 
   # Convenience middleware that conveys the message configured on a Prop handle as well

data/lib/prop/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'prop/key'
 
 module Prop

data/lib/prop/rate_limited.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prop
   class RateLimited < StandardError
     attr_accessor :handle, :cache_key, :retry_after, :description, :first_throttled

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="