rack_password 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48515f054fb19daafa35794779ea0e92c41ef6e9
+  data.tar.gz: ca364edf8baa5b737047d74eb2d9c73ee30fc56a
+SHA512:
+  metadata.gz: edc3f203402cb8f915cde034c4e436c2681d79875529b6a6a47520f305850617936bb1c16f627abe059c93a1039338c9904630dc9a176da48339cd56bb42daf7
+  data.tar.gz: ffbe9bbf9fd67ee5e4269b8ae97f6dbb1e6df70610c4a04598b66dde0409649bcb8e86d0beacc8c5f6bae0f11a6923a181442c878f9dae5234bd16d5f7611094

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack_password.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marcin Stecki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# RackPassword
+![](http://img.shields.io/gem/v/rack_password.svg?style=flat-square)
+[![](http://img.shields.io/codeclimate/github/netguru/rack_password.svg?style=flat-square)](https://codeclimate.com/github/netguru/rack_password)
+[![](http://img.shields.io/travis/netguru/rack_password.svg?style=flat-square)](ps://travis-ci.org/netguru/rack_password)
+
+Small rack middleware to block your site from unwanted vistors. A little bit more convenient than basic auth - browser will ask you once for the password and then set a cookie to remember you - unlike the http basic auth it wont prompt you all the time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_password'
+
+## Usage
+
+Let's assume you want to password protect your staging environemnt. Add something like this to `config/environments/staging.rb `
+
+
+```
+config.middleware.use RackPassword::Block, auth_codes: ['janusz']
+```
+
+From now on, your staging app should prompt for `janusz` password before you access it.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack_password/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/rack_password.rb

@@ -0,0 +1,69 @@
+require "rack_password/version"
+
+module RackPassword
+
+  class Block
+
+    def initialize app, options = {}
+      @app = app
+      @options = {
+        :key => :staging_auth,
+        :code_param => :code
+        }.merge options
+    end
+
+    def call env
+      request = Rack::Request.new env
+
+      bv = BlockValidator.new(@options, request)
+      return @app.call(env) if bv.valid?
+
+
+      if request.post? and bv.valid_code?(request.params[@options[:code_param].to_s]) # If post method check :code_param value
+        domain = request.host == 'localhost' ? '' : ".#{request.host}"
+      [301, {'Location' => request.path, 'Set-Cookie' => "#{@options[:key]}=#{request.params[@options[:code_param].to_s]}; domain=#{domain}; expires=30-Dec-2039 23:59:59 GMT"}, ['']] # Redirect if code is valid
+      else
+        success_rack_response
+      end
+    end
+
+    def success_rack_response
+      [200, {'Content-Type' => 'text/html'}, [read_success_view]]
+    end
+
+    private
+
+    def read_success_view
+      @success_view ||= File.open(File.join(File.dirname(__FILE__), "views", "block_middleware.html")).read
+    end
+  end
+
+  class BlockValidator
+    attr_accessor :options, :request
+
+    def initialize options, request
+      @options = options
+      @request = request
+    end
+
+    def valid?
+      valid_path? || valid_code?(@request.cookies[@options[:key].to_s]) || valid_ip?
+    end
+
+    def valid_ip?
+      return false if @options[:ip_whitelist].nil?
+      @options[:ip_whitelist].include? @request.ip.to_s
+    end
+
+    def valid_path?
+      match = @request.path =~ /\.xml|\.rss|\.json/ || @request.path =~ @options[:path_whitelist]
+      !!match
+    end
+
+    def valid_code? code
+      return false if @options[:auth_codes].nil?
+      @options[:auth_codes].include? code
+    end
+  end
+
+end

data/lib/rack_password/version.rb

@@ -0,0 +1,3 @@
+module RackPassword
+  VERSION = "1.0"
+end

data/lib/views/block_middleware.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <body>
+    <div class="container-fluid">
+      <div class="row-fluid">
+        <div class="span4"></div>
+        <div class="span4">
+          <legend>Sign in</legend>
+          <form action="" method="post" class="form-inline">
+            <input type="password" placeholder="Password..." name="code" />
+            <button type="submit" class="btn btn-primary">Sign in</button>
+          </form>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/rack_password.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_password/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack_password"
+  spec.version       = RackPassword::VERSION
+  spec.authors       = ["Marcin Stecki"]
+  spec.email         = ["marcin@netguru.pl"]
+  spec.summary       = %q{Small rack middleware to block your site from unwanted vistors.}
+  spec.description   = %q{Small rack middleware to block your site from unwanted vistors. A little bit more convenient than basic auth - browser will ask you once for the password and then set a cookie to remember you - unlike the http basic auth it wont prompt you all the time.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/lib/rack_password/block_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module RackPassword
+  describe Block do
+
+    describe "success rack response" do
+      let(:block){ Block.new("app") }
+
+      it "return 200 status code" do
+        expect(block.success_rack_response[0]).to eq 200
+      end
+
+      it "return html" do
+        expect(block.success_rack_response[2][0]).to include("password")
+      end
+    end
+  end
+end

data/spec/lib/rack_password/block_validator_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'rack_password'
+
+describe RackPassword::BlockValidator do
+  let(:options){ Hash.new }
+
+  describe "valid ip" do
+    let(:options) { Hash[ip_whitelist: ["127.0.0.1"]] }
+    it "be true when ip is whitelisted" do
+      request = double "Request", ip: "127.0.0.1"
+      bv = RackPassword::BlockValidator.new(options, request)
+      expect(bv.valid_ip?).to be(true)
+    end
+
+    it "be false when ip is not whitelisted" do
+      request = double "Request", ip: "192.168.0.1"
+      bv = RackPassword::BlockValidator.new(options, request)
+      expect(bv.valid_ip?).to be(false)
+    end
+  end
+
+  describe "valid path" do
+    it "be true when path is whitelisted" do
+      options[:path_whitelist] = /secret\/gate/
+      request = double "Request", path: "secret/gate"
+      bv = RackPassword::BlockValidator.new(options, request)
+      expect(bv.valid_path?).to be(true)
+    end
+
+    it "be true when path looks like allowed path" do
+      %w[janusz.xml lukasz.rss wykop.json].each do |asset|
+        request = double "Request", path: asset
+        bv = RackPassword::BlockValidator.new(options, request)
+        expect(bv.valid_path?).to be(true)
+      end
+    end
+
+    it "be false when path doesn't looks like asset" do
+      %w[products orders users].each do |asset|
+        request = double "Request", path: asset
+        bv = RackPassword::BlockValidator.new(options, request)
+        expect(bv.valid_path?).to be(false)
+      end
+    end
+  end
+
+  describe "valid code" do
+    let(:options) { Hash[auth_codes: ["secret"], key: :staging_auth] }
+    let(:request) { double "Request" }
+
+    it "be true when code is correct" do
+      bv = RackPassword::BlockValidator.new(options, request)
+      expect(bv.valid_code?("secret")).to be(true)
+    end
+
+    it "be false when code is incorrect" do
+      bv = RackPassword::BlockValidator.new(options, request)
+      expect(bv.valid_code?("incorrect_secret")).to be(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'rspec'
+require 'webmock/rspec'
+require 'rack_password'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rack_password
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Marcin Stecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Small rack middleware to block your site from unwanted vistors. A little
+  bit more convenient than basic auth - browser will ask you once for the password
+  and then set a cookie to remember you - unlike the http basic auth it wont prompt
+  you all the time.
+email:
+- marcin@netguru.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack_password.rb
+- lib/rack_password/version.rb
+- lib/views/block_middleware.html
+- rack_password.gemspec
+- spec/lib/rack_password/block_spec.rb
+- spec/lib/rack_password/block_validator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Small rack middleware to block your site from unwanted vistors.
+test_files:
+- spec/lib/rack_password/block_spec.rb
+- spec/lib/rack_password/block_validator_spec.rb
+- spec/spec_helper.rb