lockup 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 gb Studio, llc
+
+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 @@
+# Lockup
+
+“Can I come into your fort?”
+
+“…what's the codeword?”
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+        gem 'lockup', :git => 'https://github.com/gblakeman/lockup.git'
+
+2. Define a codeword (see Usage below).
+
+## Usage
+
+To set a codeword, define LOCKUP_CODEWORD in your environments/your_environment.rb file like so:
+
+    ENV["LOCKUP_CODEWORD"] = 'secret'
+
+If you're using [Figaro](https://github.com/laserlemon/figaro), set your lockup codeword in your application.yml file:
+
+    LOCKUP_CODEWORD: "love"
+    
+**Codewords are not case-sensitive, by design. Keep it simple.**
+
+### Link it with no typing:
+
+    http://somedomain.com/or_path/?lockup_codeword=love
+    
+The visitor is redirected and the cookie is set without them ever seeing the Lockup splash page.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lockup'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/lockup/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/lockup/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/lockup/layout.css

@@ -0,0 +1,91 @@
+body {
+  padding: 15%;
+  font-family: Helvetica, sans-serif;
+  color: #fff;
+  background-color: #252525;
+}
+h1 {
+  font-family: Helvetica, sans-serif;
+  font-size: 60px;
+  text-align: center;
+}
+form input[type='password'] {
+  display: block;
+  margin: 0 auto;
+  padding: 16px;
+  width: 200px;
+  color: #fff;
+  font-family: Helvetica, sans-serif;
+  font-size: 30px;
+  text-align: center;
+  background-color: #535353;
+  border: 1px solid #ccc;
+  -webkit-appearance: none;
+  outline: none;
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+  -webkit-transition: all 150ms ease-in-out;
+  -moz-transition: all 150ms ease-in-out;
+  -ms-transition: all 150ms ease-in-out;
+  -o-transition: all 150ms ease-in-out;
+  transition: all 150ms ease-in-out;
+}
+form input[type='password']:hover {
+  border-color: #ffcc33;
+}
+form input[type='password']:focus {
+  border-color: #266cec;
+}
+form input[type='password'].nope {
+  border-color: #d01a45;
+  background-color: #6c3137;
+}
+form button {
+  display: block;
+  margin: 0 auto;
+  padding: 6px 16px 6px 16px;
+  width: 232px;
+  color: #fff;
+  font-family: Helvetica, sans-serif;
+  font-size: 30px;
+  text-align: center;
+  background-color: #1ad056;
+  border: 0;
+  cursor: pointer;
+  -webkit-appearance: none;
+  outline: none;
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  border-radius: 0;
+  -webkit-transition: all 150ms ease-in-out;
+  -moz-transition: all 150ms ease-in-out;
+  -ms-transition: all 150ms ease-in-out;
+  -o-transition: all 150ms ease-in-out;
+  transition: all 150ms ease-in-out;
+}
+form button:hover,
+form button:focus {
+  background-color: #26ec67;
+}
+form button:active {
+  background-color: #266cec;
+  -webkit-transition: all 0 ease-in-out;
+  -moz-transition: all 0 ease-in-out;
+  -ms-transition: all 0 ease-in-out;
+  -o-transition: all 0 ease-in-out;
+  transition: all 0 ease-in-out;
+}
+form p {
+  margin-bottom: 32px
+}
+
+.hmm h3 {
+  display: block;
+  margin: 0 auto;
+  padding: 6px;
+  width: 400px;
+  color: #d01a45;
+  text-align: center;
+  background-color: #4a1f23;
+}

data/app/controllers/lockup/application_controller.rb

@@ -0,0 +1,4 @@
+module Lockup
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/lockup/lockup_controller.rb

@@ -0,0 +1,42 @@
+module Lockup
+  class LockupController < Lockup::ApplicationController
+    skip_before_filter :check_for_lockup
+    
+    def unlock
+      if params[:lockup_codeword].present?
+        @codeword = params[:lockup_codeword].to_s.downcase
+        @return_to = params[:return_to]
+        if @codeword == ENV["LOCKUP_CODEWORD"].to_s.downcase
+          set_cookie
+          run_redirect
+        end
+      end
+
+      if request.post?
+        @codeword = params[:lockup][:codeword].to_s.downcase
+        @return_to = params[:lockup][:return_to]
+        if @codeword == ENV["LOCKUP_CODEWORD"].to_s.downcase
+          set_cookie
+          run_redirect
+        else
+          @wrong = true
+        end
+      end
+    end
+    
+    private
+    
+    def set_cookie
+      cookies[:lockup] = { :value => @codeword.to_s.downcase, :expires => (Time.now + 5.years) }
+    end
+    
+    def run_redirect
+      if @return_to.present?
+        redirect_to "#{@return_to}"
+      else
+        redirect_to '/'
+      end
+    end
+
+  end
+end

data/app/helpers/lockup/application_helper.rb

@@ -0,0 +1,4 @@
+module Lockup
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/lockup/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="robots" content="noindex, nofollow" />
+    <title>Please enter the code word to continue…</title>
+    <%= stylesheet_link_tag    "lockup/application", :media => "all" %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/lockup/lockup/unlock.html.erb

@@ -0,0 +1,23 @@
+<h1>Please enter the code word to continue…</h1>
+
+<% if @wrong == true %>
+  <div class="hmm">
+    <h3>Hmm… that doesn’t seem right. Try again?</h3>
+  </div>
+<% end %>
+
+<%= form_for :lockup, :url => { :action => 'unlock' } do |form| %>
+  <% if @wrong == true %>
+    <p><%= form.password_field "codeword", :value => @codeword, :class => 'nope' %></p>
+  <% else %>
+    <p><%= form.password_field "codeword", :placeholder => "code word" %></p>
+  <% end %>
+    
+  <% if params[:return_to].present? %>
+    <%= form.hidden_field "return_to", :value => params[:return_to] %>
+  <% elsif @return_to.present? %>
+    <%= form.hidden_field "return_to", :value => @return_to %>
+  <% end %>
+    
+  <p><%= button_tag "Go" %></p>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  mount Lockup::Engine, at: '/lockup'
+end
+
+Lockup::Engine.routes.draw do
+  match 'unlock' => 'lockup#unlock'
+end

data/lib/lockup.rb

@@ -0,0 +1,22 @@
+require "lockup/engine"
+
+module Lockup
+  module InstanceMethods
+
+    def check_for_lockup
+      if ENV["LOCKUP_CODEWORD"].present?
+        if cookies[:lockup].present?
+          if cookies[:lockup] == ENV["LOCKUP_CODEWORD"].to_s.downcase
+            return
+          else
+            redirect_to :controller => 'lockup', :action => 'unlock', :return_to => request.fullpath.split('?lockup_codeword')[0], :lockup_codeword => params[:lockup_codeword]
+          end
+        else
+          redirect_to :controller => 'lockup', :action => 'unlock', :return_to => request.fullpath.split('?lockup_codeword')[0], :lockup_codeword => params[:lockup_codeword]
+        end
+      end
+    end
+  end
+  module ClassMethods
+  end
+end

data/lib/lockup/engine.rb

@@ -0,0 +1,13 @@
+module Lockup
+  class Engine < ::Rails::Engine
+    isolate_namespace Lockup
+
+    initializer 'lockup.app_controller' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include Lockup::InstanceMethods
+        extend Lockup::ClassMethods
+        before_filter :check_for_lockup
+      end
+    end
+  end
+end

data/lib/lockup/version.rb

@@ -0,0 +1,3 @@
+module Lockup
+  VERSION = "0.0.2"
+end

data/lib/tasks/lockup_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lockup do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.