rack-defense 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ece635cf91bb8348db49468754161d10d7263d8
-  data.tar.gz: 9e83f747514c973078fde57e36f370d1429e8188
+  metadata.gz: 9e47fe356fd72d70737af5ff0d64db8f823e1e93
+  data.tar.gz: 62972c5a9e0258ffccd3af644d9e191526686e2a
 SHA512:
-  metadata.gz: c2c434565856a67d7dba649a8d17fc140242e086038c4f61fc6f08e05a6215779f8f76f0baf2fcc0a0fd5e9ff2fcacedb0ba9cc5e737ef21fbd417b29792e2fe
-  data.tar.gz: 78d36f081d9084174c7922d48977f48cf2e38eabf800ddbcff5d17388eb312175d0c32e63765eef393b0054568a535bd716eee06fb955316d80615b53d511c70
+  metadata.gz: e09969ed7c4615439aa3f4dd105b992925cf48e7da9b0549f44c3f7757cbf8e4c46cdc5380edf0a66a5d3bb7c1bb8c2505062393a6600003dce6531f8b4f2840
+  data.tar.gz: c7258b578750efd00ce4046c8f3f6fa6daf97a0390a80b1a10df887bc22edf91894f7c6f49b00bfeda59724288c22dfc4e8fe776041ac457425c57a96d3b36e0

data/README.md

@@ -3,8 +3,10 @@ Rack::Defense
 
 A Rack middleware for throttling and filtering requests.
 
-[![Code Climate](https://codeclimate.com/github/Sinbadsoft/rack-defense/badges/gpa.svg)](https://codeclimate.com/github/Sinbadsoft/rack-defense) [![Build Status](https://travis-ci.org/Sinbadsoft/rack-defense.svg)](https://travis-ci.org/Sinbadsoft/rack-defense)
+[![Build Status](https://travis-ci.org/Sinbadsoft/rack-defense.svg)](https://travis-ci.org/Sinbadsoft/rack-defense)
+[![Code Climate](https://codeclimate.com/github/Sinbadsoft/rack-defense/badges/gpa.svg)](https://codeclimate.com/github/Sinbadsoft/rack-defense)
 [![Dependency Status](https://gemnasium.com/Sinbadsoft/rack-defense.svg)](https://gemnasium.com/Sinbadsoft/rack-defense)
+[![Gem Version](https://badge.fury.io/rb/rack-defense.svg)](http://badge.fury.io/rb/rack-defense)
 
 Rack::Defense is a Rack middleware that allows you to easily add request rate limiting and request filtering to your Rack based application (Ruby On Rails, Sinatra etc.).
 
@@ -14,6 +16,8 @@ Rack::Defense is a Rack middleware that allows you to easily add request rate li
 
 Rack::Defense has a small footprint and only two dependencies: [rack](https://github.com/rack/rack) and [redis](https://github.com/redis/redis-rb).
 
+Rack::Defense is inspired from the [Rack::Attack](https://github.com/kickstarter/rack-attack) project. The main difference is the throttling algorithm: Rack::Attack uses a counter reset at the end of each period, therefore allowing up to 2 times more requests than the maximum rate specified. We use a sliding window algorithm allowing a precise request rate limiting.
+
 ## Getting started
 
 Install the rack-defense gem; or add it to you Gemfile with bundler:
@@ -43,7 +47,7 @@ end
 ```
 
 ## Throttling
-The Rack::Defense middleware evaluates the throttling criterias (lambadas) against the incoming request. If the return value is falsy, the request is not throttled. Otherwise, the returned value is used as a key to throttle the request. The returned key could be the request IP, user name, API token or any discriminator to throttle the requests against.
+The Rack::Defense middleware evaluates the throttling criterias (lambdas) against the incoming request. If the return value is falsy, the request is not throttled. Otherwise, the returned value is used as a key to throttle the request. The returned key could be the request IP, user name, API token or any discriminator to throttle the requests against.
 
 ### Examples
 
@@ -71,13 +75,13 @@ Rack::Defense uses Redis to track request rates. By default, the `REDIS_URL` env
 The redis store can be setup with either a connection url: 
 ```ruby
 Rack::Defense.setup do |config|
-  store = "redis://:p4ssw0rd@10.0.1.1:6380/15"
+  config.store = "redis://:p4ssw0rd@10.0.1.1:6380/15"
 end
 ```
 or directly with a connection object:
 ```ruby
 Rack::Defense.setup do |config|
-  store = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
+  config.store = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
 end
 ```
 
@@ -98,7 +102,7 @@ end
 Allow only requests with a known API authorization token:
 ```ruby
 Rack::Defense.setup do |config|
-  config.ban('allow_only_ip_list') do |req|
+  config.ban('validate_api_token') do |req|
     %r{^/api/} =~ req.path && Redis.current.sismember('apitokens', req.env['HTTP_AUTHORIZATION'])
   end
 end
@@ -111,19 +115,19 @@ By default, Rack::Defense returns `429 Too Many Requests` and `403 Forbidden` re
 ```ruby
 Rack::Defense.setup do |config|
   config.banned_response =
-    ->(env) { [404, {'Content-Type' => 'text/plain'}, ["Not Found"]] }
+    ->(env) { [404, {'Content-Type' => 'text/plain'}, ["Not Found\n"]] }
     
   config.throttled_response =
-    ->(env) { [503, {'Content-Type' => 'text/plain'}, ["Service Unavailable"]] }
+    ->(env) { [503, {'Content-Type' => 'text/plain'}, ["Service Unavailable\n"]] }
   end
 end
 ```
 
 ## License
 
-Copyright [Sinbadsoft](http://www.sinbadsoft.com).
-
 Licensed under the [MIT License](http://opensource.org/licenses/MIT).
 
+Copyright Sinbadsoft.
+
 
 

data/lib/rack/defense.rb

@@ -1,5 +1,6 @@
 require 'rack'
 require 'redis'
+require 'delegate'
 
 class Rack::Defense
   autoload :ThrottleCounter, 'rack/defense/throttle_counter'
@@ -29,13 +30,15 @@ class Rack::Defense
     end
 
     def store=(value)
-      @store = value.is_a?(String) ? Redis.new(url: value) : value
+      value = Redis.new(url: value) if value.is_a?(String)
+      @store = SimpleDelegator::new(value) unless @store
+      @store.__setobj__(value)
     end
 
     def store
       # Redis.new uses REDIS_URL environment variable by default as URL.
       # See https://github.com/redis/redis-rb
-      @store ||= Redis.new
+      @store ||= SimpleDelegator.new(Redis.new)
     end
   end
 

data/lib/rack/defense/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Defense
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/defense_config_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper'
+
+describe Rack::Defense::Config do
+  before do
+    @config = Rack::Defense::Config.new
+  end
+
+  describe 'store' do
+    it 'creates store instance from connection string' do
+      url = 'redis://localhost:4444'
+      @config.store = url
+      assert url, conn_url(@config.store)
+    end
+
+    it 'update proxied store instance when store config changes' do
+      obj1, obj2 = Redis.new(url: 'redis://localhost:3333'), Redis.new(url: 'redis://localhost:4444')
+
+      @config.store = obj1
+      assert conn_url(obj1), conn_url(@config.store)
+
+      cached_store = @config.store
+
+      @config.store = obj2
+      assert conn_url(obj2), conn_url(@config.store)
+      assert conn_url(obj2), conn_url(cached_store)
+    end
+
+    def conn_url(conn)
+      conn.client.options[:url]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-defense
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chaker Nakhli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,40 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +107,7 @@ files:
 - lib/rack/defense/throttle_counter.rb
 - lib/rack/defense/version.rb
 - spec/defense_ban_spec.rb
+- spec/defense_config_spec.rb
 - spec/defense_throttle_spec.rb
 - spec/spec_helper.rb
 - spec/throttle_counter_spec.rb
@@ -150,5 +139,6 @@ summary: Throttle and filter requests
 test_files:
 - spec/spec_helper.rb
 - spec/throttle_counter_spec.rb
+- spec/defense_config_spec.rb
 - spec/defense_ban_spec.rb
 - spec/defense_throttle_spec.rb