stop_it 1.0.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2beceff367a5d206d1daa97f3fcf7bc141d9476c
+  data.tar.gz: 8d5b8f2c8ca7bad5b286fe752b8764f78e089912
+SHA512:
+  metadata.gz: 7d52ebcf3bb58c69f0ab9fc2b88c2be84565c850df69e9ed3ad3570fff72f4796901488ea758a79f3a02a9fc72cce44153f0b4b625b250055c35cd0741022a18
+  data.tar.gz: 867189721681082da02d571fbdbe56f3206b5b0369a01ce88d0ab1244669e9ecd769178f40d00b85799d290d6f87a60a1ab4888ac21b8820acd98e2e88c3a560

data/.rspec

@@ -0,0 +1,4 @@
+--order random
+--colour
+--backtrace
+--format progress

data/README.md

@@ -36,22 +36,24 @@ so that the file contains code similar to this:
 
 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|
+    StopIt.stop do |opts|
 
     end
 
+@Opts@ is a hash with the following keys: @path_info@, @remote_addr@, @query_string@, @request_method@, @http_user_agent@.
+
 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"
+    StopIt.stop do |opts|
+      opts[:path_info] == "/forbidden"
     end
 
 Requests can be blocked by request path, remote address, query string, HTTP method, and user agent.
 
 The block in stop method may return a rake app response like this:
 
-    StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-      if remote_addr == "127.0.0.2"
+    StopIt.stop do |opts|
+      if opts[:remote_addr] == '127.0.0.2'
         [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
       end
     end

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
 
-task :default => :spec
+task default: :spec

data/lib/stop_it.rb

@@ -1,7 +1,7 @@
+# Middleware to block unwanted requests to a Rake app
 class StopIt
-
   class << self
-    def stop &block
+    def stop(&block)
       if block_given?
         @stop = block
       else
@@ -15,26 +15,26 @@ class StopIt
   end
 
   def call(env)
-    response = stop?(env)
+    should_be_stopped = request_should_be_stopped?(env)
 
-    if response == true
+    if should_be_stopped == true
       [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
-    elsif !response
+    elsif !should_be_stopped
       @app.call(env)
     else
-      response
+      should_be_stopped
     end
   end
 
   private
 
-  def stop?(env)
+  def request_should_be_stopped?(env)
     StopIt.stop && StopIt.stop.call(
-      env["PATH_INFO"],
-      env["REMOTE_ADDR"],
-      env["QUERY_STRING"],
-      env["REQUEST_METHOD"],
-      env["HTTP_USER_AGENT"]
+      path_info:       env['PATH_INFO'],
+      remote_addr:     env['REMOTE_ADDR'],
+      query_string:    env['QUERY_STRING'],
+      request_method:  env['REQUEST_METHOD'],
+      http_user_agent: env['HTTP_USER_AGENT']
     )
   end
 end

data/spec/stop_it_spec.rb

@@ -1,99 +1,78 @@
 require 'spec_helper'
 
 describe StopIt do
-  let!(:app) { app = double("App", call: nil) }
+  let!(:app) { double('App', call: nil) }
 
   subject(:middleware) { StopIt.new(app) }
 
-  shared_examples_for "blocker" do |env|
-    specify do
-      middleware.call(env)
-      expect(app).not_to have_received(:call)
-    end
+  shared_examples_for 'blocker' do |env|
+    before  { middleware.call(env) }
+    specify { expect(app).not_to have_received(:call) }
   end
 
-  shared_examples_for "non-blocker" do |env|
-    specify do
-      middleware.call(env)
-      expect(app).to have_received(:call)
-    end
+  shared_examples_for 'non-blocker' do |env|
+    before  { middleware.call(env) }
+    specify { expect(app).to have_received(:call) }
   end
 
-  describe "middleware response" do
-    context "stop block not specified" do
-      before { StopIt.instance_variable_set("@stop", nil) }
-      it_should_behave_like "non-blocker", {}
+  describe 'middleware response' do
+    context 'stop block not specified' do
+      before { StopIt.instance_variable_set('@stop', nil) }
+      it_behaves_like 'non-blocker', {}
     end
 
-    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", {}
+    context 'stop block returns false' do
+      before { StopIt.stop { false } }
+      it_behaves_like 'non-blocker', {}
     end
 
-    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", {}
+    context 'stop block returns true' do
+      before { StopIt.stop { true } }
+      it_behaves_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 }
+    context 'stop block returns rake status' do
+      let(:response) do
+        [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
+      end
+
+      before { StopIt.stop { response } }
+      specify { expect(middleware.call({})) == response }
     end
   end
 
-  describe "filter requests by PATH_INFO env variable" do
-    before do
-      StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-        path_info == "/forbidden"
-      end
-    end
+  describe 'filter requests by PATH_INFO env variable' do
+    before { StopIt.stop { |env| env[:path_info] == '/forbidden' } }
 
-    it_should_behave_like "blocker", "PATH_INFO" => "/forbidden"
-    it_should_behave_like "non-blocker", "PATH_INFO" => "/public"
+    it_behaves_like 'blocker',     'PATH_INFO' => '/forbidden'
+    it_behaves_like 'non-blocker', 'PATH_INFO' => '/public'
   end
 
-  describe "filter requests by REMOTE_ADDR env variable" do
-    before do
-      StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-        remote_addr == "192.168.0.1"
-      end
-    end
+  describe 'filter requests by REMOTE_ADDR env variable' do
+    before { StopIt.stop { |env| env[:remote_addr] == '192.168.0.1' } }
 
-    it_should_behave_like "blocker", "REMOTE_ADDR" => "192.168.0.1"
-    it_should_behave_like "non-blocker", "REMOTE_ADDR" => "127.0.0.1"
+    it_behaves_like 'blocker',     'REMOTE_ADDR' => '192.168.0.1'
+    it_behaves_like 'non-blocker', 'REMOTE_ADDR' => '127.0.0.1'
   end
 
-  describe "filter requests by QUERY_STRING env variable" do
-    before do
-      StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-        query_string == "?block"
-      end
-    end
+  describe 'filter requests by QUERY_STRING env variable' do
+    before { StopIt.stop { |env| env[:query_string] == '?block' } }
 
-    it_should_behave_like "blocker", "QUERY_STRING" => "?block"
-    it_should_behave_like "non-blocker", "QUERY_STRING" => ""
+    it_behaves_like 'blocker',     'QUERY_STRING' => '?block'
+    it_behaves_like 'non-blocker', 'QUERY_STRING' => ''
   end
 
-  describe "filter requests by REQUEST_METHOD env variable" do
-    before do
-      StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-        request_method == "POST"
-      end
-    end
+  describe 'filter requests by REQUEST_METHOD env variable' do
+    before { StopIt.stop { |env| env[:request_method] == 'POST' } }
 
-    it_should_behave_like "blocker", "REQUEST_METHOD" => "POST"
-    it_should_behave_like "non-blocker", "REQUEST_METHOD" => "GET"
+    it_behaves_like 'blocker',     'REQUEST_METHOD' => 'POST'
+    it_behaves_like 'non-blocker', 'REQUEST_METHOD' => 'GET'
   end
 
-  describe "filter requests by HTTP_USER_AGENT env variable" do
-    before do
-      StopIt.stop do |path_info, remote_addr, query_string, request_method, user_agent|
-        user_agent == "evil robot"
-      end
-    end
+  describe 'filter requests by HTTP_USER_AGENT env variable' do
+    before { StopIt.stop { |env| env[:http_user_agent] == 'evil robot' } }
 
-    it_should_behave_like "blocker", "HTTP_USER_AGENT" => "evil robot"
-    it_should_behave_like "non-blocker", "HTTP_USER_AGENT" => "IE"
+    it_behaves_like 'blocker',     'HTTP_USER_AGENT' => 'evil robot'
+    it_behaves_like 'non-blocker', 'HTTP_USER_AGENT' => 'IE'
   end
 end

data/stop_it.gemspec

@@ -1,17 +1,20 @@
 Gem::Specification.new do |gem|
-  gem.authors       = ["Andrew Gridnev"]
-  gem.email         = ["andrew.gridnev@gmail.com"]
-  gem.description   = %q{}
-  gem.summary       = %q{Middleware for blocking requests to rake apps.}
-  gem.homepage      = "https://github.com/andrewgr/stop_it/"
+  gem.authors       = ['Andrei Gridnev']
+  gem.email         = ['andrew.gridnev@gmail.com']
+  gem.description   = 'Middleware for blocking requests to rake apps
+    based on user agent, remote IP, and other environment variables.'
+  gem.summary       = 'Middleware for blocking requests to rake apps.'
+  gem.homepage      = 'https://github.com/andrewgr/stop_it/'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($ORS)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "stop_it"
-  gem.require_paths = ["lib"]
-  gem.version       = "1.0.1"
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = 'stop_it'
+  gem.require_paths = ['lib']
+  gem.version       = '2.0.0'
 
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop', '~> 0.30'
+  gem.add_development_dependency 'cane', '~> 2.6', '>= 2.6.1'
 end

metadata

@@ -1,35 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: stop_it
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
-- Andrew Gridnev
+- Andrei Gridnev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70174348138700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174348138700
-description: ''
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+description: |-
+  Middleware for blocking requests to rake apps
+      based on user agent, remote IP, and other environment variables.
 email:
 - andrew.gridnev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -41,29 +80,27 @@ files:
 homepage: https://github.com/andrewgr/stop_it/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Middleware for blocking requests to rake apps.
 test_files:
 - spec/spec_helper.rb
 - spec/stop_it_spec.rb
-has_rdoc: