kreds 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd360d0e070613f6faa2659de2f39cd477f4e4f4e9b2b8b040698ad6569b7b19
-  data.tar.gz: 6a8d3d9693fe0d81a8fa44495db0e147704f9db807620f83716166579d7a17c0
+  metadata.gz: 4fa30f22ae5af3cd8d3cfbc20b59eacabe4c2b79db4033feca2e4e89740d27aa
+  data.tar.gz: 42a758a1e6b4c04d3a87f2d3320da866d6bda9355119cbcda77cee5d1e36881e
 SHA512:
-  metadata.gz: f97393f35e509b0c25ed21edcbb412ccf15dee7afc06542fc81d166d14a227d6255be674bc7463bb4cd6bcb8f7d163ce645ae808e7ad5ce1657f3bc33bb45e71
-  data.tar.gz: f8ea75d9b59928922488e95a49d7a0de81e61ac2aaf412384727644844623174a8b628f539bcf9a685889e20ae18ebfea4c213db12d83e0bf0a7eb43f3d30c39
+  metadata.gz: 0c406cca1bd875a184c0a0c2dc00e8d42865ae62eae6e5d820a344e06873ef399e1f7455239f3918c5a4ed75cec32a8c77c2c1597a54c3b36f6674d1e181a7af
+  data.tar.gz: 8ddcfa759c8b22eaebfe5ffc55bdac6ba63bebb316faa1dc18609a5eabf6c7e35531a76c6399f8ecee9fe0e6f8c67753885beb57ffbe3e115bf9b5d8417d1164

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v1.1.1
+
+- Updated gemspec metadata to include the correct homepage URL
+
+## v1.1.0
+
+- Added block support for fallback behavior in all fetching methods
+
 ## v1.0.0
 
 - Dropped support for Rails 7.0

data/README.md

@@ -1,7 +1,7 @@
 # Kreds
 
 [![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)
+[![Github Actions badge](https://github.com/brownboxdev/kreds/actions/workflows/ci.yml/badge.svg)](https://github.com/brownboxdev/kreds/actions/workflows/ci.yml)
 
 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.
 
@@ -52,7 +52,7 @@ If all keys are correct but the value is blank, Kreds will raise `Kreds::BlankCr
 You can optionally provide a fallback environment variable:
 
 ```ruby
-Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, env_var: "AWS_ACCESS_KEY_ID")
+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.
@@ -85,6 +85,18 @@ You can also provide an optional fallback environment variable:
 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:
@@ -108,12 +120,12 @@ Encountered a bug?
 
 ## Contributing
 
-Before creating an issue or a pull request, please read the [contributing guidelines](https://github.com/enjaku4/kreds/blob/master/CONTRIBUTING.md).
+Before creating an issue or a pull request, please read the [contributing guidelines](https://github.com/brownboxdev/kreds/blob/master/CONTRIBUTING.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://github.com/enjaku4/kreds/blob/master/LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](https://github.com/brownboxdev/kreds/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Kreds project is expected to follow the [code of conduct](https://github.com/enjaku4/kreds/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Kreds project is expected to follow the [code of conduct](https://github.com/brownboxdev/kreds/blob/master/CODE_OF_CONDUCT.md).

data/kreds.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = "kreds"
   spec.version = Kreds::VERSION
   spec.authors = ["enjaku4"]
-  spec.homepage = "https://github.com/enjaku4/kreds"
+  spec.homepage = "https://github.com/brownboxdev/kreds"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"

data/lib/kreds/fetch.rb

@@ -1,6 +1,6 @@
 module Kreds
   module Fetch
-    def fetch!(*keys, var: nil)
+    def fetch!(*keys, var: nil, &)
       validate_keys!(keys)
       validate_var!(var)
 
@@ -11,18 +11,21 @@ module Kreds
         fetch_key(hash, key, path, keys)
       end
     rescue Kreds::BlankCredentialsError, Kreds::UnknownCredentialsError => e
-      fallback_to_var(e, var)
+      fallback_to_var(e, var, &)
     end
 
-    def env_fetch!(*keys, var: nil)
-      fetch!(Rails.env, *keys, var: var)
+    def env_fetch!(*keys, var: nil, &)
+      fetch!(Rails.env, *keys, var: var, &)
     end
 
-    def var!(var)
+    def var!(var, &)
       validate_var!(var)
 
       result, success = check_var(var)
-      success ? result : raise(result)
+
+      return result if success
+
+      raise_or_yield(result, &)
     end
 
     private
@@ -50,11 +53,16 @@ module Kreds
       raise Kreds::UnknownCredentialsError, "Credentials key not found: [:#{path.join("][:")}]"
     end
 
-    def fallback_to_var(error, var)
-      return raise error if var.blank?
+    def fallback_to_var(error, var, &)
+      if var.present?
+        result, success = check_var(var)
 
-      result, success = check_var(var)
-      success ? result : raise(Kreds::Error, [error.message, result.message].join(", "))
+        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)
@@ -66,5 +74,9 @@ module Kreds
     rescue KeyError
       [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/version.rb

@@ -1,3 +1,3 @@
 module Kreds
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kreds
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - enjaku4
@@ -41,13 +41,13 @@ files:
 - lib/kreds/fetch.rb
 - lib/kreds/show.rb
 - lib/kreds/version.rb
-homepage: https://github.com/enjaku4/kreds
+homepage: https://github.com/brownboxdev/kreds
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/enjaku4/kreds
-  source_code_uri: https://github.com/enjaku4/kreds
-  changelog_uri: https://github.com/enjaku4/kreds/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/brownboxdev/kreds
+  source_code_uri: https://github.com/brownboxdev/kreds
+  changelog_uri: https://github.com/brownboxdev/kreds/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: