openlayer 0.3.0 → 0.4.0

data/lib/openlayer.rb

@@ -1,16 +1,100 @@
 # frozen_string_literal: true
 
-require_relative "openlayer/version"
-
-module Openlayer
-  autoload :Client, "openlayer/client"
-  autoload :Error, "openlayer/error"
-  autoload :Object, "openlayer/object"
-  autoload :InferencePipeline, "openlayer/inference_pipeline"
-  autoload :S3PresignedClient, "openlayer/services/s3_presigned_client"
-  autoload :TarFileHelper, "openlayer/services/tar_file_helper"
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
-  # Classes used to return a nicer object wrapping the response data
-  autoload :Project, "openlayer/objects/project"
-  autoload :ProjectVersion, "openlayer/objects/project_version"
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
 end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "openlayer/version"
+require_relative "openlayer/internal/util"
+require_relative "openlayer/internal/type/converter"
+require_relative "openlayer/internal/type/unknown"
+require_relative "openlayer/internal/type/boolean"
+require_relative "openlayer/internal/type/file_input"
+require_relative "openlayer/internal/type/enum"
+require_relative "openlayer/internal/type/union"
+require_relative "openlayer/internal/type/array_of"
+require_relative "openlayer/internal/type/hash_of"
+require_relative "openlayer/internal/type/base_model"
+require_relative "openlayer/internal/type/base_page"
+require_relative "openlayer/internal/type/request_parameters"
+require_relative "openlayer/internal"
+require_relative "openlayer/request_options"
+require_relative "openlayer/file_part"
+require_relative "openlayer/errors"
+require_relative "openlayer/internal/transport/base_client"
+require_relative "openlayer/internal/transport/pooled_net_requester"
+require_relative "openlayer/client"
+require_relative "openlayer/models/commit_retrieve_params"
+require_relative "openlayer/models/commit_retrieve_response"
+require_relative "openlayer/models/commits/test_result_list_params"
+require_relative "openlayer/models/commits/test_result_list_response"
+require_relative "openlayer/models/inference_pipeline_delete_params"
+require_relative "openlayer/models/inference_pipeline_retrieve_params"
+require_relative "openlayer/models/inference_pipeline_retrieve_response"
+require_relative "openlayer/models/inference_pipelines/data_stream_params"
+require_relative "openlayer/models/inference_pipelines/data_stream_response"
+require_relative "openlayer/models/inference_pipelines/row_update_params"
+require_relative "openlayer/models/inference_pipelines/row_update_response"
+require_relative "openlayer/models/inference_pipelines/test_result_list_params"
+require_relative "openlayer/models/inference_pipelines/test_result_list_response"
+require_relative "openlayer/models/inference_pipeline_update_params"
+require_relative "openlayer/models/inference_pipeline_update_response"
+require_relative "openlayer/models/project_create_params"
+require_relative "openlayer/models/project_create_response"
+require_relative "openlayer/models/project_list_params"
+require_relative "openlayer/models/project_list_response"
+require_relative "openlayer/models/projects/commit_create_params"
+require_relative "openlayer/models/projects/commit_create_response"
+require_relative "openlayer/models/projects/commit_list_params"
+require_relative "openlayer/models/projects/commit_list_response"
+require_relative "openlayer/models/projects/inference_pipeline_create_params"
+require_relative "openlayer/models/projects/inference_pipeline_create_response"
+require_relative "openlayer/models/projects/inference_pipeline_list_params"
+require_relative "openlayer/models/projects/inference_pipeline_list_response"
+require_relative "openlayer/models/projects/test_create_params"
+require_relative "openlayer/models/projects/test_create_response"
+require_relative "openlayer/models/projects/test_list_params"
+require_relative "openlayer/models/projects/test_list_response"
+require_relative "openlayer/models/projects/test_update_params"
+require_relative "openlayer/models/projects/test_update_response"
+require_relative "openlayer/models/storage/presigned_url_create_params"
+require_relative "openlayer/models/storage/presigned_url_create_response"
+require_relative "openlayer/models"
+require_relative "openlayer/resources/commits"
+require_relative "openlayer/resources/commits/test_results"
+require_relative "openlayer/resources/inference_pipelines"
+require_relative "openlayer/resources/inference_pipelines/data"
+require_relative "openlayer/resources/inference_pipelines/rows"
+require_relative "openlayer/resources/inference_pipelines/test_results"
+require_relative "openlayer/resources/projects"
+require_relative "openlayer/resources/projects/commits"
+require_relative "openlayer/resources/projects/inference_pipelines"
+require_relative "openlayer/resources/projects/tests"
+require_relative "openlayer/resources/storage"
+require_relative "openlayer/resources/storage/presigned_url"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/openlayer/client.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Openlayer
+  class Client < Openlayer::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :api_key
+
+    sig { returns(Openlayer::Resources::Projects) }
+    attr_reader :projects
+
+    sig { returns(Openlayer::Resources::Commits) }
+    attr_reader :commits
+
+    sig { returns(Openlayer::Resources::InferencePipelines) }
+    attr_reader :inference_pipelines
+
+    sig { returns(Openlayer::Resources::Storage) }
+    attr_reader :storage
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["OPENLAYER_API_KEY"]`
+      api_key: ENV["OPENLAYER_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["OPENLAYER_BASE_URL"]`
+      base_url: ENV["OPENLAYER_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Openlayer::Client::DEFAULT_MAX_RETRIES,
+      timeout: Openlayer::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Openlayer::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Openlayer::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/openlayer/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Openlayer
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Openlayer::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < Openlayer::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < Openlayer::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < Openlayer::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < Openlayer::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Openlayer::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/openlayer/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Openlayer
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end