codeword 0.2.0.beta1 → 0.2.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a9e39af2e13a2e11bbc41e27257d98c9c2e35b1a4b63580be50456aec8b8b7
-  data.tar.gz: ae29b06372954d34efb4aec5a71d76fda264ab346f8d2c1ca63935991ead2c77
+  metadata.gz: f6ffa70037e0cddb9a44c6fc47a7bd9e8f903570f3e78a2961221d25cd465e5b
+  data.tar.gz: 500afbda48f4632781878ef18b174505b1380b1d1afa86dd85e9f56c70d4b053
 SHA512:
-  metadata.gz: 6466641140f9f984745286ccd9d172aaf98f5cedbbbea2b2788f87c8ca72ee1596eabcbba4c1f8507c748290c8febe6c8a879b7902a27e57944060aee0023815
-  data.tar.gz: f6d0701f7c961ec8274356aa4c2b38557ea18ea205ef509b0c69604e6c21ce46c67ea64f341f33e613a7eea2c848e9853fe4f852ea2cd58656d3ef07cc245ba6
+  metadata.gz: dd9703d78d830e6127fe13f77160d6ce6279b16f427a17283a100fb885934f5c97ffc6a345442b09e54c8fde882fee14474fef5e9e171d70dc90ad3133c0cd57
+  data.tar.gz: ef8fef69c8596dbb4f978f969841251de17ec1f87f245c4afc65254211f5ecac9e7ef94c48813b9f82e9c6f034b41c37c8904e805056f50b639cf5ec34316271

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+- BREAKING: Drop support for Rails < 7.2
+- BREAKING: Rename `check_for_codeword` to `require_codeword!`
 - BREAKING: Deprecate Rails secrets in favor of Rails credentials
 - BREAKING: Drop support for Rails < 6.0
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Dan Kim
+Copyright (c) 2025 Dan Kim
 Copyright (c) 2013 gb Studio, llc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -17,9 +17,29 @@ gem 'codeword'
 3. Mount the engine in your application’s routes file (usually first, for best results):
 
 ```ruby
+# config/routes.rb
 mount Codeword::Engine, at: '/codeword'
 ```
 
+4. Include the `Codeword` module in your application_controller.rb file and check for codeword:
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include Codeword
+
+  before_action :require_codeword!
+end
+```
+
+5. Skip the check for codeword in the controller(s) you would like to restrict:
+
+```ruby
+class APIController < ApplicationController
+  skip_before_action :require_codeword!, raise: false
+end
+```
+
 ## Usage
 
 To set a codeword, define CODEWORD in your environments/your_environment.rb file like so:
@@ -37,16 +57,16 @@ ENV['CODEWORD_HINT'] = 'Something that you do not tell everyone.'
 You can add your codeword via Rails credentials in your `credentials.yml.enc` file (`$ bin/rails credentials:edit`):
 
 ```yml
-codeword: 'love'
-codeword_hint: 'Pepé Le Pew'
+codeword: "love"
+codeword_hint: "Pepé Le Pew"
 ```
 
 Alternately, credentials in Rails >= 5.2 may be organized under the `codeword` namespace:
 
 ```yml
 codeword:
-  codeword: 'love'
-  hint: 'Pepé Le Pew'
+  codeword: "love"
+  hint: "Pepé Le Pew"
 ```
 
 **Codewords are not case-sensitive, by design. Keep it simple.**
@@ -60,13 +80,13 @@ codeword:
 2. In your application_controller.rb file, add:
 
 ```ruby
-skip_before_action :check_for_codeword, raise: false
+skip_before_action :require_codeword!, raise: false
 ```
 
 4. In the controller(s) you would like to restrict:
 
 ```ruby
-before_action :check_for_codeword
+before_action :require_codeword!
 ```
 
 ### Link it with no typing:

data/app/controllers/codeword/codeword_controller.rb

@@ -2,7 +2,7 @@ module Codeword
   class CodewordController < Codeword::ApplicationController
     CRAWLER_REGEX = /crawl|googlebot|slurp|spider|bingbot|tracker|click|parser|spider/
 
-    skip_before_action :check_for_codeword
+    skip_before_action :require_codeword!, raise: false
 
     def unlock
       user_agent = request.env['HTTP_USER_AGENT'].presence

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

@@ -1,3 +1,4 @@
+<style>
 body {
   color: #1a202c;
   background-color: #f7fafc;
@@ -95,3 +96,4 @@ form input[type="password"].nope {
   color: #718096;
   margin-top: 0.5rem;
 }
+</style>

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

@@ -1,3 +1,4 @@
+<style>
 html {
   font-family: sans-serif;
   line-height: 1.15;
@@ -55,3 +56,4 @@ button:-moz-focusring,
 textarea {
   overflow: auto;
 }
+</style>

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

@@ -8,10 +8,8 @@
 
     <title>Please enter the code word to continue…</title>
 
-    <style>
-      <%= render partial: 'layouts/codeword/normalize' %>
-      <%= render partial: 'layouts/codeword/inline_css' %>
-    </style>
+    <%= render partial: 'layouts/codeword/normalize' %>
+    <%= render partial: 'layouts/codeword/inline_css' %>
   </head>
 
   <body>

data/codeword.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name        = 'codeword'
   spec.version     = Codeword::VERSION
   spec.authors     = ['Dan Kim', 'gb Studio']
-  spec.email       = ['itsdanya@gmail.com']
+  spec.email       = ['git@dan.kim']
 
   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.'
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.add_dependency 'rails', '>= 6.1'
+  spec.add_dependency 'rails', '>= 7.2'
 
   spec.add_development_dependency 'capybara', '~> 2.9'
   spec.add_development_dependency 'debug'

data/lib/codeword/engine.rb

@@ -1,9 +1,5 @@
 module Codeword
   class Engine < ::Rails::Engine
     isolate_namespace Codeword
-
-    initializer 'codeword.app_controller' do |_app|
-      ActiveSupport.on_load(:action_controller) { include Codeword }
-    end
   end
 end

data/lib/codeword/version.rb

@@ -1,3 +1,3 @@
 module Codeword
-  VERSION = '0.2.0.beta1'.freeze
+  VERSION = '0.2.0.beta3'.freeze
 end

data/lib/codeword.rb

@@ -5,10 +5,6 @@ require 'codeword/engine'
 module Codeword
   extend ActiveSupport::Concern
 
-  included do
-    before_action :check_for_codeword, except: ['unlock']
-  end
-
   def self.from_config(setting)
     store = Rails.application.credentials
 
@@ -19,7 +15,7 @@ module Codeword
 
   private
 
-  def check_for_codeword
+  def require_codeword!
     return unless respond_to?(:codeword) && codeword_code
     return if cookies[:codeword].present? && cookies[:codeword] == codeword_code.to_s.downcase
 
@@ -29,6 +25,8 @@ module Codeword
     )
   end
 
+  alias_method :check_for_codeword, :require_codeword!
+
   def cookie_lifetime
     @cookie_lifetime ||=
       ENV['COOKIE_LIFETIME_IN_WEEKS'] ||

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.5"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeword
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta1
+  version: 0.2.0.beta3
 platform: ruby
 authors:
 - Dan Kim
 - gb Studio
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -85,13 +84,12 @@ description: A simple gem to more elegantly place a staging server or other in-p
   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
+- git@dan.kim
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -110,6 +108,7 @@ files:
 - lib/codeword.rb
 - lib/codeword/engine.rb
 - lib/codeword/version.rb
+- mise.toml
 - screenshot.png
 - script/rails
 homepage: https://github.com/dankimio/codeword
@@ -119,7 +118,6 @@ 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
@@ -134,8 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Lock staging servers from search engines and prying eyespec.
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-3.3.4