btps_client 1.0.0

data/lib/btps_client/services/safes_service.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BtpsClient
+  module Services
+    # Thin façade over Resources::Safe.
+    class SafesService
+      def initialize(config)
+        @config = config
+      end
+
+      def list(params = {})
+        Resources::Safe.list(params, config: @config)
+      end
+
+      def retrieve(id)
+        Resources::Safe.retrieve(id, config: @config)
+      end
+
+      def create(params)
+        Resources::Safe.create(params, config: @config)
+      end
+
+      def update(id, params)
+        Resources::Safe.update(id, params, config: @config)
+      end
+
+      def delete(id)
+        Resources::Safe.delete(id, config: @config)
+      end
+
+      def all_permissions
+        Resources::Safe.all_permissions(config: @config)
+      end
+
+      def permissions(id)
+        Resources::Safe.permissions(id, config: @config)
+      end
+
+      def update_permissions(id, params)
+        Resources::Safe.update_permissions(id, params, config: @config)
+      end
+
+      def revoke_permissions(id, params)
+        Resources::Safe.revoke_permissions(id, params, config: @config)
+      end
+    end
+  end
+end

data/lib/btps_client/services/secrets_safe_service.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BtpsClient
+  module Services
+    # Aggregator service — groups Folders, Safes, and Secrets under one namespace.
+    # Access via client.secrets_safe.folders / .safes / .secrets
+    class SecretsSafeService
+      def initialize(config)
+        @config = config
+      end
+
+      def folders
+        @folders ||= FoldersService.new(@config)
+      end
+
+      def safes
+        @safes ||= SafesService.new(@config)
+      end
+
+      def secrets
+        @secrets ||= SecretsService.new(@config)
+      end
+    end
+  end
+end

data/lib/btps_client/services/secrets_service.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module BtpsClient
+  module Services
+    # Thin façade over Resources::Secret.
+    class SecretsService
+      def initialize(config)
+        @config = config
+      end
+
+      # Standard mixin operations
+      def list(params = {})
+        Resources::Secret.list(params, config: @config)
+      end
+
+      def retrieve(id)
+        Resources::Secret.retrieve(id, config: @config)
+      end
+
+      def update(id, params)
+        Resources::Secret.update(id, params, config: @config)
+      end
+
+      def delete(id)
+        Resources::Secret.delete(id, config: @config)
+      end
+
+      # Folder-scoped creates
+      def create_in_folder(folder_id, params)
+        Resources::Secret.create_in_folder(folder_id, params, config: @config)
+      end
+
+      def create_text_in_folder(folder_id, params)
+        Resources::Secret.create_text_in_folder(folder_id, params, config: @config)
+      end
+
+      def create_file_in_folder(folder_id, file:, metadata: {})
+        Resources::Secret.create_file_in_folder(folder_id, file: file, metadata: metadata, config: @config)
+      end
+
+      # Folder-scoped list
+      def list_in_folder(folder_id, params = {})
+        Resources::Secret.list_in_folder(folder_id, params, config: @config)
+      end
+
+      # Typed retrieve
+      def retrieve_text(id)
+        Resources::Secret.retrieve_text(id, config: @config)
+      end
+
+      def retrieve_file(id)
+        Resources::Secret.retrieve_file(id, config: @config)
+      end
+
+      def download_file(id)
+        Resources::Secret.download_file(id, config: @config)
+      end
+
+      # Typed updates
+      def update_text(id, params)
+        Resources::Secret.update_text(id, params, config: @config)
+      end
+
+      def update_file(id, file:, metadata: {})
+        Resources::Secret.update_file(id, file: file, metadata: metadata, config: @config)
+      end
+
+      # Bulk move
+      def move(params)
+        Resources::Secret.move(params, config: @config)
+      end
+
+      # CSV upload
+      def upload_csv(folder_id, file:)
+        Resources::Secret.upload_csv(folder_id, file: file, config: @config)
+      end
+
+      # Shares
+      def shares(secret_id)
+        Resources::Secret.shares(secret_id, config: @config)
+      end
+
+      def share_to_folder(secret_id, folder_id)
+        Resources::Secret.share_to_folder(secret_id, folder_id, config: @config)
+      end
+
+      def unshare_from_folder(secret_id, folder_id)
+        Resources::Secret.unshare_from_folder(secret_id, folder_id, config: @config)
+      end
+
+      def unshare_all(secret_id)
+        Resources::Secret.unshare_all(secret_id, config: @config)
+      end
+    end
+  end
+end

data/lib/btps_client/validator.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module BtpsClient
+  # Pure validation engine. Receives a schema hash built by SchemaBuilder
+  # (via the param_schema macro on ApiResource subclasses) and validates
+  # params against it before any HTTP request is sent.
+  #
+  # No schema registry lives here — each resource owns its constraints.
+  #
+  # Usage (automatic via param_schema + mixins):
+  #   Validator.validate!(schema_for(:create), { Name: 'Ops' })
+  #   # => nil on success, raises BtpsClient::ValidationError on failure
+  #
+  # Error messages list ALL failures at once so callers can fix everything
+  # in one go rather than one error per request.
+  class Validator
+    UUID_RE = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i.freeze
+
+    # Validates +params+ against a schema hash produced by SchemaBuilder#to_h.
+    #
+    # @param schema [Hash, nil]  { required: [...], fields: { name => rules } };
+    #   nil is a no-op (no schema declared for this operation).
+    # @param params [Hash]  request body; accepts symbol or string keys.
+    # @return [nil]
+    # @raise [BtpsClient::ValidationError]  lists ALL failures in one raise.
+    def self.validate!(schema, params)
+      return unless schema
+
+      # Normalise to string keys so callers can use either :Name or 'Name'
+      normalized = params.transform_keys(&:to_s)
+      errors     = []
+
+      check_required(normalized, schema[:required], errors)
+      check_fields(normalized, schema[:fields], errors)
+
+      return if errors.empty?
+
+      raise ValidationError.new(
+        "Validation failed: #{errors.join('; ')}",
+        http_status: nil, http_body: nil
+      )
+    end
+
+    class << self
+      private
+
+      def check_required(params, required_fields, errors)
+        (required_fields || []).each do |field|
+          errors << "#{field} is required" if params[field].nil?
+        end
+      end
+
+      def check_fields(params, fields, errors)
+        (fields || {}).each do |field, rules|
+          val = params[field]
+          next if handle_nil_field(field, val, params, rules, errors)
+
+          check_type(field, val, rules, errors)
+          check_length(field, val, rules, errors)
+          check_range(field, val, rules, errors)
+          check_format(field, val, rules, errors)
+          check_enum(field, val, rules, errors)
+        end
+      end
+
+      # rubocop:disable Naming/PredicateMethod
+      def handle_nil_field(field, val, params, rules, errors)
+        return false unless val.nil?
+        return true unless params.key?(field) # absent optional field
+        return true if rules[:nullable] # explicit nil allowed
+
+        errors << "#{field} must not be null" # explicit nil, non-nullable
+        true
+      end
+      # rubocop:enable Naming/PredicateMethod
+
+      def check_type(field, val, rules, errors)
+        expected = rules[:type]
+        return unless expected
+
+        ok = case expected
+             when :string  then val.is_a?(String)
+             when :integer then val.is_a?(Integer)
+             when :array   then val.is_a?(Array)
+             when :boolean then [true, false].include?(val)
+             else true
+             end
+        errors << "#{field} must be a #{expected}" unless ok
+      end
+
+      def check_length(field, val, rules, errors)
+        return unless val.is_a?(String)
+
+        min = rules[:min_length]
+        max = rules[:max_length]
+        errors << "#{field} must be at least #{min} character(s)" if min && val.length < min
+        return unless max && val.length > max
+
+        errors << "#{field} must be at most #{max} character(s) (got #{val.length})"
+      end
+
+      def check_range(field, val, rules, errors)
+        return unless val.is_a?(Integer)
+
+        min = rules[:minimum]
+        max = rules[:maximum]
+        errors << "#{field} must be >= #{min}" if min && val < min
+        errors << "#{field} must be <= #{max}" if max && val > max
+      end
+
+      def check_format(field, val, rules, errors)
+        return unless val.is_a?(String) && rules[:format] == :uuid
+
+        return if val.match?(UUID_RE)
+
+        errors << "#{field} must be a valid UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)"
+      end
+
+      def check_enum(field, val, rules, errors)
+        allowed = rules[:values]
+        return unless allowed
+
+        return if allowed.include?(val)
+
+        errors << "#{field} must be one of: #{allowed.join(', ')} (got #{val.inspect})"
+      end
+    end
+  end
+end

data/lib/btps_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BtpsClient
+  VERSION = '1.0.0'
+end

data/lib/btps_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'btps_client/version'
+require_relative 'btps_client/errors'
+require_relative 'btps_client/configuration'
+require_relative 'btps_client/validator'
+require_relative 'btps_client/schema_builder'
+require_relative 'btps_client/btps_object'
+require_relative 'btps_client/api_resource'
+require_relative 'btps_client/api_requestor'
+
+# Mixins
+require_relative 'btps_client/api_operations/listable'
+require_relative 'btps_client/api_operations/retrievable'
+require_relative 'btps_client/api_operations/creatable'
+require_relative 'btps_client/api_operations/scalar_creatable'
+require_relative 'btps_client/api_operations/updatable'
+require_relative 'btps_client/api_operations/deletable'
+require_relative 'btps_client/api_operations/movable'
+require_relative 'btps_client/api_operations/searchable'
+require_relative 'btps_client/api_operations/uploadable'
+require_relative 'btps_client/api_operations/actionable'
+require_relative 'btps_client/api_operations/nested_listable'
+
+# Resources
+require_relative 'btps_client/resources/folder'
+require_relative 'btps_client/resources/safe'
+require_relative 'btps_client/resources/secret'
+require_relative 'btps_client/resources/managed_account'
+require_relative 'btps_client/resources/request'
+require_relative 'btps_client/resources/credential'
+
+# Services
+require_relative 'btps_client/services/auth_service'
+require_relative 'btps_client/services/folders_service'
+require_relative 'btps_client/services/safes_service'
+require_relative 'btps_client/services/secrets_service'
+require_relative 'btps_client/services/secrets_safe_service'
+require_relative 'btps_client/services/managed_accounts_service'
+require_relative 'btps_client/services/requests_service'
+require_relative 'btps_client/services/credentials_service'
+
+# Client
+require_relative 'btps_client/client'
+
+module BtpsClient
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def config
+      configuration
+    end
+
+    def reset!
+      @configuration = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: btps_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BeyondTrust
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A production-quality Ruby SDK for the BeyondTrust Password Safe REST
+  API v3, covering Auth and Secrets Safe (Folders, Safes, Secrets).
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/btps_client.rb
+- lib/btps_client/api_operations/actionable.rb
+- lib/btps_client/api_operations/creatable.rb
+- lib/btps_client/api_operations/deletable.rb
+- lib/btps_client/api_operations/listable.rb
+- lib/btps_client/api_operations/movable.rb
+- lib/btps_client/api_operations/nested_listable.rb
+- lib/btps_client/api_operations/retrievable.rb
+- lib/btps_client/api_operations/scalar_creatable.rb
+- lib/btps_client/api_operations/searchable.rb
+- lib/btps_client/api_operations/updatable.rb
+- lib/btps_client/api_operations/uploadable.rb
+- lib/btps_client/api_requestor.rb
+- lib/btps_client/api_resource.rb
+- lib/btps_client/btps_object.rb
+- lib/btps_client/client.rb
+- lib/btps_client/configuration.rb
+- lib/btps_client/errors.rb
+- lib/btps_client/resources/credential.rb
+- lib/btps_client/resources/folder.rb
+- lib/btps_client/resources/managed_account.rb
+- lib/btps_client/resources/request.rb
+- lib/btps_client/resources/safe.rb
+- lib/btps_client/resources/secret.rb
+- lib/btps_client/schema_builder.rb
+- lib/btps_client/services/auth_service.rb
+- lib/btps_client/services/credentials_service.rb
+- lib/btps_client/services/folders_service.rb
+- lib/btps_client/services/managed_accounts_service.rb
+- lib/btps_client/services/requests_service.rb
+- lib/btps_client/services/safes_service.rb
+- lib/btps_client/services/secrets_safe_service.rb
+- lib/btps_client/services/secrets_service.rb
+- lib/btps_client/validator.rb
+- lib/btps_client/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby SDK for BeyondTrust Password Safe API v3
+test_files: []