rails_throttle 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492c5d6e293b452d648df87c5324fbc88a4673127b7a023449d2a238e058fcc4
-  data.tar.gz: 0ce27efa3cacce1d6ef4d2b48c7784a0cde6b8fb5a40612590fdd7854dd6eef9
+  metadata.gz: c7003a6480b112a8c0bda90e1e3508295a9ad0846bfab4cbe0088e8a56623622
+  data.tar.gz: da9a5134768e3311c56af5c05fa5f48abfcaa357ff057057ee959834ec61a927
 SHA512:
-  metadata.gz: ab45d55646fe2e81133db0383e40ca071b0ad49df68d106a283ba49bfdffc179dfbe7a225a2dfadf8129afc351ba8116381c23e4953da9a9c4bad9ec8c859433
-  data.tar.gz: 5f9d4a40294454bd0377fb13d5af9da328f4b80330cb70d4038cf48d3fb3eaf04d3e583d1a0ee4cc93f777018b333f9f093436693088d664a6e11820a1d31920
+  metadata.gz: aa066f7ae4897aceba8afeaefaaf0b5376fee2e524b99b5f934ff9ae92a236a68d5b6b12d24264b539d2aa89a13d99c5395f3f608f54d2d3b35508eea8052efd
+  data.tar.gz: b1b88b6c7603310456cfacf016501f298adfb2311fcbd65ad5966e109badd21c9df85de158d8172a863eaf8b26ad67ea28a629d7e29086a139ef5374d69f4687

data/README.md

@@ -7,7 +7,7 @@ RailsThrottle is a simple library used to throttle code in your Rails applicatio
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "rails_throttle", "~> 0.1.0"
+gem "rails_throttle", "~> 0.2.0"
 ```
 
 And then execute:
@@ -33,7 +33,7 @@ Or install it yourself as:
     ```ruby
     RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => 1
     RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => 2
-    RailsThrottle::Throttle.decrement("foo", limit: 4, period: 2.seconds) # => 1
+    RailsThrottle::Throttle.decrement("foo", period: 2.seconds) # => 1
     RailsThrottle::Throttle.reset("foo")
     RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds, increment: 4) # => 4
     RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => RailsThrottle::ThrottleError

data/lib/rails_throttle/throttle.rb

@@ -24,7 +24,7 @@ module RailsThrottle
       raise "Must specify :limit in the parameters" if limit.nil?
       raise "Must specify :period in the parameters" if period.nil?
 
-      value = RailsThrottle.backend.increment(key, increment)
+      value = RailsThrottle.backend.increment(key, increment, expires_in: period)
 
       if value.nil?
         RailsThrottle.backend.write(key, increment, expires_in: period)
@@ -52,13 +52,18 @@ module RailsThrottle
     # @param [String] key The key that uniquely identifies this throttle operation.
     # @param [Hash] options The options to this increment.
     # @option options [Integer] :decrement The amount to decrement the counter by, defaults to 1 if not provided.
+    # @option options [Integer] :period The period of time (in seconds) which this throttle applies, the throttle will
+    #   expire after this number of seconds.
     # @return [Integer] The current value of the throttle counter.
     def self.decrement(key, options = {})
       raise "Key cannot be blank." if key.blank?
 
       decrement = options[:decrement] || 1
+      period = options[:period]
+
+      raise "Must specify :period in the parameters" if period.nil?
 
-      RailsThrottle.backend.decrement(key, decrement)
+      RailsThrottle.backend.decrement(key, decrement, expires_in: period)
     end
 
     # Returns true if the key is throttled, false otherwise.

data/lib/rails_throttle/version.rb

@@ -1,3 +1,3 @@
 module RailsThrottle
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_throttle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Zhu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-27 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport