vault_ruby_client 0.18.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb2a20987a39d207d4b1080bd4631a940b1be8261b7cd0bfbc3c51579a476a1
-  data.tar.gz: 38ebaf464ad1ba4fda63274d19acee366fcc1324a5b2be78722d2a7a57967891
+  metadata.gz: 1326e9af43dc41b393da2221ef93be5fd2372e0207825646cd7ab568f7e9e94c
+  data.tar.gz: 700110ff9ab0f6ab2977f24072995048d541049de0cdcd47787d4482fa5a6817
 SHA512:
-  metadata.gz: a1548a0313eb3d48c0991e6c29d2a1378a907b86d7dfd4749fd1bb325124afb6e01a811818e735af2897eacfba541787af4297edb5e38ddf8f0ca5eca040c1eb
-  data.tar.gz: b6051a92669dbbd3da23d091c5ad595be025d5656db7ab7f25d485fc74834105230748d8e8d01e8b234dc0747e04cadad47eaa135e8f9e0325834926a6c6f7f1
+  metadata.gz: 0d81abee3a49207e5b20c27072791774b84dc229ed3e00f47d7c8c6602bef1a647eea51211e3cfe312172a1e919613b31970f8bb035689a0918f47f41bf98c3a
+  data.tar.gz: ecb8866a0f2b2ab13b1568c0ff65be47a87dd8b298f6b778867103f40f6cf3a784b150490ba2e83084c6305d9edfae11353a688022606d285622820077fb42c3

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+name: Ruby
+on:
+  push:
+    paths-ignore:
+      - 'README.md'
+      - 'CHANGELOG.md'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'README.md'
+      - 'CHANGELOG.md'
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # https://endoflife.date/ruby
+        ruby: ['2.7', '3.0', '3.1', '3.2']
+        vault: ['1.13.13', '1.15.5', '1.17.6']
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: "Install vault cli"
+        run: |
+          curl -sLo vault.zip "https://releases.hashicorp.com/vault/${{ matrix.vault }}/vault_${{ matrix.vault }}_linux_amd64.zip"
+          unzip vault.zip
+          mkdir -p "$HOME/bin"
+          mv vault "$HOME/bin"
+          echo "$HOME/bin" >> "$GITHUB_PATH"
+      - run: bundle exec rake
+      - name: Publish code coverage
+        if: ${{ success() && env.CC_TEST_REPORTER_ID }}
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+
+permissions:
+  contents: read

data/.gitignore

@@ -0,0 +1,43 @@
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/.vscode
+/.idea
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/vendor/bundle/
+/vendor/ruby/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Project-specific
+spec/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -1,287 +1,9 @@
 # Vault Ruby Changelog
 
-## v?.??.? (Unreleased)
+## Unreleased
 
-## v0.18.1 (September 14, 2023)
+No changes.
 
-BUG FIXES
-
-- Restored the ability to use this gem with older Ruby versions that do not have
-  the `OpenSSL::SSL::TLS1_2_VERSION` constant.
-
-## v0.18.0 (September 14, 2023)
-
-IMPROVEMENTS
-
-- Added support for TLS v1.3 by replacing `ssl_version` with `min_version`.
-
-## v0.17.0 (May 11, 2022)
-
-IMPROVEMENTS
-
-- Added MissingRequiredStateErr error type to refer to 412s returned by Vault 1.10 when the WAL index on the node does not match the index in the Server-Side Consistent Token. This error type can be passed as a parameter to `#with_retries`, and will also be retried automatically when `#with_retries` is used with no parameters.
-
-## v0.16.0 (March 17, 2021)
-
-IMPROVEMENTS
-
-- The timeout used to get a connection from the connection pool that talks with vault is now configurable. Using `Vault.pool_timeout` or the env var `VAULT_POOL_TIMEOUT`.
-
-## v0.15.0 (July 29, 2020)
-
-IMPROVEMENTS
-
-- Added support for Resource Quotas
-
-## v0.14.0 (May 28, 2020)
-
-IMPROVEMENTS
-
-- Added support for the Transform Secrets Engine
-
-## v0.13.2 (May 7, 2020)
-
-BUG FIXES
-
-- Fixed the ability to use namespace as an option for each request. Previously, that option was ignored.
-- aws-sigv4 gem was unlocked after a bug in 1.1.2 broke CI
-
-## v0.13.1 (April 28, 2020)
-
-IMPROVEMENTS
-
-- Added support for defining a namespace when initializing the client, as well as options for changing the namespace via method.
-- Added support for sys/namespaces API. Ability to Get, Create, Delete, and List namespaces has been provided.
-
-## v0.13.0 (October 1, 2019)
-
-IMPROVEMENTS
-
-- Add support for versioned KV secrets in the client
-
-## v0.12.0 (August 14, 2018)
-
-IMPROVEMENTS
-
-- Expose the github login path as an optional argument
-- Support HTTP basic auth [GH-181]
-- Expose the AWS IAM path to use [GH-180]
-- Add GCP Auth [GH-173]
-- Add shutdown functionality to close persistent connections [GH-175]
-
-BUG FIXES
-
-- Specifing the hostname for SNI didn't work. The functionality has been disabled for now.
-
-## v0.11.0 (March 19, 2018)
-
-IMPROVEMENTS
-
-- Access to health has been added.
-- Added ability to handle a Base64 encoded PEM (useful for certs in environment variables)
-- Added IAM EC2 authentication support
-- Add custom mount path support to TLS authentication
-
-## v0.10.1 (May 8, 2017)
-
-IMPROVEMENTS
-
-- `vault-ruby` is licensed under Mozilla Public License 2.0, and has been for over 2 years. This patch release updates the gemspec to use the correct SPDX ID string for reporting this license, but **no change to the licensing of this gem has occurred**.
-
-
-## v0.10.0 (April 19, 2017)
-
-IMPROVEMENTS
-
-- `#with_retries` now defaults to checking `HTTPServerError` if called without
-  an error classes
-
-BUG FIXES
-
-- Don't randomly fail when parsing with Time.parse [GH-140]
-
-
-## v0.9.0 (March 10, 2017)
-
-IMPROVEMENTS
-
-- The pool size used to talk with vault is now configurable. Using `Vault.pool_size` or the env var `VAULT_POOL_SIZE`.
-
-## v0.8.0 (March 3, 2017)
-
-BREAKING CHANGES
-
-- Use PUT/POST for all functions that involve tokens [GH-117]. For Vault 0.6+,
-  this will work as-expected. For older Vault versions, you will need to use an
-  older client library which uses the URL instead. This is deprecated in Vault
-  because the URL would include the token, thus revealing it in request logs.
-  These new methods place the token in the body instead.
-
-BUG FIXES
-
-- Do not convert arrays in `#to_h` [GH-125]
-- Prevent mismatched checkout/checkin from the connection pool; this will avoid masking errors that occur on pool checkout.
-
-IMPROVEMENTS
-
-- Support new init API options [GH-127]
-- Return base64-encoded keys in init response [GH-128]
-- Add support for `#hostname` for specifying SNI hostname to validate [GH-112]
-
-## v0.7.3 (October 25, 2016)
-
-BUG FIXES
-
-- Allow options to be set on `Vault` as well as any `Vault::Client`
-  instance to be used properly.
-- Remove Ruby 2.0 syntax in favor of Ruby 1.9
-
-## v0.7.2 (October 24, 2016)
-
-BUG FIXES
-
-- Set the default pool size to 16 rather than calculating from
-  the number of available file descriptors.
-
-## v0.7.1 (October 21, 2016)
-
-BUG FIXES
-
-- Properly vendor Net::HTTP::Persistent so that it doesn't collide
-  with net-http-persistent
-- Fix behavior where `verify_mode` was forced to `VERIFY_PEER`
-  if a custom CA was set
-
-## v0.7.0 (October 18, 2016)
-
-DEPRECATIONS
-
-- Vault versions older than 0.5.3 are no longer tested
-
-NEW FEATURES
-
-- Add support for AppRole
-- Expose the auth/tune API
-- Add support for leader step down
-- Use persistent connections to Vault to speed up requests
-- Add support for a custom ssl certificate store
-
-BUG FIXES
-
-- Allow for spaces in secret names properly
-
-## v0.6.0 (August 30, 2016)
-
-NEW FEATURES
-
-- Add support for Vault 0.6.1 APIs
-- Add new token `accessors` API method
-- Add TLS authentication endpoints
-
-BUG FIXES
-
-- Restore old `to_h` behavior on response objects
-
-IMPROVEMENTS
-
-- Bootstrap full testing harness against old Vault versions
-
-## v0.5.0 (August 16, 2016)
-
-NEW FEATURES
-
-- Add TTL wrapping to logical and auth backends
-- Support passing PGP keys to init
-
-BUG FIXES
-
-- New API documentation
-- Remove recursive requires
-
-## v0.4.0 (March 31, 2016)
-
-NEW FEATURES
-
-- Add LDAP authentication method [GH-61]
-- Add GitHub authentication method [GH-37]
-- Add `create_orphan` method [GH-65]
-- Add `lookup` and `lookup_self` for tokens
-- Accept `VAULT_SKIP_VERIFY` environment variable [GH-66]
-
-BUG FIXES
-
-- Prefer `VAULT_TOKEN` environment variable over disk to mirror Vault's own
-  behavior [GH-98]
-- Do not duplicate query parameters on HEAD/GET requests [GH-62]
-- Yield exception in `with_retries` [GH-68]
-
-## v0.3.0 (February 16, 2016)
-
-NEW FEATURES
-
-- Add API for `renew_self`
-- Add API for `revoke_self`
-- Add API for listing secrets where supported
-
-BUG FIXES
-
-- Relax bundler constraint
-- Fix race conditions on Ruby 2.3
-- Escape path params before posting to Vault
-
-## v0.2.0 (December 2, 2015)
-
-IMPROVEMENTS
-
-- Add support for retries (clients must opt-in) [GH-47]
-
-BUG FIXES
-
-- Fix redirection on POST/PUT [GH-40]
-- Use `$HOME` instead of `~` for shell expansion
-
-## v0.1.5 (September 1, 2015)
-
-IMPROVEMENTS
-
-- Use headers instead of cookies for authenticating to Vault [GH-36]
-
-BUG FIXES
-
-- Do not set undefined OpenSSL options
-- Add `ssl_pem_passphrase` as a configuration option [GH-35]
-
-## v0.1.4 (August 15, 2015)
-
-IMPROVEMENTS
-
-- Add support for using a custom CA cert [GH-8]
-- Allow clients to specify timeouts [GH-12, GH-14]
-- Show which error caused the HTTPConnectionError [GH-30]
-- Allow clients to specify which SSL cipher suites to use [GH-29]
-- Allow clients to specify the SSL pem password [GH-22, GH-31]
-
-BUG FIXES
-
-- Read local token (`~/.vault-token`) for token if present [GH-13]
-- Disable bad SSL cipher suites and force TLSv1.2 [GH-16]
-- Update to test against Vault 0.2.0 [GH-20]
-- Do not attempt a read on logical path write [GH-11, GH-32]
-
-## v0.1.3 (May 14, 2015)
-
-BUG FIXES
-
-- Decode logical response body if present
-
-## v0.1.2 (May 3, 2015)
-
-BUG FIXES
-
-- Require vault/version before accessing Vault::VERSION in the client
-- Improve Travis CI test coverage
-- README and typo fixes
-
-## v0.1.1 (April 4, 2015)
+## v0.18.2 (November 27, 2023)
 
 - Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+source "https://rubygems.org"
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec

data/README.md

@@ -6,13 +6,21 @@
 [![Code Climate](https://codeclimate.com/github/khiav223577/vault_ruby_client/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/vault_ruby_client)
 [![Test Coverage](https://codeclimate.com/github/khiav223577/vault_ruby_client/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/vault_ruby_client/coverage)
 
-Vault is the official Ruby client for interacting with [Vault](https://vaultproject.io) by HashiCorp.
+Vault Ruby Client is a community-maintained Ruby client for interacting with [Vault](https://vaultproject.io) by HashiCorp.
+
+The official Ruby client is no longer maintained. For more details, refer to the [deprecation announcement](https://developer.hashicorp.com/vault/docs/deprecation#ruby-client-libraries).
+
+## Supports
+- Ruby 2.7, 3.0 ~ 3.2
+- Vault 1.13 ~ 1.17
+
+If you are using a Ruby version not supported by this gem, please use an older version of the [official Ruby client gem](https://github.com/hashicorp/vault-ruby) instead.
 
 Quick Start
 -----------
-Install Ruby 2.0+: [Guide](https://www.ruby-lang.org/en/documentation/installation/).
+Install Ruby 2.7+: [Guide](https://www.ruby-lang.org/en/documentation/installation/).
 
-> Please note that as of Vault Ruby version 0.14.0 versions of Ruby prior to 2.0 are no longer supported.
+Install Vault: [Guide](https://developer.hashicorp.com/vault/install?product_intent=vault).
 
 Install via Rubygems:
 
@@ -89,12 +97,12 @@ client_2 = Vault::Client.new(address: "https://other-vault.mycompany.com")
 And if you want to authenticate with a `AWS EC2` :
 
 ```ruby
-    # Export VAULT_ADDR to ENV then
-    # Get the pkcs7 value from AWS
-    signature = `curl http://169.254.169.254/latest/dynamic/instance-identity/pkcs7`
-    iam_role = `curl http://169.254.169.254/latest/meta-data/iam/security-credentials/`
-    vault_token = Vault.auth.aws_ec2(iam_role, signature, nil)
-    vault_client = Vault::Client.new(address: ENV["VAULT_ADDR"], token: vault_token.auth.client_token)
+# Export VAULT_ADDR to ENV then
+# Get the pkcs7 value from AWS
+signature = `curl http://169.254.169.254/latest/dynamic/instance-identity/pkcs7`
+iam_role = `curl http://169.254.169.254/latest/meta-data/iam/security-credentials/`
+vault_token = Vault.auth.aws_ec2(iam_role, signature, nil)
+vault_client = Vault::Client.new(address: ENV["VAULT_ADDR"], token: vault_token.auth.client_token)
 ```
 
 ### Making requests

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/vault/client.rb

@@ -305,6 +305,15 @@ module Vault
       end
     end
 
+    # Removes double slashes from a path.
+    # 
+    # @param [String]
+    # 
+    # @return [String]
+    def remove_double_slash(path)
+      path.b.gsub(%r{//+}, '/')
+    end
+
     # Construct a URL from the given verb and path. If the request is a GET or
     # DELETE request, the params are assumed to be query params are are
     # converted as such using {Client#to_query_string}.
@@ -333,6 +342,8 @@ module Vault
       # Don't merge absolute URLs
       uri = URI.parse(File.join(address, path)) unless uri.absolute?
 
+      uri.path = remove_double_slash(uri.path)
+
       # Return the URI object
       uri
     end

data/lib/vault/encode.rb

@@ -12,7 +12,7 @@ module Vault
     #
     # @return [String]
     def encode_path(path)
-      path.b.gsub(%r!([^a-zA-Z0-9_.-/]+)!) { |m|
+      path.b.gsub(%r!([^a-zA-Z0-9_.\-/]+)!) { |m|
         '%' + m.unpack('H2' * m.bytesize).join('%').upcase
       }
     end

data/lib/vault/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 # Copyright (c) HashiCorp, Inc.
 # SPDX-License-Identifier: MPL-2.0
 
 module Vault
-  VERSION = "0.18.2"
+  VERSION = '1.0.0'
 end

data/vault_ruby_client.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vault_ruby_client'
+  spec.version       = Vault::VERSION
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['khiav223577@gmail.com']
+
+  spec.summary       = 'Vault is a Ruby API client for interacting with a Vault server.'
+  spec.description   = 'Vault is a Ruby API client for interacting with a Vault server.'
+  spec.homepage      = 'https://github.com/khiav223577/vault_ruby_client'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.required_ruby_version = ">= 2.0"
+  if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new("2.4.0")
+    spec.add_runtime_dependency "aws-sigv4", "= 1.6.0"
+    spec.add_runtime_dependency "aws-eventstream", "= 1.2.0"
+  else
+    spec.add_runtime_dependency "aws-sigv4"
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata      = {
+    'homepage_uri'      => 'https://github.com/khiav223577/vault_ruby_client',
+    'changelog_uri'     => 'https://github.com/khiav223577/vault_ruby_client/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/khiav223577/vault_ruby_client',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/vault_ruby_client',
+    'bug_tracker_uri'   => 'https://github.com/khiav223577/vault_ruby_client/issues',
+  }
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake",    "~> 13.2"
+  spec.add_development_dependency "rspec",   "~> 3.13"
+  spec.add_development_dependency "webmock", "~> 3.24"
+  spec.add_development_dependency "webrick", "~> 1.9"
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vault_ruby_client
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 1.0.0
 platform: ruby
 authors:
 - khiav reoy
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
@@ -80,6 +79,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.24'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 description: Vault is a Ruby API client for interacting with a Vault server.
 email:
 - khiav223577@gmail.com
@@ -87,9 +100,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - lib/vault/api.rb
 - lib/vault/api/approle.rb
 - lib/vault/api/auth.rb
@@ -132,11 +151,16 @@ files:
 - lib/vault/vendor/connection_pool/version.rb
 - lib/vault/version.rb
 - lib/vault_ruby_client.rb
+- vault_ruby_client.gemspec
 homepage: https://github.com/khiav223577/vault_ruby_client
 licenses:
-- MPL-2.0
-metadata: {}
-post_install_message:
+- MIT
+metadata:
+  homepage_uri: https://github.com/khiav223577/vault_ruby_client
+  changelog_uri: https://github.com/khiav223577/vault_ruby_client/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/khiav223577/vault_ruby_client
+  documentation_uri: https://www.rubydoc.info/gems/vault_ruby_client
+  bug_tracker_uri: https://github.com/khiav223577/vault_ruby_client/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -151,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Vault is a Ruby API client for interacting with a Vault server.
 test_files: []