scalar_api_ruby 0.2.0

data/lib/scalar_api_ruby/client.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Scalar
+  class Client < Scalar::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String, nil]
+    attr_reader :bearer_auth
+
+    # @return [String, nil]
+    attr_reader :o_auth2
+
+    # Registry
+    # @return [Scalar::Resources::Registry]
+    attr_reader :registry
+
+    # Schemas
+    # @return [Scalar::Resources::Schemas]
+    attr_reader :schemas
+
+    # Login Portals
+    # @return [Scalar::Resources::LoginPortals]
+    attr_reader :login_portals
+
+    # Access Groups
+    # @return [Scalar::Resources::AccessGroups]
+    attr_reader :access_groups
+
+    # Rules
+    # @return [Scalar::Resources::Rules]
+    attr_reader :rules
+
+    # Themes
+    # @return [Scalar::Resources::Themes]
+    attr_reader :themes
+
+    # Teams
+    # @return [Scalar::Resources::Teams]
+    attr_reader :teams
+
+    # Scalar Docs
+    # @return [Scalar::Resources::ScalarDocs]
+    attr_reader :scalar_docs
+
+    # Namespaces
+    # @return [Scalar::Resources::Namespaces]
+    attr_reader :namespaces
+
+    # Authentication
+    # @return [Scalar::Resources::Authentication]
+    attr_reader :authentication
+
+    # SDKs
+    # @return [Scalar::Resources::Sdks]
+    attr_reader :sdks
+
+    # @return [Scalar::Resources::Mcp]
+    attr_reader :mcp
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      {**auth_bearer_auth, **auth_o_auth2}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_bearer_auth
+      {"authorization" => "Bearer #{@bearer_auth}"}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_o_auth2
+      {"authorization" => "Bearer #{@o_auth2}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param bearer_auth [String, nil] Defaults to `ENV["BEARER_AUTH"]`
+    #
+    # @param o_auth2 [String, nil] Defaults to `ENV["SCALAR_OAUTH_TOKEN"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["SCALAR_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      bearer_auth: ENV["BEARER_AUTH"],
+      o_auth2: ENV["SCALAR_OAUTH_TOKEN"],
+      base_url: ENV["SCALAR_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://access.scalar.com"
+
+      headers = {}
+      custom_headers_env = ENV["SCALAR_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env
+          .split("\n")
+          .each do |line|
+            colon = line.index(":")
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip unless colon.nil?
+          end
+        headers = parsed.merge(headers)
+      end
+
+      @bearer_auth = bearer_auth&.to_s
+      @o_auth2 = o_auth2&.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay,
+        headers: headers
+      )
+
+      @registry = Scalar::Resources::Registry.new(client: self)
+      @schemas = Scalar::Resources::Schemas.new(client: self)
+      @login_portals = Scalar::Resources::LoginPortals.new(client: self)
+      @access_groups = Scalar::Resources::AccessGroups.new(client: self)
+      @rules = Scalar::Resources::Rules.new(client: self)
+      @themes = Scalar::Resources::Themes.new(client: self)
+      @teams = Scalar::Resources::Teams.new(client: self)
+      @scalar_docs = Scalar::Resources::ScalarDocs.new(client: self)
+      @namespaces = Scalar::Resources::Namespaces.new(client: self)
+      @authentication = Scalar::Resources::Authentication.new(client: self)
+      @sdks = Scalar::Resources::Sdks.new(client: self)
+      @mcp = Scalar::Resources::Mcp.new(client: self)
+    end
+  end
+end

data/lib/scalar_api_ruby/errors.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Scalar::Errors::Error
+      # @return [StandardError, nil]
+      def cause = @cause.nil? ? super : @cause
+
+      # @api private
+      #
+      # @param on [Class<StandardError>]
+      # @param method [Symbol]
+      # @param target [Object]
+      # @param value [Object]
+      # @param cause [StandardError, nil]
+      def initialize(on:, method:, target:, value:, cause: nil)
+        cls = on.name.split("::").last
+
+        message = [
+          "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.",
+          "To get the unparsed API response, use #{cls}[#{method.inspect}].",
+          cause && "Cause: #{cause.message}"
+        ].filter(&:itself).join(" ")
+
+        @cause = cause
+        super(message)
+      end
+    end
+
+    class APIError < Scalar::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @headers = headers
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < Scalar::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < Scalar::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < Scalar::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [self]
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          headers: headers,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          Scalar::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Scalar::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Scalar::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Scalar::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Scalar::Errors::ConflictError.new(**kwargs)
+        in 422
+          Scalar::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Scalar::Errors::RateLimitError.new(**kwargs)
+        in 500.. then
+          Scalar::Errors::InternalServerError.new(**kwargs)
+        else
+          Scalar::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          headers: headers,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Scalar::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/scalar_api_ruby/file_part.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Scalar
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [Pathname, String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content_type = content_type
+      @filename =
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
+        else
+          filename
+        end
+    end
+  end
+end