service-bindings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 854eab1babdfbdaa9bb34ad78194c9225b01e0e19353866228dd475fd7856f7e
+  data.tar.gz: b2215de82c6b52655358f326afc8c9fe9b88b6c91f9dcd38134fe7368ac045ed
+SHA512:
+  metadata.gz: 42acec97407aa338893b55a9e06aa56cc66de0f173b2ddbcbf3eb01e0b3d62d151306a4ac2b27c2f5997d8aa1317f520140041a9d9edc6a3a5fb51e8c39b73c3
+  data.tar.gz: d1d7bbdb50b3503f4799962a11b850436bf9af8d6ab186762c891a9d915f2bd63259f7282ea1afeb254735ed2e58d4fc3a9820aa6a79baed0769392ad219631d

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+- rubocop-minitest
+- rubocop-rake
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+  - "test/**/*_test.rb"

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in client-ruby project and our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at oss-coc@vmware.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright 2021 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+source "https://rubygems.org"
+
+ruby "~> 3.0"
+
+gemspec
+
+group :development, optional: true do
+  gem "codecov", "~> 0.4"
+  gem "minitest", "~> 5.0"
+  gem "pg", "~> 1.0"
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.7"
+  gem "rubocop-minitest", "~> 0.15"
+  gem "rubocop-rake", "~> 0.6"
+  gem "simplecov", "~> 0.21"
+end

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    service-bindings (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    docile (1.4.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pg (1.2.3)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.19.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  codecov (~> 0.4)
+  minitest (~> 5.0)
+  pg (~> 1.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-minitest (~> 0.15)
+  rubocop-rake (~> 0.6)
+  service-bindings!
+  simplecov (~> 0.21)
+
+RUBY VERSION
+   ruby 3.0.2p107
+
+BUNDLED WITH
+   2.2.26

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2021 Ben Hale
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,28 @@
+# client-ruby
+
+[![Tests](https://github.com/nebhale/client-ruby/workflows/Tests/badge.svg?branch=main)](https://github.com/nebhale/client-ruby/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/nebhale/client-ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/nebhale/client-ruby)
+
+`client-ruby` is a library to access [Service Binding Specification for Kubernetes](https://k8s-service-bindings.github.io/spec/) conformant Service Binding [Workload Projections](https://k8s-service-bindings.github.io/spec/#workload-projection).
+
+## Example
+
+```ruby
+require "bindings"
+require "pg"
+
+b = Bindings.from_service_binding_root
+b = Bindings.filter(b, "postgresql")
+raise "Incorrect number of PostgreSQL bindings: #{b.length}" if b.length != 1
+
+u = b[0].get("url")
+raise "No URL in binding" if url.nil?
+
+conn = PG.connect(u)
+
+# ...
+```
+
+## License
+
+Apache License v2.0: see [LICENSE](./LICENSE) for details.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/binding.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+# Copyright 2021 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "secret"
+
+# A library to access Service Binding Specification for Kubernetes conformant Service Binding Workload Projections.
+#
+# @see https://k8s-service-bindings.github.io/spec
+module Bindings
+  # The key for the provider of a binding
+  PROVIDER = "provider"
+
+  # The key for the type of a binding
+  TYPE = "type"
+
+  # A representation of a binding as defined by the Kubernetes Service Binding Specification:
+  # https://github.com/k8s-service-bindings/spec#workload-projection
+  module Binding
+    # Returns the contents of a binding entry in its raw bytes form.
+    #
+    # @param [String] _key the key of the entry to retrieve
+    # @return [String] the contents of a binding entry if it exists
+    # @return [nil]
+    def get_as_bytes(_key)
+      raise "unimplemented"
+    end
+
+    # Returns the name of the binding
+    #
+    # @return [String] the name of the binding
+    def name
+      raise "unimplemented"
+    end
+
+    # Returns the contents of a binding entry as a UTF-8 decoded String.  Any whitespace is trimmed.
+    #
+    # @param [String] key the key of the entry to retrieve
+    # @return [String] the contents of a binding entry as a UTF-8 decoded String if it exists
+    # @return [nil]
+    def get(key)
+      b = get_as_bytes(key)
+
+      return nil if b.nil?
+
+      b.pack("U*").strip
+    end
+
+    # Returns the value of the PROVIDER key
+    #
+    # @return [String] the value of the PROVIDER key if it exists
+    # @return [nil]
+    def provider
+      get(PROVIDER)
+    end
+
+    # Returns the value of the TYPE key.
+    #
+    # @return [String] the value of the TYPE key
+    def type
+      t = get(TYPE)
+
+      raise "binding codes not contain a type" if t.nil?
+
+      t
+    end
+  end
+
+  # An implementation of Bindings::Binding that caches values once they've been retrieved.
+  class CacheBinding
+    include Binding
+
+    # Creates a new instance.
+    #
+    # @param [Bindings::Binding] delegate the Binding used to retrieve original values
+    def initialize(delegate)
+      @delegate = delegate
+      @cache = {}
+    end
+
+    # Returns the contents of a binding entry in its raw bytes form.
+    #
+    # @param [String] key the key of the entry to retrieve
+    # @return [String] the contents of a binding entry if it exists
+    # @return [nil]
+    def get_as_bytes(key)
+      return @cache[key] if @cache.key?(key)
+
+      v = @delegate.get_as_bytes(key)
+      @cache[key] = v unless v.nil?
+
+      v
+    end
+
+    # Returns the name of the binding
+    #
+    # @return [String] the name of the binding
+    def name
+      @delegate.name
+    end
+  end
+
+  # An implementation of Bindings::Binding that reads files from a volume mounted Kubernetes Secret:
+  # https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets
+  class ConfigTreeBinding
+    include Binding
+
+    # Creates a new instance.
+    #
+    # @param [String] root the root of the volume mounted Kubernetes Secret
+    def initialize(root)
+      @root = root
+    end
+
+    # Returns the contents of a binding entry in its raw bytes form.
+    #
+    # @param [String] key the key of the entry to retrieve
+    # @return [Array<Integer>] the contents of a binding entry if it exists
+    # @return [nil]
+    def get_as_bytes(key)
+      return nil unless Bindings.valid_secret_key?(key)
+
+      p = File.join(@root, key)
+
+      return nil unless File.exist?(p) && File.file?(p)
+
+      File.read(p, mode: "rb").bytes
+    end
+
+    # Returns the name of the binding
+    #
+    # @return [String] the name of the binding
+    def name
+      File.basename(@root)
+    end
+  end
+
+  # An implementation of Bindings::Binding that returns values from a [Hash].
+  class HashBinding
+    include Binding
+
+    # @!attribute [r] name
+    #   @return [String] the name of the binding
+    attr_reader :name
+
+    # Creates a new instance.
+    #
+    # @param [String] name the name of the binding
+    # @param [Hash<String, String>] content the content of the binding
+    def initialize(name, content)
+      @name = name
+      @content = content
+    end
+
+    # Returns the contents of a binding entry in its raw bytes form.
+    #
+    # @param [String] key the key of the entry to retrieve
+    # @return [String] the contents of a binding entry if it exists
+    # @return [nil]
+    def get_as_bytes(key)
+      return nil unless Bindings.valid_secret_key?(key)
+      return nil unless @content.key?(key)
+
+      @content[key]
+    end
+  end
+end

data/lib/bindings.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Copyright 2021 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "binding"
+
+# A library to access Service Binding Specification for Kubernetes conformant Service Binding Workload Projections.
+#
+# @see https://k8s-service-bindings.github.io/spec
+module Bindings
+  # The name of the environment variable read to determine the bindings filesystem root.  Specified by the Kubernetes
+  # Service Binding Specification: https://github.com/k8s-service-bindings/spec#workload-projection
+  SERVICE_BINDING_ROOT = "SERVICE_BINDING_ROOT"
+
+  # Wraps each Bindings::Binding in a Bindings::CacheBinding.
+  #
+  # @param [Array<Bindings::Binding>] bindings the bindings to wrap
+  # @return [Array<Bindings::Binding>] the wrapped bindings
+  def self.cached(bindings)
+    bindings.map { |v| Bindings::CacheBinding.new(v) }
+  end
+
+  # Creates a new collection of Bindings::Binding's using the specified root.  If the directory does not exist, an
+  # empty collection is returned.
+  #
+  # @param [String] root the root to populate the bindings from
+  # @return [Array<Bindings::Binding>] the bindings found in the root
+  def self.from_path(root)
+    return [] unless File.exist?(root) && File.directory?(root)
+
+    Pathname.new(root).children.each_with_object([]) do |c, b|
+      b.append(ConfigTreeBinding.new(c.to_s)) if File.directory?(c)
+    end
+  end
+
+  # Creates a new collection of Bindings::Binding's using the +$SERVICE_BINDING_ROOT+ environment variable to determine
+  # system root.  If the +$SERVICE_BINDING_ROOT+ environment variable is not set, an empty collection is returned.  If
+  # the directory does not exist, an empty collection is returned.
+  #
+  # @return [Array<Bindings::Binding>] the bindings found in $SERVICE_BINDING_ROOT
+  def self.from_service_binding_root
+    return [] unless ENV.key?(SERVICE_BINDING_ROOT)
+
+    from_path(ENV[SERVICE_BINDING_ROOT])
+  end
+
+  # Returns a Bindings::Binding with a given name.  Comparison is case-insensitive.
+  #
+  # @param [Array<Bindings::Binding>] bindings the bindings to find in
+  # @param [String] name the name of the binding to find
+  # @return [Bindings::Binding] the binding with a given name if it exists
+  # @return [nil]
+  def self.find(bindings, name)
+    bindings.each do |b|
+      return b if b.name.casecmp?(name)
+    end
+
+    nil
+  end
+
+  # Returns zero or more Bindings with a given type and provider.  If type or provider are None, the result is not
+  # filter on that argument.  Comparisons are case-insensitive.
+  #
+  # @param [Array<Bindings::Binding>] bindings the bindings to filter
+  # @param [String] type the type of the binding to find
+  # @param [nil] type
+  # @param [String] provider the provider of the binding to find
+  # @param [nil] provider
+  # @return [Array<Bindings::Binding>] the collection of bindings ith a given type and provider
+  def self.filter(bindings, type = nil, provider = nil)
+    match = []
+
+    bindings.each do |b|
+      next unless type.nil? || type_matches?(b, type)
+      next unless provider.nil? || provider_matches?(b, provider)
+
+      match.append(b)
+    end
+
+    match
+  end
+
+  def self.provider_matches?(binding, provider)
+    p = binding.provider
+    !p.nil? && p.casecmp?(provider)
+  end
+
+  def self.type_matches?(binding, type)
+    t = binding.type
+    !t.nil? && t.casecmp?(type)
+  end
+
+  private_class_method :provider_matches?, :type_matches?
+end

data/lib/secret.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright 2021 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# A library to access Service Binding Specification for Kubernetes conformant Service Binding Workload Projections.
+#
+# @see https://k8s-service-bindings.github.io/spec
+module Bindings
+  # Tests whether a String is a valid Kubernetes Secret key:
+  # https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets
+  #
+  # @param [String] key the key to check
+  # @return [boolean] true if the String is a valid Kubernetes Secret key, false otherwise
+  def self.valid_secret_key?(key)
+    /^[A-Za-z0-9\-_.]+$/.match(key)
+  end
+end

data/sig/binding.rbs

@@ -0,0 +1,47 @@
+module Bindings
+  PROVIDER: String
+
+  TYPE: String
+
+  module Binding
+    def get_as_bytes: (String key) -> Array[Integer]?
+
+    def get_name: () -> String
+
+    def get: (String key) -> String?
+
+    def get_provider: () -> String?
+
+    def get_type: () -> String
+  end
+
+  class CacheBinding
+    include Binding
+
+    def initialize: (Binding delegate) -> void
+
+    def get_as_bytes: (String key) -> Array[Integer]?
+
+    def get_name: () -> String
+  end
+
+  class ConfigTreeBinding
+    include Binding
+
+    def initialize: (String root) -> void
+
+    def get_as_bytes: (String key) -> Array[Integer]?
+
+    def get_name: () -> String
+  end
+
+  class HashBinding
+    include Binding
+
+    def initialize: (String name, Hash content) -> void
+
+    def get_as_bytes: (String key) -> Array[Integer]?
+
+    def get_name: () -> String
+  end
+end

data/sig/bindings.rbs

@@ -0,0 +1,13 @@
+module Bindings
+  SERVICE_BINDING_ROOT: String
+
+  def cached: (Array[Binding] bindings) -> Array[Binding]
+
+  def from_path: (String root) -> Array[Binding]
+
+  def from_service_binding_root: () -> Array[Binding]
+
+  def find: (Array[Binding] bindings, String name) -> Binding?
+
+  def filter: (Array[Binding] bindings, String? `type`, String? provider) -> Array[Binding]
+end

data/sig/secret.rbs

@@ -0,0 +1,3 @@
+class Object
+  def valid_secret_key?: (String key) -> bool
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: service-bindings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Hale
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- nebhale@nebhale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- lib/binding.rb
+- lib/bindings.rb
+- lib/secret.rb
+- sig/binding.rbs
+- sig/bindings.rbs
+- sig/secret.rbs
+homepage: https://github.com/nebhale/client-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/nebhale/client-ruby
+  source_code_uri: https://github.com/nebhale/client-ruby.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A library to access [Service Binding Specification for Kubernetes](https://k8s-service-bindings.github.io/spec/)
+  conformant Service Binding [Workload Projections](https://k8s-service-bindings.github.io/spec/#workload-projection)
+test_files: []