turbopuffer 0.1.0 → 1.2.0

data/lib/turbopuffer/client.rb

@@ -1,24 +1,130 @@
 # frozen_string_literal: true
 
-require "faraday"
-
 module Turbopuffer
-  class Client
-    BASE_URL = "https://api.turbopuffer.com"
-
-    def initialize(api_token)
-      @api_token = api_token
-      @connection = Faraday.new(url: BASE_URL) do |conn|
-        conn.request :json
-        conn.response :json, parser_options: {symbolize_names: true}
-        conn.headers["Authorization"] = "Bearer #{@api_token}"
-        conn.headers["Accept-Encoding"] = "gzip"
-        conn.adapter Faraday.default_adapter
-      end
+  class Client < Turbopuffer::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 4
+
+    # 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.3
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # API key used for authentication
+    # @return [String]
+    attr_reader :api_key
+
+    # The turbopuffer region to use.
+    # @return [String, nil]
+    attr_reader :region
+
+    # @return [String, nil]
+    attr_reader :default_namespace
+
+    # Creates a new namespace resource.
+    #
+    # @param namespace [String] The ID of the namespace.
+    #
+    # @return [Turbopuffer::Namespace]
+    def namespace(namespace)
+      Turbopuffer::Namespace.new(self, namespace)
+    end
+
+    # List namespaces.
+    #
+    # @overload namespaces(cursor: nil, page_size: nil, prefix: nil, request_options: {})
+    #
+    # @param cursor [String] Retrieve the next page of results.
+    #
+    # @param page_size [Integer] Limit the number of results per page.
+    #
+    # @param prefix [String] Retrieve only the namespaces that match the prefix.
+    #
+    # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
+    #
+    # @return [Turbopuffer::Internal::NamespacePage<Turbopuffer::Models::NamespaceSummary>]
+    #
+    # @see Turbopuffer::Models::ClientNamespacesParams
+    def namespaces(params = {})
+      parsed, options = Turbopuffer::ClientNamespacesParams.dump_request(params)
+      request(
+        method: :get,
+        path: "v1/namespaces",
+        query: parsed,
+        page: Turbopuffer::Internal::NamespacePage,
+        model: Turbopuffer::NamespaceSummary,
+        options: options
+      )
     end
 
-    def namespace(name)
-      Namespace.new(name, @connection)
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] API key used for authentication Defaults to `ENV["TURBOPUFFER_API_KEY"]`
+    #
+    # @param region [String, nil] The turbopuffer region to use. Defaults to `ENV["TURBOPUFFER_REGION"]`
+    #
+    # @param default_namespace [String, nil]
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["TURBOPUFFER_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(
+      api_key: ENV["TURBOPUFFER_API_KEY"],
+      region: ENV["TURBOPUFFER_REGION"],
+      default_namespace: nil,
+      base_url: ENV["TURBOPUFFER_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://{region}.turbopuffer.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"TURBOPUFFER_API_KEY\"")
+      end
+
+      if base_url.include?("{region}")
+        if region.nil?
+          raise ArgumentError.new("region is required when base_url contains {region} placeholder: #{base_url}")
+        end
+        base_url = base_url.gsub("{region}", region)
+      elsif !region.nil?
+        raise ArgumentError.new("region is set, but would be ignored (baseUrl does not contain {region} placeholder: #{base_url})")
+      end
+
+      @default_namespace = default_namespace&.to_s
+      @api_key = api_key.to_s
+      @region = region&.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
+      )
     end
   end
 end

data/lib/turbopuffer/errors.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Turbopuffer::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 < Turbopuffer::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 < Turbopuffer::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 < Turbopuffer::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 < Turbopuffer::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
+          Turbopuffer::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Turbopuffer::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Turbopuffer::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Turbopuffer::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Turbopuffer::Errors::ConflictError.new(**kwargs)
+        in 422
+          Turbopuffer::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Turbopuffer::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Turbopuffer::Errors::InternalServerError.new(**kwargs)
+        else
+          Turbopuffer::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 < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Turbopuffer::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/turbopuffer/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  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 [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/turbopuffer/internal/namespace_page.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if namespace_page.has_next?
+    #     namespace_page = namespace_page.next_page
+    #   end
+    #
+    # @example
+    #   namespace_page.auto_paging_each do |client|
+    #     puts(client)
+    #   end
+    class NamespacePage
+      include Turbopuffer::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :namespaces
+
+      # @return [String]
+      attr_accessor :next_cursor
+
+      # @return [Boolean]
+      def next_page?
+        !namespaces.to_a.empty? && !next_cursor.to_s.empty?
+      end
+
+      # @raise [Turbopuffer::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Turbopuffer::Internal::Util.deep_merge(@req, {query: {cursor: next_cursor}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.namespaces&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Turbopuffer::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {namespaces: Array => namespaces}
+          @namespaces = namespaces.map { Turbopuffer::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        @next_cursor = page_data[:next_cursor]
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Turbopuffer::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} next_cursor=#{next_cursor.inspect}>"
+      end
+    end
+  end
+end