simple_throttle 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5d75f7ea1ae6ba61f7ec9894e4247259d3195f8
-  data.tar.gz: b1cb14758b9d5729ab9cae5baa22c8cbd40eb9b1
+  metadata.gz: d3891997e2673589d91401b2f7c721786264c1b9
+  data.tar.gz: b4bbcffae594f108495bfe7de6de20b00038f5d8
 SHA512:
-  metadata.gz: 78c8fd5675425a14094a04ff7f745a8da481d51741da8605ff3f460d77160b6421b30ae6ebba9bb412c45a28a0df8bc502c4a2dd19bd4cf8f87056ba753dcee3
-  data.tar.gz: 3553b9f03f048bb96b83935ff93fede2c034d83e9656d32e314e9c8cacec8bf681715c593663e4ce357ba41c59d075b153ecce581af853755c1479565c1a386d
+  metadata.gz: d2da1554c54fdd458f698c66e0a246eaf856d89e5de639f73e7a8592a820972e6a11ea90259ea6421118ed15adb043cd3cd65f40147bbb9ca7a71b87542a023b
+  data.tar.gz: b84de83b7b3dfbd61b2c60560b159e17e255cd125b58551620c5382b36cfdbfeb9df762a207493c62cea41639c3ec7ca274a61712f5d817f834464cafbed388c

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/README.md

@@ -1,4 +1,4 @@
-This gem provides a very simple throttling mechanism backed by redis for limiting access to a resource.
+This gem provides a very simple throttling mechanism backed by redis for limiting access to a resource. The throttle can be thought of as a limit on the number of calls in a set time frame (i.e. 100 calls per hour). These
 
 ## Usage
 
@@ -6,19 +6,30 @@ This gem provides a very simple throttling mechanism backed by redis for limitin
 # Initialize Redis client
 SimpleThrottle.set_redis(Redis.new)
 
+# ...or provide a block that returns a redis client
+SimpleThrottle.set_redis{ connection_pool.redis }
+
 # Add a global throttle (max of 10 requests in 60 seconds)
 SimpleThrottle.add(:things, limit: 10, ttl: 60)
 
-# Throttle a resource
+# Throttle a global resource
 if SimpleThrottle[:things].allowed!
   do_somthing
 else
   raise "Too many requests. Resource available in #{SimpleThrottle[:things].wait_time} seconds"
 end
+
+# Throttle resource useage per user (100 per hour)
+throttle = SimpleThrottle.new("resource@#{current_user.id}", limit: 100, ttl: 3600)
+if throttle.allowed!
+  do_somthing
+else
+  raise "Too many requests. Resource available in #{throttle.wait_time} seconds"
+end
 ```
 
-Calling `allow!` will return true if the throttle limit has not yet been reached and will also start tracking a new call if it returned true. There is no way to release a throttled call (that's why it's called SimpleThrottle).
+Calling `allowed!` will return `true` if the throttle limit has not yet been reached. If it does return `true`, then it will also start tracking that the call was made (hence the exclamation point syntax). There is no way to release a throttled call (that's why it's called `SimpleThrottle`).
 
-The throttle data is kept in redis as a list of timestamps and will be auto expired if it falls out of use. The thottles time windows are rolling time windows and more calls will be allowed as soon as possible.
+The throttle data is kept in redis as a list of timestamps and will be auto expired if it falls out of use. The thottles time windows are rolling time windows and more calls will be allowed as soon as possible. So, if you have a throttle of, 100 requests per hour, and the throttle kicks in, you will be able to make the next throttled call one hour after the first call being tracked, not one hour after the last call.
 
 Redis server 2.6 or greater is required.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/simple_throttle.rb

@@ -1,14 +1,19 @@
 require 'redis'
+require 'thread'
 
 # Create a simple throttle that can be used to limit the number of request for a resouce
 # per time period. These objects are thread safe.
 class SimpleThrottle
   
+  @@lock = Mutex.new
+  
   class << self
-    # Add a new throttle that can be referenced later with the [] method.
+    # Add a global throttle that can be referenced later with the [] method.
     def add(name, limit:, ttl:)
-      @throttles ||= {} 
-      @throttles[name.to_s] = new(name, limit: limit, ttl: ttl)       
+      @@lock.synchronize do
+        @throttles ||= {} 
+        @throttles[name.to_s] = new(name, limit: limit, ttl: ttl)     
+      end  
     end
     
     # Returns a globally defined throttle with the specfied name.

data/simple_throttle.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dev@weheartit.com", "bbdurand@gmail.com"]
   spec.summary       = "Simple redis backed throttling mechanism to limit access to a resource"
   spec.description   = "Simple redis backed throttling mechanism to limit access to a resource."
-  spec.homepage      = "https://github.com/weheartit/sidekiq_fast_enq"
+  spec.homepage      = "https://github.com/weheartit/simple_throttle"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/simple_throttle_spec.rb

@@ -37,6 +37,7 @@ describe SimpleThrottle do
     expect(throttle.allowed!).to eq false
     sleep(0.3)
     expect(throttle.allowed!).to eq true
+    expect(throttle.allowed!).to eq false
   end
   
   it "should be able to add global throttles" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_throttle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - We Heart It
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -75,6 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - MIT_LICENSE.txt
 - README.md
 - Rakefile
@@ -83,7 +84,7 @@ files:
 - simple_throttle.gemspec
 - spec/simple_throttle_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/weheartit/sidekiq_fast_enq
+homepage: https://github.com/weheartit/simple_throttle
 licenses:
 - MIT
 metadata: {}
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Simple redis backed throttling mechanism to limit access to a resource