prop 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: db081ee0a96819c4b270c57e0205527b122d93b214b2c42af7d50159cfb140d1
-  data.tar.gz: f8ef4abcc3cb6762b70a993fed0446321585a14e685cbb91a1e37f355fe507e1
+SHA1:
+  metadata.gz: 850a96785d6d002acd243a5edf5cca965bd46bd1
+  data.tar.gz: 9ffb56011562feb0d9cf2c5ab62705420d59d46e
 SHA512:
-  metadata.gz: 7ff690ae0b93ebe4f15d05bb5e8b2b7f5f983607a56a9c9d1ad04c19a9de1aaa21b38b70d5763b091b5db6cd10c9890b3eb33bd5ca910b055f682eb0b5b23b07
-  data.tar.gz: 268563b7482c713097888855260875a19777cdd20982496bec4644dfd1b494dde6666d09b10789617fd8d905d9a18b98265dfebcf1609b20734c46ee56e1a24b
+  metadata.gz: 8cfee5d2c8af78a8a9273bdc873ba83ee6bb81237ca7cb253fce98dbf6180cff96f1004759e5d2fc4ee8e01364dddfae7f4b94c3909f547b08bcd3b109c9d7d2
+  data.tar.gz: 61e6d22651a9017e827d34220511fd8dd6dc60acaa69908968082d71a0ee6926859c0509f08b12fdf5a4d4310f83b95d0cf7b4137f713323d70fb88defcd0bbc

data/README.md

@@ -37,6 +37,9 @@ Example: Limit on accepted emails per hour from a given user, by defining a thre
 
 ```ruby
 Prop.configure(:mails_per_hour, threshold: 100, interval: 1.hour, description: "Mail rate limit exceeded")
+
+# Block requests by setting threshold to 0
+Prop.configure(:mails_per_hour, threshold: 0, interval: 1.hour, description: "All mail is blocked")
 ```
 
 ```ruby

data/lib/prop.rb

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

data/lib/prop/interval_strategy.rb

@@ -56,8 +56,8 @@ module Prop
       end
 
       def validate_options!(options)
-        validate_positive_integer(options[:threshold], :threshold)
-        validate_positive_integer(options[:interval], :interval)
+        validate_threshold(options[:threshold], :threshold)
+        validate_interval(options[:interval], :interval)
 
         amount = options[:increment] || options[:decrement]
         if amount
@@ -67,7 +67,11 @@ module Prop
 
       private
 
-      def validate_positive_integer(option, key)
+      def validate_threshold(option, key)
+        raise ArgumentError.new("#{key.inspect} must be a non-negative Integer") if !option.is_a?(Integer) || option < 0
+      end
+
+      def validate_interval(option, key)
         raise ArgumentError.new("#{key.inspect} must be a positive Integer") if !option.is_a?(Integer) || option <= 0
       end
 

data/lib/prop/leaky_bucket_strategy.rb

@@ -8,9 +8,10 @@ module Prop
       def counter(cache_key, options)
         bucket = Prop::Limiter.cache.read(cache_key) || zero_counter
         now = Time.now.to_i
-        leak_amount = (now - bucket.fetch(:last_updated)) / options.fetch(:interval) * options.fetch(:threshold)
+        leak_rate = (now - bucket.fetch(:last_updated)) / options.fetch(:interval).to_f
+        leak_amount =  leak_rate * options.fetch(:threshold)
 
-        bucket[:bucket] = [bucket.fetch(:bucket) - leak_amount, 0].max
+        bucket[:bucket] = [(bucket.fetch(:bucket) - leak_amount).to_i, 0].max
         bucket[:last_updated] = now
         bucket
       end

data/lib/prop/limiter.rb

@@ -46,8 +46,7 @@ module Prop
       #
       # Raises Prop::RateLimited if the number if the threshold for this handle has been reached
       def configure(handle, defaults)
-        raise ArgumentError.new("Invalid threshold setting") unless defaults[:threshold].to_i > 0
-        raise ArgumentError.new("Invalid interval setting")  unless defaults[:interval].to_i > 0
+        Prop::Options.validate_options!(defaults)
 
         self.handles ||= {}
         self.handles[handle] = defaults
@@ -56,7 +55,7 @@ module Prop
       # Public: Disables Prop for a block of code
       #
       # block    - a block of code within which Prop will not raise
-      def disabled(&block)
+      def disabled(&_block)
         @disabled = true
         yield
       ensure

data/lib/prop/options.rb

@@ -12,17 +12,24 @@ module Prop
       result   = defaults.merge(params)
 
       result[:key] = Prop::Key.normalize(key)
+      result[:strategy] = get_strategy(result)
 
-      result[:strategy] = if leaky_bucket.include?(result[:strategy])
+      result[:strategy].validate_options!(result)
+      result
+    end
+
+    def self.validate_options!(options)
+      get_strategy(options).validate_options!(options)
+    end
+
+    def self.get_strategy(options)
+      if leaky_bucket.include?(options[:strategy])
         Prop::LeakyBucketStrategy
-      elsif result[:strategy] == nil
+      elsif options[:strategy] == nil
         Prop::IntervalStrategy
       else
-        result[:strategy] # allowing any new/unknown strategy to be used
+        options[:strategy] # allowing any new/unknown strategy to be used
       end
-
-      result[:strategy].validate_options!(result)
-      result
     end
 
     def self.leaky_bucket

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Gem for implementing rate limits.