rails-creds 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a713e64a2dc6c6e291bb0973929f4cb44441eb59c0d359870e0b932e5d4fcc3c
-  data.tar.gz: 483da513f4671cde3fc1e2cf83a2b04b5bc456e3fbc564079afd2085002da33b
+  metadata.gz: bc2e9f9bab0600a6bd80cb4de294fed74e0350dec39a44ece69e2f2f9cf33bb1
+  data.tar.gz: 122898482b87c4963fe814f87b5121454528ad19f2f1b0fec5add0fac7dba33b
 SHA512:
-  metadata.gz: 12c4b010d5370eaabfbafcac7c02b2bb9173b2a0e106f76523719f6c5c6fe8273b2ead284fe85ca767ff789c62e844d0f12cbc9679a05823c1343fa1c5a5fbf3
-  data.tar.gz: f3446191d7149a213fcff4277b78354a652a41166743ea341e4191bfe79e5a1bed73a5ee83bcfed8162252c5b8d204ef025a6f400d7656f5ba42bf41aa0f39f3
+  metadata.gz: 1cdb35a94bbef472049ea5aa9ea6c13d41478187e34360e22d8f15435f8d8cc342616d11861ccac3c1a9ef637ef767cee142b06344449274e680fcdbb8dc39b5
+  data.tar.gz: 8aaf493870469ed8f6578fa480def8d800214ed8740c6eac06cf6f8d2d9c53e22db161ba4643ccaa55c973607f04fcb29fd182c7cff1c659b136222352e73e04

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Tests
+on: [push]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ["3.0", "3.1", "3.2"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Changelog
+
+## 0.4.0 (2023-07-08)
+
+### Added
+
+- Return `nil` and don't read credentials nor complain when SECRET_KEY_BASE_DUMMY=1
+
 ## 0.3.0 (2019-09-19)
 
 ### Breaking changes
@@ -8,22 +16,22 @@
 
 ### Fixed:
 
-  - Require strip_heredoc extension before use
+- Require strip_heredoc extension before use
 
 ## 0.2.1
 
 ## Changed:
 
-  - Credentials are now memoized after successful read.
+- Credentials are now memoized after successful read.
 
 ## 0.2.0
 
 ### Changed:
 
-  - Creds will now warn about missing credentials when the encrypted file isn't
-    found. It will afterwards be a Null Object and return `nil` on every key.
-  - When encrypted credentials are found but the master key file AND env
-    variable is missing, Creds will return a special error with explanation.
+- Creds will now warn about missing credentials when the encrypted file isn't
+  found. It will afterwards be a Null Object and return `nil` on every key.
+- When encrypted credentials are found but the master key file AND env
+  variable is missing, Creds will return a special error with explanation.
 
 ## 0.1.0
 

data/creds.gemspec

@@ -17,14 +17,14 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
+
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "> 5.2"
+  spec.add_dependency("rails", "> 5.2")
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 0.1.0"
-end
+  spec.add_development_dependency("bundler", "~> 2.0")
+  spec.add_development_dependency("rake", "~> 12.3")
+  spec.add_development_dependency("rspec", "~> 3.0")
+end

data/lib/creds/errors.rb

@@ -2,30 +2,27 @@ require "active_support/core_ext/string/strip"
 
 class Creds
   class MissingCredentialsWarning
-    MESSAGE =
-      <<-MSG
+    MESSAGE = <<-MSG.strip_heredoc.freeze
       You have no encrypted credentials at config/credentials.yml.enc.
       Creds will return nil for any key.
       Run this to generate your credentials file:
         $ bin/rails credentials:edit
-      MSG
-        .strip_heredoc.freeze
+    MSG
   end
 
   # @api private
   class MissingKeyError < StandardError
-    MESSAGE = 'Key :%<key>s missing from credentials in "%<env>s" env'.freeze
+    MESSAGE = "Key :%<key>s missing from credentials in \"%<env>s\" env".freeze
 
     def initialize(key, env)
-      super format(MESSAGE, key: key, env: env)
+      super(format(MESSAGE, key: key, env: env))
     end
   end
 
   # @api private
   class MissingEnvError < StandardError
     # rubocop:disable Layout/TrailingWhitespace
-    MESSAGE =
-      <<-MSG
+    MESSAGE = <<-MSG.strip_heredoc.freeze
   Creds scopes credentials to the current Rails environment.
   It seems you are missing a scope for the environment "%<env>s".
 
@@ -33,29 +30,26 @@ class Creds
 
   ---
   aws_key: 'shared between environments'
-  
+
   production:
     <<: *default
     aws_key: 'you can override defaults for individual environments'
-      MSG
-        .strip_heredoc.freeze
+    MSG
     # rubocop:enable Layout/TrailingWhitespace
 
     def initialize(env)
-      super format(MESSAGE, env: env)
+      super(format(MESSAGE, env: env))
     end
   end
 
   # @api private
   class MissingMasterKeyError < StandardError
-    MESSAGE =
-      <<-MSG
+    MESSAGE = <<-MSG.strip_heredoc.freeze
         You have encrypted credentials but no master key.
 
         Either get or recover the file config/master.key
         or set the environment variable RAILS_MASTER_KEY
-      MSG
-        .strip_heredoc.freeze
+    MSG
 
     def initalize
       super(MESSAGE)

data/lib/creds/version.rb

@@ -1,3 +1,3 @@
 class Creds
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/creds.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "rails"
 
 require "creds/version"
@@ -15,11 +13,9 @@ class Creds
       true
     end
 
-    # rubocop:disable Style/MethodMissingSuper
     def method_missing(*_args)
       nil
     end
-    # rubocop:enable Style/MethodMissingSuper
 
     def nil?
       true
@@ -30,13 +26,11 @@ class Creds
     true
   end
 
-  # rubocop:disable Style/MethodMissingSuper
   def self.method_missing(name, *_args)
     instance.credentials.fetch(name)
   rescue KeyError
     raise MissingKeyError.new(name, Rails.env)
   end
-  # rubocop:enable Style/MethodMissingSuper
 
   def self.to_h
     instance.credentials
@@ -45,9 +39,15 @@ class Creds
   def credentials
     return @credentials if @credentials
 
+    if dummy?
+      @credentials = NullCredentials.new
+      return @credentials
+    end
+
     unless encrypted_credentials_exist?
-      Rails.logger.warn MissingCredentialsWarning
-      return NullCredentials.new
+      Rails.logger.warn(MissingCredentialsWarning)
+      @credentials = NullCredentials.new
+      return @credentials
     end
 
     raise MissingMasterKeyError unless master_key_present?
@@ -67,13 +67,18 @@ class Creds
   end
 
   def encrypted_credentials_exist?
-    File.exist? Rails.root.join("config", "credentials.yml.enc")
+    File.exist?(Rails.root.join("config", "credentials.yml.enc"))
   end
 
   def master_key_present?
+    return true unless Rails.application.config.require_master_key
     return true if ENV["RAILS_MASTER_KEY"]
     return true if File.exist?(Rails.root.join("config", "master.key"))
 
     false
   end
+
+  def dummy?
+    ENV.fetch("SECRET_KEY_BASE_DUMMY", nil) == "1"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-creds
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mikkel Malmberg
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
 description: ''
 email:
 - mikkel@brnbw.com
@@ -87,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -102,12 +88,13 @@ files:
 - lib/creds/errors.rb
 - lib/creds/version.rb
 - lib/rails-creds.rb
+- log/test.log
 homepage: https://github.com/mikker/rails-creds
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/mikker/rails-creds
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.15
+signing_key:
 specification_version: 4
 summary: Shorter, env-scoped version of Rails' credentials
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - jruby
-before_install:
-  - gem update --system
-  - gem install bundler