ihasa 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c2f1647dc36aad4a17f01d49748bf40116784c8
-  data.tar.gz: 03c3f6c7bd66c3a33ee7b2fde4c9bd579ded3fc3
+  metadata.gz: 90ccebca3bb8a2ff3b1bce72077560703cca3946
+  data.tar.gz: 14f0db80a27e810b1e9fdd62d9f90538dff9f138
 SHA512:
-  metadata.gz: 1cfc9af05559770453ce7e4c8d2d5cacdb35851eebdfaa247477f77839cbf9a137e8a844a3baf6d0606eed7d3491b76cc32ec865e4e7d27f27e1f8803c6d957a
-  data.tar.gz: 61ba1b7ef42a2d06a7d15d3ec252fc7042741b01194edfd63b0e5aea2b74e50a787b520f87d42d8028f87ed7e10a99c83f78e6e65f82f9c062188f6db3d75575
+  metadata.gz: e628c3b17377252702081c5e892f517ace37ce2bbf1df37a16b5c7eac549535c996279afd89f5aa5f29ec09fdc9b31f7e216f8b5474ac11af72c910f163149c4
+  data.tar.gz: eb82b4c0dac6315b81e253b088b3549de4d3deda3bd0b74662aef13476ddc8aed62f62a5c2a6527891b059006bb5c022b2c892d1940b29494e11937026fc24a9

data/README.md

@@ -28,7 +28,7 @@ $ gem install ihasa
 You can as well include it in you `Gemfile`:
 
 ```
-gem 'rubocop', require: false
+gem 'ihasa', require: false
 ```
 
 ## Usage
@@ -69,8 +69,60 @@ Please note that there is also a `Ihasa::Bucket#accept?!` method that raise a
 
 ### Advanced
 
-Here is some details on the available configuration options of the Ihasa::Bucket
-class.
+In this section, you will find some details on the available configuration options of the Ihasa::Bucket
+class, as well a some advices to run lots of Bucket simultaneously.
+
+#### Using a lots of different buckets
+
+If you want to enforce rate limits by customer, you have to create as many buckets as customers you have.
+Which can be a lot if you are successful ;).
+
+To have a lots of buckets in parallel and to avoid resetting your redis namespaces too often, I suggest you
+no longer use the `Ihasa.bucket` method. Instead, you should back-up your buckets with activerecord models
+(for example) and initialize them in a callback runned after the models creation.
+
+Example:
+
+```ruby
+  class Bucket < ActiveRecord::Base
+    attr_accessible :rate, :burst, :prefix
+
+    def implementation
+      @implementation ||= Ihasa::Bucket.new(rate, burst, prefix, $redis)
+    end
+
+    # The Ihasa::Bucket#initialize_redis_namespace set the relevant
+    # keys in your redis instance to have a working bucket. Do it
+    # only when you create or update your bucket's configuration.
+    after_save { implementation.initialize_redis_namespace }
+
+    delegate :accept?, to: :implementation
+  end
+
+  # Usage:
+
+  Bucket.create(rate: 10, burst: 50, prefix: 'CustomerIdentifier42')
+
+  # ...
+
+  # Later, in a controller:
+  DEFAULT_BUCKET = Ihasa.bucket(rate: 5, burst: 20, prefix: 'default')
+
+  def process_request
+    bucket = Bucket.find_by_prefix(params[:customer_identifier])
+    unless bucket
+      Rails.logger.warn("No bucket for customer #{params[:customer_identifier]}.")
+      Rails.logger.warn('Using default config.')
+      bucket = DEFAULT_BUCKET
+    end
+    unless bucket.accept?
+      Rails.logger.error("Customer #{params[:customer_identifier]} violated its rate limit.")
+      return head 403
+    end
+    # other actions not executed if rate limit violated
+    # ...
+  end
+```
 
 #### Configuring rate and burst limit
 

data/lib/ihasa.rb

@@ -2,8 +2,10 @@ require 'redis'
 require 'ihasa/version'
 require 'ihasa/bucket'
 
+# Ihasa module. Root of the Ihasa::Bucket class
 module Ihasa
   module_function
+
   def default_redis
     @redis ||= if ENV['REDIS_URL']
                  Redis.new url: ENV['REDIS_URL']
@@ -12,8 +14,8 @@ module Ihasa
                end
   end
 
-  DEFAULT_REDIS_PREFIX = 'IHAB'
-  def bucket(rate: 5, burst: 10, prefix: DEFAULT_REDIS_PREFIX, redis: default_redis)
-    @implementation = Bucket.new(rate, burst, prefix, redis)
+  DEFAULT_PREFIX = 'IHAB'.freeze
+  def bucket(rate: 5, burst: 10, prefix: DEFAULT_PREFIX, redis: default_redis)
+    Bucket.new(rate, burst, prefix, redis).tap(&:initialize_redis_namespace)
   end
 end

data/lib/ihasa/bucket.rb

@@ -15,7 +15,6 @@ module Ihasa
       @redis = redis
       @rate = Float rate
       @burst = Float burst
-      redis_init
     end
 
     def accept?
@@ -32,9 +31,7 @@ module Ihasa
       result
     end
 
-    protected
-
-    def redis_init
+    def initialize_redis_namespace
       redis_eval <<-LUA
         #{INTRO_STATEMENT}
         #{redis_set rate, @rate}
@@ -44,6 +41,8 @@ module Ihasa
       LUA
     end
 
+    protected
+
     require 'forwardable'
     extend Forwardable
 

data/lib/ihasa/version.rb

@@ -3,7 +3,7 @@
 module Ihasa
   # This module holds the Ihasa version information.
   module Version
-    STRING = '0.0.2'
+    STRING = '0.0.3'
 
     module_function
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ihasa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexandre Ignjatovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis