infisical-sdk 2.3.9 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed26788503528e4b3c0485bc55ccc227fc006d46f6897b092e5fc9c9d75fd448
-  data.tar.gz: ea402102bb2e2a09fb5f231e99cc833be417d423366fb6b48f63f23b239ea73a
+  metadata.gz: 2336fc2716e609a98572e6106c11e028292155bf931ed3d617698f4022296a6d
+  data.tar.gz: f3c6e1d79a55db3feb9c79e0db65fefef3ec2fc3881d955401958291f4a2ae02
 SHA512:
-  metadata.gz: dc758fc1bf3cd359d8e91e8e0f9ec37842207e7e14debff2e65f6b4a0173d0c1280f4b608d5131073ba962e7994da42600bdabb9a452b9b1e9f2f7b4632a499c
-  data.tar.gz: e648172a2b46724eb3121c0fa088048d30527b06afa2cb28b52047d90c9e9056e0330186ff6a3a8d57339671842947f93683719df8da4b6439b554e0ccb44691
+  metadata.gz: ec2e2027d1a6cd9caed723561f798faaebc644cd18ac38252556bfde95cfb42f6b26854207bd7c2173ddab19234be3ae527078e78f388b11dc8d7538e742be98
+  data.tar.gz: 8ef6a5c37b01d85e332536c97a234eab1d0e287a2b6e44b7a8a1e699e466f84dc4e28e8d7affe41a77b8a507aa1e47d02169eaec25ad3a67a5b172a0dd2edb58

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "bin/**/*"
+    - "vendor/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    # Deliberately dashed: it must match the gem name so Bundler.require
+    # (`gem "infisical-sdk"`) resolves without a `require:` override.
+    - "lib/infisical-sdk.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ParameterLists:
+  # Keyword args are self-documenting at the call site; don't penalize a
+  # wide options surface the way positional args would be.
+  CountKeywordArgs: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/.yardopts

@@ -0,0 +1,5 @@
+--markup markdown
+lib/**/*.rb
+-
+README.md
+LICENSE

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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/README.md

@@ -0,0 +1,134 @@
+<h1 align="center">Infisical Ruby SDK</h1>
+
+<h4 align="center">
+  <a href="https://infisical.com/docs/sdks/languages/ruby">Documentation</a> |
+  <a href="https://www.infisical.com">Website</a> |
+  <a href="https://infisical.com/slack">Slack</a>
+</h4>
+
+## Introduction
+
+**[Infisical](https://infisical.com)** is the open source secret management platform that teams use to centralize their secrets like API keys, database credentials, and configurations.
+
+This is the official native Ruby SDK — it talks directly to the Infisical REST API and has no Rust/FFI dependency. It replaces the deprecated `infisical-sdk` gem that was built on Infisical's legacy cross-language architecture, so it is **not** a drop-in replacement: the public API differs from the old gem.
+
+## Installation
+
+```ruby
+gem "infisical-sdk"
+```
+
+## Quick start
+
+```ruby
+require "infisical"
+
+client = Infisical::Client.new
+
+client.auth.universal_auth_login(
+  client_id: ENV.fetch("INFISICAL_CLIENT_ID"),
+  client_secret: ENV.fetch("INFISICAL_CLIENT_SECRET")
+)
+
+secrets = client.secrets.list(
+  project_id: "<your-project-id>",
+  environment: "dev"
+)
+
+secrets.each { |secret| puts "#{secret.secret_key}=#{secret.secret_value}" }
+```
+
+### Authentication
+
+```ruby
+# Universal Auth (machine identity client id/secret). Returns the full
+# credential, so you can build your own token refresh on top of it.
+credential = client.auth.universal_auth_login(client_id: "...", client_secret: "...")
+credential.access_token       # the token this client now uses
+credential.expires_in         # seconds until it expires
+credential.access_token_max_ttl
+credential.token_type         # "Bearer"
+
+# Or use a token you already have
+client.auth.access_token("existing-access-token")
+```
+
+### Secrets
+
+```ruby
+client.secrets.list(project_id: "...", environment: "dev", secret_path: "/")
+
+# Imported secrets are folded in by default; pass include_imports: false to
+# opt out. Recursive mode collapses duplicate keys across folders to one
+# secret per key unless skip_unique_validation: true is passed.
+client.secrets.list(project_id: "...", environment: "dev", recursive: true)
+
+# Export fetched secrets into the process environment (never overrides
+# variables that already have a value):
+client.secrets.list(project_id: "...", environment: "dev", attach_to_process_env: true)
+ENV.fetch("DATABASE_URL")
+
+client.secrets.get("DATABASE_URL", project_id: "...", environment: "dev")
+client.secrets.create("DATABASE_URL", "postgres://...", project_id: "...", environment: "dev")
+client.secrets.update("DATABASE_URL", project_id: "...", environment: "dev", secret_value: "postgres://...")
+client.secrets.delete("DATABASE_URL", project_id: "...", environment: "dev")
+
+# create and update accept skip_multiline_encoding: true to disable the
+# API's encoding of multi-line values.
+```
+
+Each returned secret exposes `secret_key`, `secret_value`, `secret_comment`,
+`secret_path`, `version`, `metadata` (an array of key/value entries), and
+`tags` (an array with `id`, `slug`, `name`, and `color`).
+
+### Error handling
+
+Every error raised by the SDK inherits from `Infisical::Error`. API failures
+raise `Infisical::APIError` (with `status`, `url`, `http_method`, and
+`request_id` readers), and well-known statuses raise a dedicated subclass:
+
+```ruby
+begin
+  client.secrets.get("DATABASE_URL", project_id: "...", environment: "dev")
+rescue Infisical::NotFoundError        # 404
+  # secret does not exist
+rescue Infisical::AuthenticationError  # 401: bad or expired credentials
+  # re-authenticate
+rescue Infisical::APIError => e        # anything else the API rejected
+  # e.status, e.url, e.http_method, e.request_id
+end
+```
+
+Also available: `Infisical::PermissionError` (403), `Infisical::RateLimitError`
+(429, raised only after automatic retries are exhausted), and
+`Infisical::ServerError` (5xx). Network-level failures (timeouts, DNS,
+connection resets) raise `Infisical::RequestError` after retries.
+
+### Self-hosted instances
+
+```ruby
+client = Infisical::Client.new(site_url: "https://your-infisical-instance.com")
+```
+
+A trailing `/api` on the site URL (as used with some other Infisical SDKs) is
+accepted and normalized away.
+
+## Documentation
+
+You can find the documentation for the Ruby SDK on our [SDK documentation page](https://infisical.com/docs/sdks/languages/ruby).
+
+## Development
+
+```bash
+bin/setup        # bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+## Security
+
+Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public!
+
+Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible.
+
+Note that this security address should be used only for undisclosed vulnerabilities. Please report any security problems to us before disclosing it publicly.

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
+require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task default: :rubocop
+task default: %i[spec rubocop]

data/infisical-sdk.gemspec

@@ -1,49 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'lib/version'
+require_relative "lib/infisical/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'infisical-sdk'
-  spec.version = InfisicalSDK::VERSION
-  spec.authors = ['Infisical Inc.']
-  spec.email = ['team@infisical.com']
+  spec.name = "infisical-sdk"
+  spec.version = Infisical::VERSION
+  spec.authors = ["Infisical"]
+  spec.email = ["support@infisical.com"]
+
+  spec.summary = "Official Infisical SDK for Ruby"
+  spec.description = "Native Ruby SDK for fetching and managing secrets with Infisical."
+  spec.homepage = "https://github.com/Infisical/ruby-sdk"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/infisical-sdk"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.summary = 'Ruby SDK for interacting with the Infisical platform.'
-  spec.description = 'The official Infisical Ruby SDK.'
-  spec.homepage = 'https://infisical.com'
-  spec.required_ruby_version = '>= 2.7'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/infisical/sdk'
-  spec.metadata['changelog_uri'] = 'https://infisical.com/docs/changelog/overview'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git Gemfile])
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
     end
   end
-
-  spec.files += Dir.glob('lib/linux-x64/**/*')
-  spec.files += Dir.glob('lib/linux-arm64/**/*')
-  spec.files += Dir.glob('lib/macos-x64/**/*')
-  spec.files += Dir.glob('lib/windows-x64/**/*')
-  spec.files += Dir.glob('lib/macos-arm64/**/*')
-  spec.files += Dir.glob('lib/schemas.rb')
-  spec.files += Dir.glob('lib/extended_schemas/schemas.rb')
-
-  spec.bindir = 'exe'
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'dry-struct', '~> 1.6'
-  spec.add_dependency 'dry-types', '~> 1.7'
-  spec.add_dependency 'ffi', '~> 1.15'
-  spec.add_dependency 'json', '~> 2.6'
-  spec.add_dependency 'rake', '~> 13.0'
-  spec.add_dependency 'rubocop', '~> 1.21'
-
+  spec.require_paths = ["lib"]
 end

data/lib/infisical/auth.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "models/machine_identity_credential"
+
+module Infisical
+  # Authenticates the underlying HTTP client. Every other resource client
+  # shares that same HTTP client, so a successful login here authenticates
+  # the whole {Client} instance.
+  class Auth
+    UNIVERSAL_AUTH_LOGIN_PATH = "api/v1/auth/universal-auth/login"
+
+    # @api private Obtain instances via {Client#auth} instead.
+    def initialize(http_client)
+      @http_client = http_client
+    end
+
+    # Logs in with Universal Auth (machine identity client id/secret) and
+    # authenticates this client with the resulting access token. The full
+    # credential is returned so callers can track `expires_in` and re-login
+    # (or renew) before the token lapses.
+    #
+    # @param client_id [String] machine identity client id
+    # @param client_secret [String] machine identity client secret
+    # @return [Models::MachineIdentityCredential] the credential now used by
+    #   this client
+    # @raise [AuthenticationError] if the credentials are rejected
+    def universal_auth_login(client_id:, client_secret:)
+      # auth: false keeps any previously stored (possibly expired) bearer
+      # token off the login request; the API breaks on stale tokens there.
+      response = @http_client.post(
+        UNIVERSAL_AUTH_LOGIN_PATH,
+        body: { clientId: client_id, clientSecret: client_secret },
+        auth: false
+      )
+
+      access_token(response["accessToken"])
+      Models::MachineIdentityCredential.from_api(response)
+    end
+
+    # Authenticates with an access token obtained out-of-band, skipping
+    # the login request entirely.
+    #
+    # @param token [String] a valid Infisical access token
+    # @return [String] the token, now used by this client
+    def access_token(token)
+      @http_client.access_token = token
+      token
+    end
+  end
+end

data/lib/infisical/client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "uri"
+
+require_relative "http_client"
+require_relative "auth"
+require_relative "secrets"
+
+module Infisical
+  # Entry point for the SDK. Construct one, authenticate via {#auth}, then
+  # use {#secrets} to talk to Infisical.
+  #
+  # @example Fetch a secret
+  #   client = Infisical::Client.new
+  #   client.auth.universal_auth_login(client_id: "...", client_secret: "...")
+  #   secret = client.secrets.get("DATABASE_URL", project_id: "...", environment: "dev")
+  #   secret.secret_value # => "postgres://..."
+  class Client
+    DEFAULT_SITE_URL = "https://app.infisical.com"
+    ALLOWED_SCHEMES = %w[http https].freeze
+
+    # @param site_url [String] base URL of the Infisical instance; defaults to
+    #   Infisical Cloud, so only self-hosted deployments need to set it. A
+    #   trailing "/api" is tolerated and stripped.
+    # @param timeout [Numeric] open/read timeout in seconds for each request
+    # @raise [ArgumentError] if site_url is not an http(s) URL
+    def initialize(site_url: DEFAULT_SITE_URL, timeout: HTTPClient::DEFAULT_TIMEOUT)
+      validate_site_url!(site_url)
+      @http_client = HTTPClient.new(base_url: normalize_site_url(site_url), timeout: timeout)
+    end
+
+    # Authentication operations. Logging in through this authenticates the
+    # whole client, since all resource clients share one HTTP client.
+    #
+    # @return [Auth]
+    def auth
+      @auth ||= Auth.new(@http_client)
+    end
+
+    # Secret CRUD operations.
+    #
+    # @return [Secrets]
+    def secrets
+      @secrets ||= Secrets.new(@http_client)
+    end
+
+    private
+
+    # Users coming from other Infisical SDKs are used to passing the site
+    # URL with an "/api" suffix; the SDK adds that segment itself, so strip
+    # it (and any trailing slashes) rather than requesting ".../api/api/...".
+    def normalize_site_url(site_url)
+      url = site_url.dup
+      url.chomp!("/") while url.end_with?("/")
+      url.delete_suffix("/api")
+    end
+
+    def validate_site_url!(site_url)
+      uri = URI.parse(site_url)
+      return if ALLOWED_SCHEMES.include?(uri.scheme) && uri.host
+
+      raise ArgumentError, "site_url must be an http(s) URL, got: #{site_url.inspect}"
+    rescue URI::InvalidURIError
+      raise ArgumentError, "site_url is not a valid URL: #{site_url.inspect}"
+    end
+  end
+end