codeword 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2a3032588df8a3dfcb5b5584785cdc9edf5558f2a47216dc70e32a74c083720
+  data.tar.gz: 54dcd07135dd8fe40e1a09091894a7c9baffb9c91d30e0bb4e12f0c18d3686ff
+SHA512:
+  metadata.gz: 811c21657b493979a64f641e3cb042bae1aec61312d7a3a96e45d7ac17614fcb0fa438f24cb8d7f75c75ef75279082018cb8b9bb97842c0542d2568693994bab
+  data.tar.gz: b3066b27282c5d060c981aa25f983f72fbe51144c31b7aee85921009696c66914976f404c3b6371fc7d1eef39e2e8f081bd87e356c3bf89a6c3bf71c6b35f283

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in codeword.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dan Kim
+Copyright (c) 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,97 @@
+# Codeword
+
+A simple gem to more elegantly place a staging server or other in-progress rails application behind a basic codeword. It’s easy to implement, share with clients/collaborators, and more beautiful than the typical password-protection sheet.
+
+## Installation
+
+1. Add this line to your application’s Gemfile:
+
+```ruby
+gem 'codeword'
+```
+
+2. Define a codeword (see Usage below).
+
+3. Mount the engine in your application’s routes file (usually first, for best results):
+
+```ruby
+mount Codeword::Engine, at: '/codeword'
+```
+
+## Usage
+
+To set a codeword, define CODEWORD in your environments/your_environment.rb file like so:
+
+```ruby
+ENV['CODEWORD'] = 'secret'
+```
+
+If you think you might need a hint:
+
+```ruby
+ENV['CODEWORD_HINT'] = 'Something that you do not tell everyone.'
+```
+
+If you’re using Rails >= 4.1 or Rails >= 5.2, you can add your Codeword Codeword via Rails Secrets or Rails Credentials functionality in your `secrets.yml` or `credentials.yml.enc` file, respectively:
+
+```yml
+codeword: 'love'
+codeword_hint: 'Pepé Le Pew'
+```
+
+Alternately, Rails Credentials in >= 5.2 may be organized under the `codeword` namespace:
+
+```yml
+codeword:
+  codeword: 'love'
+  hint: 'Pepé Le Pew'
+```
+
+If you’re using [Figaro](https://github.com/laserlemon/figaro), set your Codeword codeword and hint (optional) in your application.yml file:
+
+```yml
+codeword: 'love'
+codeword_hint: 'Pepé Le Pew'
+```
+
+**Codewords are not case-sensitive, by design. Keep it simple.**
+
+## Advanced Usage
+
+### Use Codeword around a specific controller:
+
+1. Follow the installation instructions above.
+
+2. In your application_controller.rb file, add:
+
+```ruby
+skip_before_action :check_for_codeword, raise: false
+```
+
+4. In the controller(s) you would like to restrict:
+
+```ruby
+before_action :check_for_codeword
+```
+
+### Link it with no typing:
+
+    http://somedomain.com/or_path/?codeword=love
+
+The visitor is redirected and the cookie is set without them ever seeing the Codeword splash page.
+
+(Codeword also makes a rudimentary attempt based on user agent to **block major search engine bots/crawlers** from following this link and indexing the site, just in case it ever gets out into the wild.)
+
+### Set a custom lifetime for cookie
+
+The cookie set by Codeword defaults to 5 years. If you want to set a shorter amount of time, you can specify a number of weeks:
+
+```ruby
+ENV['COOKIE_LIFETIME_IN_WEEKS'] = 4
+
+cookie_lifetime_in_weeks: 4
+```
+
+### Design Customization
+
+If you would like to change the content or design of the codeword page, you can create the directories `app/views/layouts/codeword` and `app/views/codeword/codeword` and populate them with the default content from [here](https://github.com/gblakeman/codeword/tree/master/app/views), and then customize as desired.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/codeword/application_controller.rb

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

data/app/controllers/codeword/codeword_controller.rb

@@ -0,0 +1,57 @@
+module Codeword
+  class CodewordController < Codeword::ApplicationController
+    CRAWLER_REGEX = /crawl|googlebot|slurp|spider|bingbot|tracker|click|parser|spider/
+
+    if respond_to?(:skip_before_action)
+      skip_before_action :check_for_codeword
+    else
+      skip_before_filter :check_for_codeword
+    end
+
+    def unlock
+      if params[:codeword].present?
+        user_agent = request.env['HTTP_USER_AGENT'].presence
+        if user_agent && user_agent.downcase.match(CRAWLER_REGEX)
+          head :ok
+          return
+        end
+
+        @codeword = params[:codeword].to_s.downcase
+        @return_to = params[:return_to]
+        if @codeword == codeword.to_s.downcase
+          set_cookie
+          run_redirect
+        end
+      elsif request.post?
+        if params[:codeword].present? && params[:codeword].respond_to?(:'[]')
+          @codeword = params[:codeword][:codeword].to_s.downcase
+          @return_to = params[:codeword][:return_to]
+          if @codeword == codeword.to_s.downcase
+            set_cookie
+            run_redirect
+          else
+            @wrong = true
+          end
+        else
+          head :ok
+        end
+      else
+        respond_to :html
+      end
+    end
+
+    private
+
+    def set_cookie
+      cookies[:codeword] = { value: @codeword.to_s.downcase, expires: (Time.now + codeword_cookie_lifetime) }
+    end
+
+    def run_redirect
+      if @return_to.present?
+        redirect_to @return_to.to_s
+      else
+        redirect_to '/'
+      end
+    end
+  end
+end

data/app/helpers/codeword/application_helper.rb

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

data/app/helpers/codeword/codeword_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Codeword
+  module CodewordHelper
+    def codeword_hint
+      @codeword_hint ||=
+        ENV['CODEWORD_HINT'] ||
+        ENV['codeword_hint'] ||
+        ::Codeword.from_config(:hint, :secrets) ||
+        ::Codeword.from_config(:hint)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+<div class="container">
+  <h1 style="margin-bottom: .5rem;">One more step</h1>
+
+  <p style="margin-bottom: 1.25rem;">Please enter the code word to continue…</p>
+
+  <% if @wrong %>
+    <div class="alert" style="margin-bottom: 1rem;">
+      <p>Hmm… that doesn't seem right. Try again?</p>
+    </div>
+  <% end %>
+
+  <%= form_for :codeword, url: { action: 'unlock' } do |form| %>
+    <% 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 %>
+
+    <% unless @wrong == true %>
+      <%= form.password_field :codeword, placeholder: "Code word", autofocus: true, required: true %>
+    <% else %>
+      <%= form.password_field :codeword, value: @codeword, class: 'nope', autofocus: true, required: true %>
+    <% end %>
+
+    <% if codeword_hint %>
+      <small title="<%= codeword_hint %>" class="hint">Hint</small>
+    <% end %>
+
+    <p>
+      <%= button_tag 'Go', class: 'button', style: 'margin-top: .75rem;' %>
+    </p>
+  <% end %>
+</div>

data/app/views/layouts/codeword/_inline_css.html.erb

@@ -0,0 +1,97 @@
+body {
+  color: #1a202c;
+  background-color: #f7fafc;
+  overflow: hidden;
+  margin: 0;
+
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+    "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji",
+    "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+
+  min-height: 100vh;
+  display: flex;
+  justify-content: center;
+}
+
+p {
+  color: #4a5568;
+  margin: 0;
+}
+
+.container {
+  margin: 0 auto;
+  padding-left: 1rem;
+  padding-right: 1rem;
+  width: 100%;
+}
+
+.text-center {
+  text-align: center;
+}
+
+@media (min-width: 768px) {
+  .container {
+    align-self: center;
+    max-width: 384px;
+  }
+}
+
+form input[type="password"] {
+  color: #4a5568;
+  border: 1px solid #e2e8f0;
+  border-radius: 0.25rem;
+  padding: 0.75rem 0.75rem;
+  line-height: 1.25;
+  -webkit-appearance: none;
+}
+
+form input[type="password"]:focus {
+  border-color: #266cec;
+}
+
+form input[type="password"].nope {
+  border-color: #d01a45;
+}
+
+.button {
+  background-color: #48bb78;
+  color: #fff;
+  cursor: pointer;
+  display: inline-block;
+  padding: 0.875rem 1rem;
+  border-radius: 0.25rem;
+  border: 1px solid transparent;
+
+  font-size: 0.875rem;
+  font-weight: 600;
+  text-align: center;
+  text-transform: uppercase;
+  letter-spacing: 0.1em;
+
+  outline: none;
+  transition: all 0.3s;
+}
+
+.button:hover,
+.button:focus {
+  background-color: #2f855a;
+}
+
+.alert {
+  display: block;
+  padding: 0.875rem 1rem;
+  background-color: #fff5f5;
+  border: 1px solid #fc8181;
+  border-radius: 4px;
+}
+
+.alert p {
+  color: #c53030;
+}
+
+.hint {
+  display: block;
+  cursor: help;
+  color: #718096;
+  margin-top: 0.5rem;
+}

data/app/views/layouts/codeword/_normalize.html.erb

@@ -0,0 +1,57 @@
+html {
+  font-family: sans-serif;
+  line-height: 1.15;
+  -ms-text-size-adjust: 100%;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  -webkit-text-decoration-skip: objects;
+}
+
+svg:not(:root) {
+  overflow: hidden;
+}
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  font-family: sans-serif;
+  font-size: 100%;
+  line-height: 1.15;
+  margin: 0;
+  text-transform: none;
+}
+
+button,
+input {
+  overflow: visible;
+}
+
+button,
+html [type="button"],
+[type="reset"],
+[type="submit"] {
+  -webkit-appearance: button;
+}
+
+button::-moz-focus-inner,
+[type="button"]::-moz-focus-inner,
+[type="reset"]::-moz-focus-inner,
+[type="submit"]::-moz-focus-inner {
+  border-style: none;
+  padding: 0;
+}
+
+button:-moz-focusring,
+[type="button"]:-moz-focusring,
+[type="reset"]:-moz-focusring,
+[type="submit"]:-moz-focusring {
+  outline: 1px dotted ButtonText;
+}
+
+textarea {
+  overflow: auto;
+}

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

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <meta name="robots" content="noindex, nofollow">
+
+    <title>Please enter the code word to continue…</title>
+
+    <style>
+      <%= render partial: 'layouts/codeword/normalize' %>
+      <%= render partial: 'layouts/codeword/inline_css' %>
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/codeword.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codeword/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'codeword'
+  spec.version     = Codeword::VERSION
+  spec.authors     = ['Dan Kim', 'gb Studio']
+  spec.email       = ['itsdanya@gmail.com']
+
+  spec.summary     = 'Lock staging servers from search engines and prying eyespec.'
+  spec.description = 'A simple gem to more elegantly place a staging server or other in-progress application behind a basic codeword. It’s easy to implement, share with clients/collaborators, and more beautiful than the typical password-protection sheet.'
+  spec.homepage    = 'https://github.com/dankimio/codeword'
+  spec.license     = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/dankimio/codeword'
+  spec.metadata['changelog_uri'] = 'https://github.com/dankimio/codeword/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_dependency 'rails', '>= 6'
+
+  spec.add_development_dependency 'capybara', '~> 2.9'
+  spec.add_development_dependency 'debug'
+  spec.add_development_dependency 'launchy', '~> 2.4'
+  spec.add_development_dependency 'rspec-rails', '~> 4.0'
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Codeword::Engine.routes.draw do
+  get 'unlock', to: 'codeword#unlock', as: 'unlock'
+  post 'unlock', to: 'codeword#unlock'
+end

data/lib/codeword/engine.rb

@@ -0,0 +1,15 @@
+module Codeword
+  class Engine < ::Rails::Engine
+    isolate_namespace Codeword
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.assets false
+      g.helper false
+    end
+
+    initializer 'codeword.app_controller' do |_app|
+      ActiveSupport.on_load(:action_controller) { include Codeword }
+    end
+  end
+end

data/lib/codeword/version.rb

@@ -0,0 +1,3 @@
+module Codeword
+  VERSION = '0.1.0'
+end

data/lib/codeword.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'codeword/engine'
+
+module Codeword
+  extend ActiveSupport::Concern
+
+  included do
+    if respond_to?(:before_action)
+      before_action :check_for_codeword, except: ['unlock']
+    else
+      before_filter :check_for_codeword, except: ['unlock']
+    end
+  end
+
+  def self.from_config(setting, secrets_or_credentials = :credentials)
+    return unless Rails.application.respond_to?(secrets_or_credentials)
+
+    store = Rails.application.public_send(secrets_or_credentials)
+
+    store.codeword.respond_to?(:fetch) &&
+      store.codeword.fetch(setting, store.public_send("codeword_#{setting}")) ||
+      store.public_send("codeword_#{setting}") || store.public_send(setting)
+  end
+
+  private
+
+  def check_for_codeword
+    return unless respond_to?(:codeword) && codeword_code
+    return if cookies[:codeword].present? && cookies[:codeword] == codeword_code.to_s.downcase
+
+    redirect_to codeword.unlock_path(
+      return_to: request.fullpath.split('?codeword')[0],
+      codeword: params[:codeword]
+    )
+  end
+
+  def cookie_lifetime
+    @cookie_lifetime ||=
+      ENV['COOKIE_LIFETIME_IN_WEEKS'] ||
+      ENV['cookie_lifetime_in_weeks'] ||
+      Codeword.from_config(:cookie_lifetime_in_weeks, :secrets) ||
+      Codeword.from_config(:cookie_lifetime_in_weeks)
+  end
+
+  def codeword_code
+    @codeword ||=
+      ENV['CODEWORD'] ||
+      ENV['codeword'] ||
+      Codeword.from_config(:codeword, :secrets) ||
+      Codeword.from_config(:codeword)
+  end
+
+  def codeword_cookie_lifetime
+    seconds = (cookie_lifetime.to_f * 1.week).to_i
+    if seconds > 0
+      seconds
+    else
+      5.years
+    end
+  end
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/codeword/engine', __dir__)
+
+require 'rails/all'
+require 'rails/engine/commands'

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: codeword
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Kim
+- gb Studio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A simple gem to more elegantly place a staging server or other in-progress
+  application behind a basic codeword. It’s easy to implement, share with clients/collaborators,
+  and more beautiful than the typical password-protection sheet.
+email:
+- itsdanya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/codeword/application_controller.rb
+- app/controllers/codeword/codeword_controller.rb
+- app/helpers/codeword/application_helper.rb
+- app/helpers/codeword/codeword_helper.rb
+- app/views/codeword/codeword/unlock.html.erb
+- app/views/layouts/codeword/_inline_css.html.erb
+- app/views/layouts/codeword/_normalize.html.erb
+- app/views/layouts/codeword/application.html.erb
+- codeword.gemspec
+- config/routes.rb
+- lib/codeword.rb
+- lib/codeword/engine.rb
+- lib/codeword/version.rb
+- script/rails
+homepage: https://github.com/dankimio/codeword
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dankimio/codeword
+  source_code_uri: https://github.com/dankimio/codeword
+  changelog_uri: https://github.com/dankimio/codeword/CHANGELOG.md
+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: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Lock staging servers from search engines and prying eyespec.
+test_files: []