handinger 0.0.2

data/lib/handinger/resources/workers.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Resources
+    class Workers
+      # Manage future and recurring worker tasks.
+      # @return [Handinger::Resources::Workers::Schedules]
+      attr_reader :schedules
+
+      # Create a new agent worker and start it with the supplied instruction.
+      #
+      # @overload create(input:, budget: nil, stream: nil, request_options: {})
+      #
+      # @param input [String]
+      # @param budget [Symbol, Handinger::Models::CreateWorker::Budget]
+      # @param stream [Boolean]
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Handinger::Models::Worker]
+      #
+      # @see Handinger::Models::WorkerCreateParams
+      def create(params)
+        parsed, options = Handinger::WorkerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/workers",
+          body: parsed,
+          model: Handinger::Worker,
+          options: options
+        )
+      end
+
+      # Retrieve the current worker state. Pass stream=true or request text/event-stream
+      # to subscribe to updates.
+      #
+      # @overload retrieve(worker_id, stream: nil, request_options: {})
+      #
+      # @param worker_id [String] Worker id returned by the create worker endpoint.
+      #
+      # @param stream [Boolean] Return a server-sent event stream instead of JSON.
+      #
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Handinger::Models::Worker]
+      #
+      # @see Handinger::Models::WorkerRetrieveParams
+      def retrieve(worker_id, params = {})
+        parsed, options = Handinger::WorkerRetrieveParams.dump_request(params)
+        query = Handinger::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["api/workers/%1$s", worker_id],
+          query: query,
+          model: Handinger::Worker,
+          options: options
+        )
+      end
+
+      # Send another instruction to an existing worker.
+      #
+      # @overload continue(worker_id, input:, budget: nil, stream: nil, request_options: {})
+      #
+      # @param worker_id [String] Worker id returned by the create worker endpoint.
+      #
+      # @param input [String]
+      #
+      # @param budget [Symbol, Handinger::Models::CreateWorker::Budget]
+      #
+      # @param stream [Boolean]
+      #
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Handinger::Models::Worker]
+      #
+      # @see Handinger::Models::WorkerContinueParams
+      def continue(worker_id, params)
+        parsed, options = Handinger::WorkerContinueParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["api/workers/%1$s", worker_id],
+          body: parsed,
+          model: Handinger::Worker,
+          options: options
+        )
+      end
+
+      # Retrieve the inbound email address for a worker.
+      #
+      # @overload retrieve_email(worker_id, request_options: {})
+      #
+      # @param worker_id [String] Worker id returned by the create worker endpoint.
+      #
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Handinger::Models::WorkerRetrieveEmailParams
+      def retrieve_email(worker_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/workers/%1$s/email", worker_id],
+          model: String,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve a file published from a worker workspace. The runtime route accepts
+      # nested paths after /files/.
+      #
+      # @overload retrieve_file(file_path, worker_id:, request_options: {})
+      #
+      # @param file_path [String] Workspace file path after /files. URL-encode slashes for nested paths.
+      #
+      # @param worker_id [String] Worker id returned by the create worker endpoint.
+      #
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see Handinger::Models::WorkerRetrieveFileParams
+      def retrieve_file(file_path, params)
+        parsed, options = Handinger::WorkerRetrieveFileParams.dump_request(params)
+        worker_id =
+          parsed.delete(:worker_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["api/workers/%1$s/files/%2$s", worker_id, file_path],
+          headers: {"accept" => "application/octet-stream"},
+          model: StringIO,
+          options: options
+        )
+      end
+
+      # Subscribe to a worker using server-sent events.
+      #
+      # @overload stream_updates_streaming(worker_id, request_options: {})
+      #
+      # @param worker_id [String] Worker id returned by the create worker endpoint.
+      #
+      # @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Handinger::Internal::Stream<String>]
+      #
+      # @see Handinger::Models::WorkerStreamUpdatesParams
+      def stream_updates_streaming(worker_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/workers/%1$s/stream", worker_id],
+          headers: {"accept" => "text/event-stream"},
+          stream: Handinger::Internal::Stream,
+          model: String,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Handinger::Client]
+      def initialize(client:)
+        @client = client
+        @schedules = Handinger::Resources::Workers::Schedules.new(client: client)
+      end
+    end
+  end
+end

data/lib/handinger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Handinger
+  VERSION = "0.0.2"
+end

data/lib/handinger.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# 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 "handinger/version"
+require_relative "handinger/internal/util"
+require_relative "handinger/internal/type/converter"
+require_relative "handinger/internal/type/unknown"
+require_relative "handinger/internal/type/boolean"
+require_relative "handinger/internal/type/file_input"
+require_relative "handinger/internal/type/enum"
+require_relative "handinger/internal/type/union"
+require_relative "handinger/internal/type/array_of"
+require_relative "handinger/internal/type/hash_of"
+require_relative "handinger/internal/type/base_model"
+require_relative "handinger/internal/type/base_page"
+require_relative "handinger/internal/type/base_stream"
+require_relative "handinger/internal/type/request_parameters"
+require_relative "handinger/internal"
+require_relative "handinger/request_options"
+require_relative "handinger/file_part"
+require_relative "handinger/errors"
+require_relative "handinger/internal/transport/base_client"
+require_relative "handinger/internal/transport/pooled_net_requester"
+require_relative "handinger/client"
+require_relative "handinger/internal/stream"
+require_relative "handinger/models/create_worker"
+require_relative "handinger/models/worker"
+require_relative "handinger/models/worker_continue_params"
+require_relative "handinger/models/worker_create_params"
+require_relative "handinger/models/worker_retrieve_email_params"
+require_relative "handinger/models/worker_retrieve_email_response"
+require_relative "handinger/models/worker_retrieve_file_params"
+require_relative "handinger/models/worker_retrieve_params"
+require_relative "handinger/models/workers/schedule_cancel_params"
+require_relative "handinger/models/workers/schedule_cancel_response"
+require_relative "handinger/models/workers/schedule_create_params"
+require_relative "handinger/models/workers/schedule_list_params"
+require_relative "handinger/models/workers/schedule_list_response"
+require_relative "handinger/models/workers/worker_schedule"
+require_relative "handinger/models/worker_stream_updates_params"
+require_relative "handinger/models/worker_stream_updates_response"
+require_relative "handinger/models"
+require_relative "handinger/resources/workers"
+require_relative "handinger/resources/workers/schedules"

data/manifest.yaml

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

data/rbi/handinger/client.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Handinger
+  class Client < Handinger::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(String) }
+    attr_reader :api_key
+
+    sig { returns(Handinger::Resources::Workers) }
+    attr_reader :workers
+
+    # @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["HANDINGER_API_KEY"]`
+      api_key: ENV["HANDINGER_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["HANDINGER_BASE_URL"]`
+      base_url: ENV["HANDINGER_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Handinger::Client::DEFAULT_MAX_RETRIES,
+      timeout: Handinger::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Handinger::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Handinger::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/handinger/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Handinger
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Handinger::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 < Handinger::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 < Handinger::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 < Handinger::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 < Handinger::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 < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Handinger::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/handinger/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Handinger
+  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

data/rbi/handinger/internal/stream.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Handinger
+  module Internal
+    class Stream
+      Message =
+        type_member(:in) do
+          { fixed: Handinger::Internal::Util::ServerSentEvent }
+        end
+      Elem = type_member(:out)
+
+      include Handinger::Internal::Type::BaseStream
+
+      # @api private
+      sig { override.returns(T::Enumerable[Elem]) }
+      private def iterator
+      end
+    end
+  end
+end