codeword 0.1.1 → 0.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0df77c174f33909ed5e7f6b4168485dea5e4888098f2ca4c41c576b60b4da44a
-  data.tar.gz: f0d1971d5214427371119fac86d8c63e0e40b76a23682a3cd766029e7e275460
+  metadata.gz: 20a9e39af2e13a2e11bbc41e27257d98c9c2e35b1a4b63580be50456aec8b8b7
+  data.tar.gz: ae29b06372954d34efb4aec5a71d76fda264ab346f8d2c1ca63935991ead2c77
 SHA512:
-  metadata.gz: b833d1f568e8c6e1b138b42ec0b80c2645c4def43e22b3b362fa0078d285f50a0c84efe571bd213fc81e87a666f0d0dc15a6c9a69e0e94360ec85f033b47a94b
-  data.tar.gz: 892591cc8b6feecccee50e0b6e084fb01f3f991f2eb21d23cef9f20a3177d517854964911c9eda0b79f7196cc76573732e01c39ee372719544a9030f5c0c11cc
+  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

@@ -1,5 +1,8 @@
 ## [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

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. This is a fork of [lockup](https://github.com/interdiscipline/lockup).
+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
@@ -100,10 +95,6 @@ If you would like to change the content or design of the codeword page, you can
 
 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).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/dankimio/codeword.
-
-## License
+## Acknowledgements
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Codeword is a fork of [lockup](https://github.com/interdiscipline/lockup).

data/app/controllers/codeword/codeword_controller.rb

@@ -6,7 +6,7 @@ module Codeword
 
     def unlock
       user_agent = request.env['HTTP_USER_AGENT'].presence
-      if user_agent && user_agent.downcase.match(CRAWLER_REGEX)
+      if user_agent&.downcase&.match(CRAWLER_REGEX)
         head :ok
         return
       end

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/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/version.rb

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

data/lib/codeword.rb

@@ -9,10 +9,8 @@ module Codeword
     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}")) ||
@@ -35,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_code ||=
-      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.1
+  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.
@@ -110,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:
@@ -133,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.