kreds 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f6ab3b6f9ddb0cb9a04d9b9bd802b8cce3ed6498fd07046fa2ad42684402c5
-  data.tar.gz: b94371b06a5786c60f7bb92b147ad67b48ac0ddede98a8211a51d57d08256c3b
+  metadata.gz: de9b5e5f467bfe86da6487a402620213b7108dbcd90d64a5c088e8f563dc466e
+  data.tar.gz: c147c37a7ca2ea09f166022b0ffb294c5f452a33392a8d15edfe07ed30167a40
 SHA512:
-  metadata.gz: 693e1d768edaa7867809efe75f5f10b349e755b181859740c3c0d19fae62e491ad60f7c703a1d8e05e4b455e2132391a439fbb2668b0892007646e050f3c18b0
-  data.tar.gz: fa4330a91248bc4bf1c6dff36995d74cbad6f1254be6b55b02f9185a8ceb6e839d1e1fbe26d262bd4dc7c3fb5564a3dac51f0309b206cf24d69e56f880f7f6c9
+  metadata.gz: 164bdf54d2f0ec9037cc568c6749bd22fdca2fed40388a74f9a35a8954cf34cc74697efdb2516fa57c34966c194f9d65c466c0a447f6ca4489504c1d3c913bb3
+  data.tar.gz: 90850b11cbe6f9890dd7e60752251af0f3e323cf7c87a460677fef764a80421690d9de2979fd0e0761ffd29295fc686501385fd8e911bd6c35af8aaad51b8383

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v1.1.0
+
+- Added block support for fallback behavior in all fetching methods
+
+## v1.0.0
+
+- Dropped support for Rails 7.0
+- Dropped support for Ruby 3.1
+- Replaced `Kreds::BlankValueError` and `Kreds::UnknownKeyError` with `Kreds::BlankCredentialsError` and `Kreds::UnknownCredentialsError`, respectively
+- Added optional fallback to environment variables for `Kreds.fetch!` method
+- Added shortcut method `Kreds.var!` for fetching values directly from environment variables
+- Added `Kreds.env_fetch!` method for fetching values from credentials per Rails environment
+- Added `Kreds.show` method for displaying all credentials as a hash
+
 ## v0.1.0
 
 - Initial release

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/kreds.svg)](http://badge.fury.io/rb/kreds)
 [![Github Actions badge](https://github.com/enjaku4/kreds/actions/workflows/ci.yml/badge.svg)](https://github.com/enjaku4/kreds/actions/workflows/ci.yml)
 
-Kreds is a simpler and shorter way to access Rails credentials — with safety built in. Rails credentials are a convenient way to store secrets, but retrieving them could be more intuitive. That’s where Kreds comes in.
+Kreds is a simpler, shorter, and safer way to access Rails credentials, with a few additional features built in. Rails credentials are a convenient way to store secrets, but retrieving them could be more intuitive — that’s where Kreds comes in.
 
 Instead of writing:
 
@@ -17,7 +17,7 @@ You can simply use:
 Kreds.fetch!(:recaptcha, :site_key)
 ```
 
-This not only shortens your code but also ensures an exception is raised if a key is missing or a value is blank, with a clear, human-readable error message.
+This not only shortens your code but also ensures an exception is raised if a key is missing or a value is blank — with a clear, human-readable error message.
 
 ## Installation
 
@@ -35,17 +35,77 @@ bundle install
 
 ## Usage
 
-Kreds provides a single method `.fetch!(*keys)`:
+### Fetch from credentials
 
 ```ruby
 Kreds.fetch!(:aws, :s3, :credentials, :access_key_id)
 ```
 
-If you make a typo, such as writing `access_key` instead of `access_key_id`, Kreds will raise `Kreds::UnknownKeyError` with the message: `Key not found: [:aws][:s3][:credentials][:access_key]`. The same applies to any incorrect key in the path.
+If you make a typo, such as writing `access_key` instead of `access_key_id`, Kreds will raise `Kreds::UnknownCredentialsError` with the message: `Credentials key not found: [:aws][:s3][:credentials][:access_key]`.
 
-Similarly, if you add an extra key that doesn’t exist, such as: `Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, :id)`, Kreds will raise `Kreds::UnknownKeyError` with the message: `Key not found: [:aws][:s3][:credentials][:access_key_id][:id]`.
+Similarly, if you add an extra key that doesn’t exist: `Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, :id)`, Kreds will raise `Kreds::UnknownCredentialsError` with the message: `Credentials key not found: [:aws][:s3][:credentials][:access_key_id][:id]`.
 
-Kreds also ensures that values are not left blank. For example, if all keys are correct but the value for `access_key_id` is empty, Kreds will raise `Kreds::BlankValueError` with the message: `Blank value for: [:aws][:s3][:credentials][:access_key_id]`.
+If all keys are correct but the value is blank, Kreds will raise `Kreds::BlankCredentialsError` with the message: `Blank value in credentials: [:aws][:s3][:credentials][:access_key_id]`.
+
+### Fallback to environment variables
+
+You can optionally provide a fallback environment variable:
+
+```ruby
+Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, var: "AWS_ACCESS_KEY_ID")
+```
+
+If the key is missing or blank in credentials, Kreds will attempt to fetch the value from the specified environment variable.
+
+If both sources are missing or blank, a combined error is raised.
+
+### Directly fetch from environment variable
+
+You can also fetch directly from an environment variable:
+
+```ruby
+Kreds.var!("AWS_ACCESS_KEY_ID")
+```
+
+This raises `Kreds::UnknownEnvironmentVariableError` if the variable is missing, and `Kreds::BlankEnvironmentVariableError` if it is present but the value is blank.
+
+### Fetch per Rails environment
+
+If your credentials are scoped by Rails environment (e.g., `:production`, `:staging`, `:development`), you can fetch keys under the current environment using:
+
+```ruby
+Kreds.env_fetch!(:recaptcha, :site_key)
+```
+
+This will look for the key in `Rails.application.credentials[Rails.env]`. For example, in the `production` environment, it will look for `Rails.application.credentials[:production][:recaptcha][:site_key]`, and raise the same errors if the key is missing or the value is blank.
+
+You can also provide an optional fallback environment variable:
+
+```ruby
+Kreds.env_fetch!(:recaptcha, :site_key, var: "RECAPTCHA_SITE_KEY")
+```
+
+### Pass a block on failure
+
+You can pass a block to `fetch!`, `env_fetch!`, and `var!`, which will be executed if the method fails to retrieve the value.
+
+```ruby
+Kreds.fetch!(:aws, :s3, :credentials, :access_key_id) do
+  raise MyCustomError, "Custom error message"
+end
+
+Kreds.var!("THREADS") { 1 }
+```
+
+### Show credentials
+
+To inspect all credentials as a hash:
+
+```ruby
+Kreds.show
+```
+
+Useful for debugging or working in the Rails console.
 
 ## Problems?
 

data/kreds.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.summary = "The missing shorthand for Rails credentials"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1", "< 3.5"
+  spec.required_ruby_version = ">= 3.2", "< 3.5"
 
   spec.files = [
     "kreds.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"
@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 7.0", "< 8.1"
+  spec.add_dependency "rails", ">= 7.1", "< 8.1"
 end

data/lib/kreds/fetch.rb

@@ -1,20 +1,82 @@
 module Kreds
   module Fetch
-    def fetch!(*keys)
+    def fetch!(*keys, var: nil, &)
+      validate_keys!(keys)
+      validate_var!(var)
+
       path = []
 
       keys.reduce(Rails.application.credentials) do |hash, key|
         path << key
+        fetch_key(hash, key, path, keys)
+      end
+    rescue Kreds::BlankCredentialsError, Kreds::UnknownCredentialsError => e
+      fallback_to_var(e, var, &)
+    end
+
+    def env_fetch!(*keys, var: nil, &)
+      fetch!(Rails.env, *keys, var: var, &)
+    end
+
+    def var!(var, &)
+      validate_var!(var)
 
-        result = hash.fetch(key)
+      result, success = check_var(var)
 
-        raise(BlankValueError, "Blank value for: [:#{path.join("][:")}]") if result.blank?
-        raise(UnknownKeyError, "Key not found: [:#{path.join("][:")}][:#{keys[path.size]}]") if !result.is_a?(Hash) && keys != path
+      return result if success
+
+      raise_or_yield(result, &)
+    end
+
+    private
+
+    def validate_keys!(keys)
+      raise Kreds::InvalidArgumentError, "No keys provided" if keys.empty?
+
+      return if keys.all? { _1.is_a?(Symbol) || _1.is_a?(String) }
+
+      raise Kreds::InvalidArgumentError, "Credentials Key must be a Symbol or a String"
+    end
+
+    def validate_var!(var)
+      raise Kreds::InvalidArgumentError, "Environment variable must be a String" if var.present? && !var.is_a?(String)
+    end
 
-        result
+    def fetch_key(hash, key, path, keys)
+      value = hash.fetch(key.to_sym)
+
+      raise Kreds::BlankCredentialsError, "Blank value in credentials: [:#{path.join("][:")}]" if value.blank?
+      raise Kreds::UnknownCredentialsError, "Credentials key not found: [:#{path.join("][:")}][:#{keys[path.size]}]" if !value.is_a?(Hash) && keys != path
+
+      value
+    rescue KeyError
+      raise Kreds::UnknownCredentialsError, "Credentials key not found: [:#{path.join("][:")}]"
+    end
+
+    def fallback_to_var(error, var, &)
+      if var.present?
+        result, success = check_var(var)
+
+        return result if success
+
+        raise_or_yield(Kreds::Error.new([error.message, result.message].join(", ")), &)
       end
+
+      raise_or_yield(error, &)
+    end
+
+    def check_var(var)
+      value = ENV.fetch(var)
+
+      return [Kreds::BlankEnvironmentVariableError.new("Blank value in environment variable: #{var.inspect}"), false] if value.blank?
+
+      [value, true]
     rescue KeyError
-      raise UnknownKeyError, "Key not found: [:#{path.join("][:")}]"
+      [Kreds::UnknownEnvironmentVariableError.new("Environment variable not found: #{var.inspect}"), false]
+    end
+
+    def raise_or_yield(error, &)
+      block_given? ? yield : raise(error)
     end
   end
 end

data/lib/kreds/show.rb

@@ -0,0 +1,7 @@
+module Kreds
+  module Show
+    def show
+      Rails.application.credentials.as_json.deep_symbolize_keys
+    end
+  end
+end

data/lib/kreds/version.rb

@@ -1,3 +1,3 @@
 module Kreds
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/lib/kreds.rb

@@ -3,12 +3,16 @@ require_relative "kreds/version"
 require "rails"
 
 require_relative "kreds/fetch"
+require_relative "kreds/show"
 
 module Kreds
   class Error < StandardError; end
-
-  class UnknownKeyError < Error; end
-  class BlankValueError < Error; end
+  class InvalidArgumentError < Error; end
+  class BlankCredentialsError < Error; end
+  class BlankEnvironmentVariableError < Error; end
+  class UnknownCredentialsError < Error; end
+  class UnknownEnvironmentVariableError < Error; end
 
   extend ::Kreds::Fetch
+  extend ::Kreds::Show
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: kreds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - enjaku4
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -39,6 +39,7 @@ files:
 - kreds.gemspec
 - lib/kreds.rb
 - lib/kreds/fetch.rb
+- lib/kreds/show.rb
 - lib/kreds/version.rb
 homepage: https://github.com/enjaku4/kreds
 licenses:
@@ -55,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
       version: '3.5'
@@ -65,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: The missing shorthand for Rails credentials
 test_files: []