stop_it 0.1.0 → 1.0.0

data/README.md

@@ -1 +1,53 @@
-# StopIt
+# Stop It
+
+Stop It is a middleware for blocking requests to rake apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stop_it'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stop_it
+
+## Usage
+
+Let's see how to use Stop It with Ruby on Rails apps. To insert Stop It into the stack of middlewares of your app open config.ru file and add line
+
+    use StopIt
+
+right after line
+
+    require ::File.expand_path('../config/environment',  __FILE__)
+
+so that the file contains code similar to this:
+
+    # This file is used by Rack-based servers to start the application.
+
+    require ::File.expand_path('../config/environment',  __FILE__)
+    use StopIt
+    run MyRailsApp::Application # Here should be your application class name
+
+To configure which requests should be stopped add config/initializers/stop_it.rb file to your Ruby on Rails app with the following content:
+
+    StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
+
+    end
+
+If the block in stop method returns true then the request will be blocked. If it returns false then the request will be passed to the next middleware. In the following example all requests to /forbidden will be blocked.
+
+    StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
+      path_info == "/forbidden"
+    end
+
+Requests can be blocked by request path, remote address, query string, HTTP method, and user agent.
+
+## Contributing
+
+Your contribution is welcome.

data/lib/stop_it.rb

@@ -15,10 +15,14 @@ class StopIt
   end
 
   def call(env)
-    if stop?(env)
-      return [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
-    else
+    response = stop?(env)
+
+    if response == true
+      [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
+    elsif response == false
       @app.call(env)
+    else
+      response
     end
   end
 

data/spec/stop_it_spec.rb

@@ -19,14 +19,22 @@ describe StopIt do
     end
   end
 
-  describe "does not stop request if stop block returns false" do
-    before { StopIt.stop { |path_info, remote_addr, query_string, request_method, user_agent| false } }
-    it_should_behave_like "non-blocker", {}
-  end
+  describe "middleware response" do
+    context "stop block returns false" do
+      before { StopIt.stop { |path_info, remote_addr, query_string, request_method, user_agent| false } }
+      it_should_behave_like "non-blocker", {}
+    end
 
-  describe "stops request if stop block returns true" do
-    before { StopIt.stop { |path_info, remote_addr, query_string, request_method, user_agent| true } }
-    it_should_behave_like "blocker", {}
+    context "stop block returns true" do
+      before { StopIt.stop { |path_info, remote_addr, query_string, request_method, user_agent| true } }
+      it_should_behave_like "blocker", {}
+    end
+
+    context "stop block returns rake status" do
+      let(:response) { [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []] }
+      before { StopIt.stop { |path_info, remote_addr, query_string, request_method, user_agent| response } }
+      specify { middleware.call({}).should == response }
+    end
   end
 
   describe "filter requests by PATH_INFO env variable" do

data/stop_it.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "stop_it"
   gem.require_paths = ["lib"]
-  gem.version       = "0.1.0"
+  gem.version       = "1.0.0"
 
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stop_it
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70181456105600 !ruby/object:Gem::Requirement
+  requirement: &70316692893900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181456105600
+  version_requirements: *70316692893900
 description: ''
 email:
 - andrew.gridnev@gmail.com