staging_protection 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52ab40a40e2c8d892a8c4487011f8292a97a381b
+  data.tar.gz: 6f7fa872b6580040efa79012a512e6fd43f41135
+SHA512:
+  metadata.gz: f4b2e01e5bd6a136dab00629129d5fe0a2025d8e3f9ce1b3574b2e479e913a333a39ad96666e645d3a5972ce2f8e62d9c42668a2cc94890dcea4829efd806523
+  data.tar.gz: 31b6d6987b8b27bf32065ffc68a3a8eef23061aaf058668202d1c08de48337f9249d15c5d9d6ab95c43c5fd7850ef4c8316f7648fb0a8dbbc2dcc9a9b2be8fd1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anna Kazakova (gaar4ica)
+
+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,49 @@
+# StagingProtection
+
+A simple gem is desinged to hide staging apps from search engines and public access.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'staging_protection'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install staging_protection
+
+Then run:
+
+    $ rake staging_protection:initialize
+
+Or create config file manualy.
+
+## Usage
+
+Set up your credentials in config file.
+Don't forget to restart web server. And that's it. Open `http://localhost:3000` (or your site url) and you'll see it is forbidden.
+
+Once use `http://localhost:3000/?password=<your password from config>`. Now you can walk trough your site without any password. Token is stored in cookies.
+
+### Customizing access
+
+You can add an exclision conditions. For example, you don't want to protect action main from HomeController. This is very easy. Set method `protection_exclusion` to your HomeController.
+
+```ruby
+def protection_exclusion
+    params[:action] == 'main'
+end
+```
+And here you are. Action main is not blocked now.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/staging_protection/base.rb

@@ -0,0 +1,60 @@
+module StagingProtection
+  module Base
+
+    def self.extended(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+      base.send :init
+    end
+
+    module ClassMethods
+      def init
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def protection_exclusion
+            false
+          end
+        RUBY
+
+        [:password, :message, :token, :environment].each do |method|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{method}= value
+              @#{method} = value
+            end
+
+            def #{method}
+              StagingProtection.#{method}
+            end
+
+            def self.#{method}
+              @#{method}
+            end
+          RUBY
+        end
+      end
+
+      def config &block
+        @message = 'You are not authorized to access this page.'
+        @environment = :staging
+        yield self if block_given?
+      end
+    end
+
+    module InstanceMethods
+      def check_password_if_required
+        if Rails.env == environment && (request.format && (!request.format.json? || !request.format.js?)) && params[:format] != 'json'
+          if params[:pass] == password
+            cookies['secret_token'] = token
+          end
+          unless protection_exclusion || cookies[:secret_token] == token
+            render :text => message, :status => :not_found
+          end
+        end
+      end
+
+      def protection_exclusion
+        false
+      end
+    end
+
+  end
+end

data/lib/staging_protection/railtie.rb

@@ -0,0 +1,9 @@
+require 'staging_protection'
+
+module StagingProtection
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    rake_tasks { load "tasks/init.rake" }
+  end
+end

data/lib/staging_protection/version.rb

@@ -0,0 +1,3 @@
+module StagingProtection
+  VERSION = "0.0.1"
+end

data/lib/staging_protection.rb

@@ -0,0 +1,21 @@
+require "staging_protection/railtie" if defined?(Rails)
+require "staging_protection/version"
+require "staging_protection/base"
+
+module StagingProtection
+
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :check_password_if_required
+  end
+
+  private
+
+  extend Base
+
+end
+
+ActionController::Base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+  include StagingProtection
+RUBY

data/lib/tasks/init.rake

@@ -0,0 +1,26 @@
+namespace :staging_protection do
+  desc "Create default configuration"
+  task :initialize do
+    path = "config/initializers/staging_protection.rb"
+    file = File.open("#{Rails.root}/#{path}","w")
+    text = <<-TEXT
+StagingProtection.config do |config|
+  # Password should be changed
+  config.password = '123456'
+
+  # Token should be changed
+  config.token = '1234567819287321256789'
+
+  # Default error message can be overriden
+  # config.message = 'you are not authorized to access this page.'
+
+  # Default environment is staging, but it you can use any others.
+  # config.environment = 'development'
+end
+    TEXT
+    file << text
+    file.close
+
+    puts "Created config for staging_protection gem.\nCheck it out here! #{path}\n"
+  end
+end

data/staging_protection.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'staging_protection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "staging_protection"
+  spec.version       = StagingProtection::VERSION
+  spec.authors       = ["Anna Kazakova (gaar4ica)"]
+  spec.email         = ["gaar4ica@gmail.com"]
+  spec.description   = "A simple gem to protect an application from search engine cache"
+  spec.summary       = "Use password authentication for html-like requests"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: staging_protection
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anna Kazakova (gaar4ica)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: A simple gem to protect an application from search engine cache
+email:
+- gaar4ica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/staging_protection.rb
+- lib/staging_protection/base.rb
+- lib/staging_protection/railtie.rb
+- lib/staging_protection/version.rb
+- lib/tasks/init.rake
+- staging_protection.gemspec
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Use password authentication for html-like requests
+test_files: []