kredis 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90d8ba8eadeb9cc6dbd2ca4bbb8532629281595e5a1feccd42487b98f248e67
-  data.tar.gz: 3d5e2768e7647d27bb004bc7167f9b35b97702bdcc3e3f6f76032abd3b85bb5d
+  metadata.gz: 4b979e9602301ecfbea9a89c99cc1b0f3763b26990c9264d7cb767aa258aaac5
+  data.tar.gz: cdd19bdd88263e1cbeae92cf40ad224cc7f84faa3965bd85f4e1f82487964ddd
 SHA512:
-  metadata.gz: 590e5baac4b4a2c85c4867f6ee55d4598c3b21e9c9b22961556626f59e8b17524cc4e4e9040f9109d30671ba4b615b074edcad5723df459f75a10dd1da956a23
-  data.tar.gz: 8ad76868f04ac0c0828485f2e03ce93fc8514eb32e2661028adcbc6ff9866f6016d26530b6af30f8df15009723e01797fc913084bb6bcb219f36558db7ed2768
+  metadata.gz: 26e3ce8f1580e01c7177ba79caf93b2a3e77276a03e4de30968633e8de675341ab12a16d08f113fe67631bd60c334631d33c6e41bfa70301778e3bf26d64bb70
+  data.tar.gz: 86dd839a25c227d18e04492d6d3a58526be5687fd4dcf20ff94eb127522b51e98b6acbfda4dc0059a56ab22b4a6ff2b4d81b59884636aed03f7ab735fe5b3de7

data/README.md

@@ -161,6 +161,20 @@ sleep 0.5.seconds
 true == flag.marked?            #=> EXISTS myflag
 sleep 0.6.seconds
 false == flag.marked?           #=> EXISTS myflag
+
+limiter = Kredis.limiter "mylimit", limit: 3, expires_in: 5.seconds
+0 == limiter.value              # => GET "limiter"
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+false == limiter.exceeded?      # => GET "limiter"
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+true == limiter.exceeded?       # => GET "limiter"
+sleep 6
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+limiter.poke                    # => SET limiter 0 NX + INCRBY limiter 1
+false == limiter.exceeded?      # => GET "limiter"
 ```
 
 ### Models

data/lib/kredis/attributes.rb

@@ -72,6 +72,10 @@ module Kredis::Attributes
       kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
+    def kredis_limiter(name, limit:, key: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, limit: limit, config: config, after_change: after_change, expires_in: expires_in
+    end
+
     def kredis_hash(name, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end

data/lib/kredis/types/limiter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# A limiter is a specialized form of a counter that can be checked whether it has been exceeded and is provided fail safe. This means it can be used to guard login screens from brute force attacks without denying access in case Redis is offline.
+#
+# It will usually be used as an expiring limiter. Note that the limiter expires in total after the `expires_in` time used upon the first poke.
+#
+# It offers no guarentee that you can't poke yourself above the limit. You're responsible for checking `#exceeded?` yourself first, and this may produce a race condition. So only use this when the exact number of pokes is not critical.
+class Kredis::Types::Limiter < Kredis::Types::Counter
+  class LimitExceeded < StandardError; end
+
+  attr_accessor :limit
+
+  def poke
+    failsafe returning: true do
+      increment
+    end
+  end
+
+  def exceeded?
+    failsafe returning: false do
+      value >= limit
+    end
+  end
+end

data/lib/kredis/types.rb

@@ -85,6 +85,10 @@ module Kredis::Types
     type_from(Slots, config, key, after_change: after_change, available: available)
   end
 
+  def limiter(key, limit:, expires_in: nil, config: :shared, after_change: nil)
+    type_from(Limiter, config, key, after_change: after_change, expires_in: expires_in, limit: limit)
+  end
+
   private
     def type_from(type_klass, config, key, after_change: nil, **options)
       type_klass.new(configured_for(config), namespaced_key(key), **options).then do |type|
@@ -107,3 +111,4 @@ require "kredis/types/unique_list"
 require "kredis/types/set"
 require "kredis/types/ordered_set"
 require "kredis/types/slots"
+require "kredis/types/limiter"

data/lib/kredis/version.rb

@@ -1,3 +1,3 @@
 module Kredis
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kredis
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
@@ -102,6 +102,7 @@ files:
 - lib/kredis/types/enum.rb
 - lib/kredis/types/flag.rb
 - lib/kredis/types/hash.rb
+- lib/kredis/types/limiter.rb
 - lib/kredis/types/list.rb
 - lib/kredis/types/ordered_set.rb
 - lib/kredis/types/proxy.rb