stagehand 0.0.3 → 3.5.2

data/lib/stagehand/client.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Stagehand
+  class Client < Stagehand::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
+
+    # Your [Browserbase API Key](https://www.browserbase.com/settings)
+    # @return [String]
+    attr_reader :browserbase_api_key
+
+    # Your [Browserbase Project ID](https://www.browserbase.com/settings)
+    # @return [String]
+    attr_reader :browserbase_project_id
+
+    # Your LLM provider API key (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)
+    # @return [String]
+    attr_reader :model_api_key
+
+    # @return [Stagehand::Resources::Sessions]
+    attr_reader :sessions
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      {**bb_api_key_auth, **bb_project_id_auth, **llm_model_api_key_auth}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def bb_api_key_auth
+      {"x-bb-api-key" => @browserbase_api_key}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def bb_project_id_auth
+      {"x-bb-project-id" => @browserbase_project_id}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def llm_model_api_key_auth
+      {"x-model-api-key" => @model_api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param browserbase_api_key [String, nil] Your [Browserbase API Key](https://www.browserbase.com/settings) Defaults to
+    # `ENV["BROWSERBASE_API_KEY"]`
+    #
+    # @param browserbase_project_id [String, nil] Your [Browserbase Project ID](https://www.browserbase.com/settings) Defaults to
+    # `ENV["BROWSERBASE_PROJECT_ID"]`
+    #
+    # @param model_api_key [String, nil] Your LLM provider API key (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)
+    # Defaults to `ENV["MODEL_API_KEY"]`
+    #
+    # @param server [String] Server mode to use ("remote" or "local"). Defaults to "remote"
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["STAGEHAND_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(
+      browserbase_api_key: ENV["BROWSERBASE_API_KEY"],
+      browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"],
+      model_api_key: ENV["MODEL_API_KEY"],
+      server: "remote",
+      base_url: ENV["STAGEHAND_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
+    )
+      @server = server
+      base_url ||= "https://api.stagehand.browserbase.com"
+
+      if browserbase_api_key.nil?
+        raise ArgumentError,
+              "browserbase_api_key is required, and can be set via environ: \"BROWSERBASE_API_KEY\""
+      end
+      if browserbase_project_id.nil?
+        raise ArgumentError,
+              "browserbase_project_id is required, and can be set via environ: \"BROWSERBASE_PROJECT_ID\""
+      end
+      if model_api_key.nil?
+        raise ArgumentError,
+              "model_api_key is required, and can be set via environ: \"MODEL_API_KEY\""
+      end
+
+      @browserbase_api_key = browserbase_api_key.to_s
+      @browserbase_project_id = browserbase_project_id.to_s
+      @model_api_key = model_api_key.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
+      )
+
+      @sessions = Stagehand::Resources::Sessions.new(client: self)
+    end
+  end
+end

data/lib/stagehand/errors.rb

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

data/lib/stagehand/file_part.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Stagehand
+  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

data/lib/stagehand/internal/stream.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Stagehand
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   stream.each do |event|
+    #     puts(event)
+    #   end
+    class Stream
+      include Stagehand::Internal::Type::BaseStream
+
+      # @api private
+      #
+      # @return [Enumerable<generic<Elem>>]
+      private def iterator
+        # rubocop:disable Metrics/BlockLength
+        @iterator ||= Stagehand::Internal::Util.chain_fused(@stream) do |y|
+          consume = false
+
+          @stream.each do |msg|
+            next if consume
+
+            case msg
+            in {data: String => data} if data.start_with?("{\"data\":{\"status\":\"finished\"")
+              consume = true
+              next
+            in {data: String => data} if data.start_with?("error")
+              decoded = Kernel.then do
+                JSON.parse(data, symbolize_names: true)
+              rescue JSON::ParserError
+                data
+              end
+              err = Stagehand::Errors::APIStatusError.for(
+                url: @url,
+                status: @status,
+                headers: @headers,
+                body: decoded,
+                request: nil,
+                response: @response
+              )
+              raise err
+            in {event: nil, data: String => data}
+              decoded = JSON.parse(data, symbolize_names: true)
+              unwrapped = Stagehand::Internal::Util.dig(decoded, @unwrap)
+              y << Stagehand::Internal::Type::Converter.coerce(@model, unwrapped)
+            else
+            end
+          end
+        end
+        # rubocop:enable Metrics/BlockLength
+      end
+    end
+  end
+end