kreds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13f6ab3b6f9ddb0cb9a04d9b9bd802b8cce3ed6498fd07046fa2ad42684402c5
+  data.tar.gz: b94371b06a5786c60f7bb92b147ad67b48ac0ddede98a8211a51d57d08256c3b
+SHA512:
+  metadata.gz: 693e1d768edaa7867809efe75f5f10b349e755b181859740c3c0d19fae62e491ad60f7c703a1d8e05e4b455e2132391a439fbb2668b0892007646e050f3c18b0
+  data.tar.gz: fa4330a91248bc4bf1c6dff36995d74cbad6f1254be6b55b02f9185a8ceb6e839d1e1fbe26d262bd4dc7c3fb5564a3dac51f0309b206cf24d69e56f880f7f6c9

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 enjaku4 (https://github.com/enjaku4)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# 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)
+
+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.
+
+Instead of writing:
+
+```ruby
+Rails.application.credentials[:recaptcha][:site_key]
+```
+
+You can simply use:
+
+```ruby
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "kreds"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+Kreds provides a single method `.fetch!(*keys)`:
+
+```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.
+
+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]`.
+
+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]`.
+
+## Problems?
+
+Facing a problem or want to suggest an enhancement?
+
+- **Open a Discussion**: If you have a question, experience difficulties using the gem, or have a suggestion for improvements, feel free to use the Discussions section.
+
+Encountered a bug?
+
+- **Create an Issue**: If you've identified a bug, please create an issue. Be sure to provide detailed information about the problem, including the steps to reproduce it.
+- **Contribute a Solution**: Found a fix for the issue? Feel free to create a pull request with your changes.
+
+## Contributing
+
+Before creating an issue or a pull request, please read the [contributing guidelines](https://github.com/enjaku4/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).
+
+## 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).

data/kreds.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/kreds/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "kreds"
+  spec.version = Kreds::VERSION
+  spec.authors = ["enjaku4"]
+  spec.homepage = "https://github.com/enjaku4/kreds"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  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.files = [
+    "kreds.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"
+  ] + Dir.glob("lib/**/*")
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 7.0", "< 8.1"
+end

data/lib/kreds/fetch.rb

@@ -0,0 +1,20 @@
+module Kreds
+  module Fetch
+    def fetch!(*keys)
+      path = []
+
+      keys.reduce(Rails.application.credentials) do |hash, key|
+        path << key
+
+        result = hash.fetch(key)
+
+        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
+
+        result
+      end
+    rescue KeyError
+      raise UnknownKeyError, "Key not found: [:#{path.join("][:")}]"
+    end
+  end
+end

data/lib/kreds/version.rb

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

data/lib/kreds.rb

@@ -0,0 +1,14 @@
+require_relative "kreds/version"
+
+require "rails"
+
+require_relative "kreds/fetch"
+
+module Kreds
+  class Error < StandardError; end
+
+  class UnknownKeyError < Error; end
+  class BlankValueError < Error; end
+
+  extend ::Kreds::Fetch
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: kreds
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- enjaku4
+bindir: bin
+cert_chain: []
+date: 2025-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- kreds.gemspec
+- lib/kreds.rb
+- lib/kreds/fetch.rb
+- lib/kreds/version.rb
+homepage: https://github.com/enjaku4/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
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: The missing shorthand for Rails credentials
+test_files: []