codeword 0.1.0 → 0.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2a3032588df8a3dfcb5b5584785cdc9edf5558f2a47216dc70e32a74c083720
-  data.tar.gz: 54dcd07135dd8fe40e1a09091894a7c9baffb9c91d30e0bb4e12f0c18d3686ff
+  metadata.gz: 20a9e39af2e13a2e11bbc41e27257d98c9c2e35b1a4b63580be50456aec8b8b7
+  data.tar.gz: ae29b06372954d34efb4aec5a71d76fda264ab346f8d2c1ca63935991ead2c77
 SHA512:
-  metadata.gz: 811c21657b493979a64f641e3cb042bae1aec61312d7a3a96e45d7ac17614fcb0fa438f24cb8d7f75c75ef75279082018cb8b9bb97842c0542d2568693994bab
-  data.tar.gz: b3066b27282c5d060c981aa25f983f72fbe51144c31b7aee85921009696c66914976f404c3b6371fc7d1eef39e2e8f081bd87e356c3bf89a6c3bf71c6b35f283
+  metadata.gz: 6466641140f9f984745286ccd9d172aaf98f5cedbbbea2b2788f87c8ca72ee1596eabcbba4c1f8507c748290c8febe6c8a879b7902a27e57944060aee0023815
+  data.tar.gz: f6d0701f7c961ec8274356aa4c2b38557ea18ea205ef509b0c69604e6c21ce46c67ea64f341f33e613a7eea2c848e9853fe4f852ea2cd58656d3ef07cc245ba6

data/.gitignore

@@ -7,3 +7,6 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+
+# macOS
+.DS_Store

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.3.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+- BREAKING: Deprecate Rails secrets in favor of Rails credentials
+- BREAKING: Drop support for Rails < 6.0
+
+## [0.1.1] - 2021-12-17
+
+- Fix unlocks
+- Refactor CodewordController
+
+## [0.1.0] - 2021-12-17
+
+- Initial release

data/README.md

@@ -1,6 +1,8 @@
 # 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.
+A simple gem to more elegantly place a staging server or other in-progress Ruby on Rails application behind a basic codeword. It’s easy to implement, share with clients/collaborators, and more beautiful than the typical password-protection sheet.
+
+![Screenshot](./screenshot.png)
 
 ## Installation
 
@@ -32,14 +34,14 @@ If you think you might need a hint:
 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:
+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'
 ```
 
-Alternately, Rails Credentials in >= 5.2 may be organized under the `codeword` namespace:
+Alternately, credentials in Rails >= 5.2 may be organized under the `codeword` namespace:
 
 ```yml
 codeword:
@@ -47,13 +49,6 @@ codeword:
   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
@@ -94,4 +89,12 @@ 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.
+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/dankimio/codeword/tree/main/app/views), and then customize as desired.
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Acknowledgements
+
+Codeword is a fork of [lockup](https://github.com/interdiscipline/lockup).

data/app/controllers/codeword/codeword_controller.rb

@@ -2,38 +2,23 @@ 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
+    skip_before_action :check_for_codeword
 
     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
+      user_agent = request.env['HTTP_USER_AGENT'].presence
+      if user_agent&.downcase&.match(CRAWLER_REGEX)
+        head :ok
+        return
+      end
 
+      if params[:codeword].present?
         @codeword = params[:codeword].to_s.downcase
         @return_to = params[:return_to]
-        if @codeword == codeword.to_s.downcase
+        if @codeword == codeword_code.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
+          @wrong = true
         end
       else
         respond_to :html

data/app/helpers/codeword/codeword_helper.rb

@@ -3,11 +3,7 @@
 module Codeword
   module CodewordHelper
     def codeword_hint
-      @codeword_hint ||=
-        ENV['CODEWORD_HINT'] ||
-        ENV['codeword_hint'] ||
-        ::Codeword.from_config(:hint, :secrets) ||
-        ::Codeword.from_config(:hint)
+      @codeword_hint ||= ENV['CODEWORD_HINT'] || ENV['codeword_hint'] || ::Codeword.from_config(:hint)
     end
   end
 end

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

@@ -9,17 +9,17 @@
     </div>
   <% end %>
 
-  <%= form_for :codeword, url: { action: 'unlock' } do |form| %>
+  <%= form_tag '/codeword/unlock' do %>
     <% if params[:return_to].present? %>
-      <%= form.hidden_field "return_to", value: params[:return_to] %>
+      <%= hidden_field_tag 'return_to', params[:return_to] %>
     <% elsif @return_to.present? %>
-      <%= form.hidden_field "return_to", value: @return_to %>
+      <%= hidden_field_tag 'return_to', @return_to %>
     <% end %>
 
     <% unless @wrong == true %>
-      <%= form.password_field :codeword, placeholder: "Code word", autofocus: true, required: true %>
+      <%= password_field_tag 'codeword', nil, placeholder: "Code word", autofocus: true, required: true %>
     <% else %>
-      <%= form.password_field :codeword, value: @codeword, class: 'nope', autofocus: true, required: true %>
+      <%= password_field_tag 'codeword', @codeword, class: 'nope', autofocus: true, required: true %>
     <% end %>
 
     <% if codeword_hint %>

data/codeword.gemspec

@@ -21,10 +21,10 @@ 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'
+  spec.add_dependency 'rails', '>= 6.1'
 
   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'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
 end

data/lib/codeword/engine.rb

@@ -2,12 +2,6 @@ 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

data/lib/codeword/version.rb

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

data/lib/codeword.rb

@@ -6,17 +6,11 @@ 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
+    before_action :check_for_codeword, except: ['unlock']
   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)
+  def self.from_config(setting)
+    store = Rails.application.credentials
 
     store.codeword.respond_to?(:fetch) &&
       store.codeword.fetch(setting, store.public_send("codeword_#{setting}")) ||
@@ -39,21 +33,16 @@ module Codeword
     @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)
+    @codeword_code ||= ENV['CODEWORD'] || ENV['codeword'] || Codeword.from_config(:codeword)
   end
 
   def codeword_cookie_lifetime
     seconds = (cookie_lifetime.to_f * 1.week).to_i
-    if seconds > 0
+    if seconds.positive?
       seconds
     else
       5.years

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeword
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.beta1
 platform: ruby
 authors:
 - Dan Kim
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.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.
@@ -92,6 +92,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,6 +110,7 @@ files:
 - lib/codeword.rb
 - lib/codeword/engine.rb
 - lib/codeword/version.rb
+- screenshot.png
 - script/rails
 homepage: https://github.com/dankimio/codeword
 licenses:
@@ -132,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Lock staging servers from search engines and prying eyespec.