prop 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d713a87d828786d3721a7bad4f8f55942690e313316d8c112fbdc0d52573f7
-  data.tar.gz: 5bdce358ff1c577d117f97aedc866e9fdd0fa1856b4061a224cfa54c07fb774e
+  metadata.gz: cbbc31d7770e04a3a7142fe8b7cb300cd2b3aeac66eb4e779be6030490e6563d
+  data.tar.gz: c6278f0489ab81f3e0feb100334faca7042552a008b7381ef9b95043093f34b3
 SHA512:
-  metadata.gz: '095f555efdd1842c7a1f83ad0d946ec068aa322fac35b5592349d70fe8a495fbaae45fe91fd0c4e97da76dcb7d47a7804d86afa94cc16b13711f0a01faa871f3'
-  data.tar.gz: 55209fa3a51a9eb878e20f1f0faaf9b1f4bf8bbae85a2d97f852801d4d23c98084750500ff5cef5032042af7e35363da348f59f529096d04dc7d7a73d2d35cf1
+  metadata.gz: 15ebfffc8652e339fcb9a419d843ac18f9bfaa3e804d7289231d22edd944de25d23025d147dabf303f45b8787c14877b6c6019e5ed5351b10d462b2572f153d0
+  data.tar.gz: df16b882ca625eeccd2c11b67574eee8f905996199dee963b05e188c292e92f0a6d8361293698ab65f5bfadbe190882ed2f105172df5184da050276cba775325

data/README.md

@@ -31,6 +31,17 @@ Prop.before_throttle do |handle, key, threshold, interval|
 end
 ```
 
+## Setting an After Evaluated Callback
+
+You can define an optional callback that is invoked when a rate limit is checked. The callback will be invoked regardless
+of the result of the evaluation.
+
+```ruby
+Prop.after_evaluated do |handle, counter, options|
+  Rails.logger.info "Prop #{handle} has just been check. current value: #{counter}"
+end
+````
+
 ## Defining thresholds
 
 Example: Limit on accepted emails per hour from a given user, by defining a threshold and interval (in seconds):
@@ -43,7 +54,7 @@ Prop.configure(:mails_per_hour, threshold: 0, interval: 1.hour, description: "Al
 ```
 
 ```ruby
-# Throws Prop::RateLimitExceededError if the threshold/interval has been reached
+# Throws Prop::RateLimited if the threshold/interval has been reached
 Prop.throttle!(:mails_per_hour)
 
 # Prop can be used to guard a block of code

data/lib/prop/limiter.rb

@@ -9,7 +9,7 @@ module Prop
   class Limiter
 
     class << self
-      attr_accessor :handles, :before_throttle_callback, :cache
+      attr_accessor :handles, :before_throttle_callback, :cache, :after_evaluated_callback
 
       def read(&blk)
         raise "Use .cache = "
@@ -39,6 +39,10 @@ module Prop
         self.before_throttle_callback = blk
       end
 
+      def after_evaluated(&blk)
+        self.after_evaluated_callback = blk
+      end
+
       # Public: Registers a handle for rate limiting
       #
       # handle   - the name of the handle you wish to use in your code, e.g. :login_attempt
@@ -150,13 +154,18 @@ module Prop
         return [false, strategy.zero_counter] if disabled?
 
         if leaky_bucket_strategy?(strategy)
-          return Prop::LeakyBucketStrategy._throttle_leaky_bucket(handle, key, cache_key, options)
+          is_over_limit, bucket_info_hash = Prop::LeakyBucketStrategy._throttle_leaky_bucket(handle, key, cache_key, options)
+          bucket_counter = bucket_info_hash.fetch(:bucket)
+          after_evaluated_callback.call(handle, bucket_counter, options.merge(bucket_info_hash)) if after_evaluated_callback
+          return [is_over_limit, bucket_info_hash]
         end
 
         counter = options.key?(:decrement) ?
           strategy.decrement(cache_key, options.fetch(:decrement), options) :
           strategy.increment(cache_key, options.fetch(:increment, 1), options)
 
+        after_evaluated_callback.call(handle, counter, options) if after_evaluated_callback
+
         if strategy.compare_threshold?(counter, :>, options)
           before_throttle_callback &&
             before_throttle_callback.call(handle, key, options[:threshold], options[:interval])

data/lib/prop.rb

@@ -3,12 +3,12 @@ require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "2.8.0"
+  VERSION = "2.9.0"
 
   # Short hand for accessing Prop::Limiter methods
   class << self
     extend Forwardable
     def_delegators :"Prop::Limiter", :read, :write, :cache, :cache=, :configure, :configurations, :disabled, :before_throttle
-    def_delegators :"Prop::Limiter", :throttle, :throttle!, :throttled?, :count, :query, :reset
+    def_delegators :"Prop::Limiter", :throttle, :throttle!, :throttled?, :count, :query, :reset, :after_evaluated
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: primdahl@me.com
@@ -38,14 +38,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Gem for implementing rate limits.