hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

data/scripts/generate_api.rb

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Script to generate Ruby REST API client from OpenAPI specification
+# Similar to the Python SDK's generate.sh script
+
+require "fileutils"
+require "json"
+require "open3"
+
+class ApiGenerator
+  OPENAPI_SPEC_PATH = "../../../../bin/oas/openapi.yaml"
+  GENERATOR_CONFIG_PATH = "../config/openapi_generator_config.json"
+  OUTPUT_DIR = "../lib/hatchet/clients/rest"
+  TEMP_DIR = "../tmp/openapi_generation"
+
+  def initialize
+    @root_dir = __dir__
+    @patches_applied = 0
+  end
+
+  def generate
+    puts "🚀 Starting Ruby REST API client generation..."
+    
+    setup_directories
+    install_openapi_generator if needed
+    generate_client_code
+    apply_custom_patches
+    cleanup_temp_files
+    
+    puts "✅ Ruby REST API client generation completed successfully!"
+  end
+
+  private
+
+  def setup_directories
+    puts "📁 Setting up directories..."
+    FileUtils.mkdir_p(OUTPUT_DIR)
+    FileUtils.mkdir_p(TEMP_DIR)
+  end
+
+  def install_openapi_generator
+    puts "🔧 Checking OpenAPI Generator installation..."
+    
+    # Check if openapi-generator-cli is available
+    stdout, stderr, status = Open3.capture3("which openapi-generator-cli")
+    
+    if status.success?
+      puts "✅ OpenAPI Generator CLI found"
+    else
+      puts "📦 Installing OpenAPI Generator CLI via npm..."
+      system("npm install -g @openapitools/openapi-generator-cli@7.13.0") || 
+        raise("Failed to install OpenAPI Generator CLI")
+    end
+  end
+
+  def generate_client_code
+    puts "🏗️  Generating Ruby client code from OpenAPI spec..."
+    
+    openapi_spec = File.expand_path(OPENAPI_SPEC_PATH, @root_dir)
+    config_file = File.expand_path(GENERATOR_CONFIG_PATH, @root_dir)
+    output_path = File.expand_path(OUTPUT_DIR, @root_dir)
+    
+    unless File.exist?(openapi_spec)
+      raise "OpenAPI spec not found at #{openapi_spec}"
+    end
+    
+    unless File.exist?(config_file)
+      puts "⚠️  Config file not found at #{config_file}, using default configuration"
+      config_file = nil
+    else
+      puts "✅ Using config file: #{config_file}"
+    end
+    
+    # Generate Ruby client using OpenAPI Generator
+    additional_props = build_additional_properties
+    
+    cmd = [
+      "openapi-generator-cli", "generate",
+      "-i", openapi_spec,
+      "-g", "ruby",
+      "-o", output_path,
+      "--skip-validate-spec",
+      "--global-property", "apiTests=false,modelTests=false,apiDocs=true,modelDocs=true",
+      "--additional-properties", additional_props
+    ]
+    
+    cmd += ["-c", config_file] if config_file
+    
+    puts "Running: #{cmd.join(' ')}"
+    puts "Additional properties: #{additional_props}"
+    system(*cmd) || raise("Failed to generate Ruby client code")
+  end
+
+  def build_additional_properties
+    [
+      "gemName=hatchet-sdk-rest",
+      "moduleName=HatchetSdkRest", 
+      "gemVersion=0.0.1",
+      "gemDescription=HatchetRubySDKRestClient",
+      "gemAuthor=HatchetTeam",
+      "gemHomepage=https://github.com/hatchet-dev/hatchet",
+      "gemLicense=MIT",
+      "library=faraday"
+    ].join(",")
+  end
+
+  def apply_custom_patches
+    puts "🔧 Applying custom patches..."
+    
+    # Apply Ruby-specific patches here
+    patch_require_statements
+    patch_cookie_auth
+  end
+
+  def patch_require_statements
+    puts "  📝 Patching require statements..."
+    
+    # Find all generated Ruby files and fix require statements
+    Dir.glob("#{OUTPUT_DIR}/**/*.rb").each do |file|
+      content = File.read(file)
+      
+      # Update require paths to be relative to the gem structure
+      content.gsub!(/require ['"]hatchet-sdk-rest\//, "require 'hatchet/clients/rest/")
+      
+      # Ensure consistent module naming
+      content.gsub!(/module HatchetSdkRest/, "module Hatchet\n  module Clients\n    module Rest")
+      content.gsub!(/^end$/, "    end\n  end\nend") if content.include?("module Hatchet")
+      
+      File.write(file, content)
+    end
+  end
+
+  def patch_cookie_auth
+    puts "  🍪 Enhancing cookie auth..."
+    # find the auth_settings hash in the configuration.rb file
+    output_path = File.expand_path(OUTPUT_DIR, @root_dir)
+    config_file = File.join(output_path, "lib/hatchet-sdk-rest/configuration.rb")
+    if not File.exist?(config_file)
+      puts "config_file does not exist"
+      return false
+    end
+    content = File.read(config_file)
+    
+    # Apply the fix - replace 'in: ,' with 'in: 'header','
+    if content.gsub!(/in:\s*,/, "in: 'header',")
+      puts "    ✅ Successfully applied cookie auth patch"
+      File.write(config_file, content)
+      @patches_applied += 1
+    else
+      puts "    ❌ Failed to apply cookie auth patch - no matches found"
+    end
+  end
+
+  def cleanup_temp_files
+    puts "🧹 Cleaning up temporary files..."
+    FileUtils.rm_rf(TEMP_DIR) if Dir.exist?(TEMP_DIR)
+  end
+
+  def needed
+    !system("which openapi-generator-cli > /dev/null 2>&1")
+  end
+end
+
+# Run the generator if this script is executed directly
+if __FILE__ == $0
+  begin
+    ApiGenerator.new.generate
+  rescue => e
+    puts "❌ Generation failed: #{e.message}"
+    puts e.backtrace.join("\n") if ENV["DEBUG"]
+    exit 1
+  end
+end

data/sig/hatchet-sdk.rbs

@@ -1,3 +1,17 @@
+# Standard library classes
+class Logger
+end
+
+class Time
+  def self.now: () -> Time
+  def utc: () -> Time
+  def iso8601: () -> String
+  def -: (Numeric) -> Time
+  def >=: (Time) -> bool
+end
+
+type Numeric = Integer | Float
+
 module Hatchet
   VERSION: String
 
@@ -7,9 +21,28 @@ module Hatchet
   class Client
     attr_reader config: Config
 
+    def self.new: (
+      ?token: String,
+      ?host_port: String,
+      ?server_url: String,
+      ?namespace: String,
+      ?logger: Logger,
+      ?listener_v2_timeout: Integer,
+      ?grpc_max_recv_message_length: Integer,
+      ?grpc_max_send_message_length: Integer,
+      ?worker_preset_labels: Hash[String, String],
+      ?enable_force_kill_sync_threads: bool,
+      ?enable_thread_pool_monitoring: bool,
+      ?terminate_worker_after_num_tasks: Integer,
+      ?disable_log_capture: bool,
+      ?grpc_enable_fork_support: bool,
+      ?tls_config: TLSConfig,
+      ?healthcheck: HealthcheckConfig,
+      ?otel: OpenTelemetryConfig
+    ) -> instance
+
     def initialize: (
       ?token: String,
-      ?tenant_id: String,
       ?host_port: String,
       ?server_url: String,
       ?namespace: String,
@@ -27,11 +60,15 @@ module Hatchet
       ?healthcheck: HealthcheckConfig,
       ?otel: OpenTelemetryConfig
     ) -> void
+
+    def rest_client: () -> untyped
+    def events: () -> Hatchet::Features::Events
+    def runs: () -> Hatchet::Features::Runs
   end
 
   class Config
     attr_accessor token: String
-    attr_accessor tenant_id: String
+    attr_reader tenant_id: String
     attr_accessor host_port: String
     attr_accessor server_url: String
     attr_accessor namespace: String
@@ -49,9 +86,28 @@ module Hatchet
     attr_accessor healthcheck: HealthcheckConfig
     attr_accessor otel: OpenTelemetryConfig
 
+    def self.new: (
+      ?token: String,
+      ?host_port: String,
+      ?server_url: String,
+      ?namespace: String,
+      ?logger: Logger,
+      ?listener_v2_timeout: Integer,
+      ?grpc_max_recv_message_length: Integer,
+      ?grpc_max_send_message_length: Integer,
+      ?worker_preset_labels: Hash[String, String],
+      ?enable_force_kill_sync_threads: bool,
+      ?enable_thread_pool_monitoring: bool,
+      ?terminate_worker_after_num_tasks: Integer,
+      ?disable_log_capture: bool,
+      ?grpc_enable_fork_support: bool,
+      ?tls_config: TLSConfig,
+      ?healthcheck: HealthcheckConfig,
+      ?otel: OpenTelemetryConfig
+    ) -> instance
+
     def initialize: (
       ?token: String,
-      ?tenant_id: String,
       ?host_port: String,
       ?server_url: String,
       ?namespace: String,
@@ -82,6 +138,14 @@ module Hatchet
     attr_accessor root_ca_file: String?
     attr_accessor server_name: String
 
+    def self.new: (
+      ?strategy: String,
+      ?cert_file: String,
+      ?key_file: String,
+      ?root_ca_file: String,
+      ?server_name: String
+    ) -> instance
+
     def initialize: (
       ?strategy: String,
       ?cert_file: String,
@@ -95,12 +159,370 @@ module Hatchet
     attr_accessor port: Integer
     attr_accessor enabled: bool
 
+    def self.new: (?port: Integer, ?enabled: bool) -> instance
     def initialize: (?port: Integer, ?enabled: bool) -> void
   end
 
   class OpenTelemetryConfig
     attr_accessor excluded_attributes: Array[String]
 
+    def self.new: (?excluded_attributes: Array[String]) -> instance
     def initialize: (?excluded_attributes: Array[String]) -> void
   end
+end
+
+module Hatchet
+  module Features
+    # Filter options for listing task runs
+    class RunFilter
+      attr_accessor since: Time
+      attr_accessor until_time: Time?
+      attr_accessor statuses: Array[untyped]?
+      attr_accessor workflow_ids: Array[String]?
+      attr_accessor additional_metadata: Hash[String, String]?
+
+      def initialize: (
+        since: Time,
+        ?until_time: Time?,
+        ?statuses: Array[untyped]?,
+        ?workflow_ids: Array[String]?,
+        ?additional_metadata: Hash[String, String]?
+      ) -> void
+    end
+
+    # Options for bulk cancel and replay operations
+    class BulkCancelReplayOpts
+      attr_accessor ids: Array[String]?
+      attr_accessor filters: RunFilter?
+
+      def initialize: (
+        ?ids: Array[String]?,
+        ?filters: RunFilter?
+      ) -> void
+
+      def v1_task_filter: () -> untyped?
+      def to_cancel_request: () -> untyped
+      def to_replay_request: () -> untyped
+    end
+
+    class Events
+      # Re-exported classes from HatchetSdkRest for convenience
+      CreateEventRequest: Class
+      BulkCreateEventRequest: Class
+      EventList: Class
+
+      def self.new: (untyped rest_client, Hatchet::Config config) -> instance
+      def initialize: (untyped rest_client, Hatchet::Config config) -> void
+      
+      def create: (
+        key: String,
+        data: Hash[String, untyped],
+        ?additional_metadata: Hash[String, String]?,
+        ?priority: Integer?,
+        ?scope: String?,
+        ?namespace: String?
+      ) -> untyped
+      
+      def push: (
+        String event_key,
+        Hash[String, untyped] payload,
+        ?additional_metadata: Hash[String, String]?,
+        ?namespace: String?,
+        ?priority: Integer?
+      ) -> untyped
+      
+      def bulk_push: (
+        Array[Hash[Symbol, untyped]] events,
+        ?namespace: String?
+      ) -> untyped
+      
+      def list: (
+        ?offset: Integer?,
+        ?limit: Integer?,
+        ?keys: Array[String]?,
+        ?since: Time?,
+        ?until_time: Time?,
+        ?workflow_ids: Array[String]?,
+        ?workflow_run_statuses: Array[String]?,
+        ?event_ids: Array[String]?,
+        ?additional_metadata: Hash[String, String]?,
+        ?scopes: Array[String]?
+      ) -> untyped
+      
+      def get: (String event_id) -> untyped
+      def get_data: (String event_id) -> untyped
+      def list_keys: () -> untyped
+      
+      def cancel: (
+        ?event_ids: Array[String]?,
+        ?keys: Array[String]?,
+        ?since: Time?,
+        ?until_time: Time?
+      ) -> untyped
+      
+      def replay: (
+        ?event_ids: Array[String]?,
+        ?keys: Array[String]?,
+        ?since: Time?,
+        ?until_time: Time?
+      ) -> untyped
+    end
+
+    class Runs
+      # Re-exported classes from HatchetSdkRest for convenience
+      TriggerWorkflowRunRequest: Class
+      WorkflowRunDetails: Class
+      TaskSummary: Class
+      TaskSummaryList: Class
+      TaskStatus: Class
+
+      def self.new: (untyped rest_client, Hatchet::Config config) -> instance
+      def initialize: (untyped rest_client, Hatchet::Config config) -> void
+
+      def get_task_run: (String task_run_id) -> untyped
+      def get: (String workflow_run_id) -> untyped
+      def get_status: (String workflow_run_id) -> untyped
+
+      def list_with_pagination: (
+        ?since: Time?,
+        ?only_tasks: bool,
+        ?offset: Integer?,
+        ?limit: Integer?,
+        ?statuses: Array[untyped]?,
+        ?until_time: Time?,
+        ?additional_metadata: Hash[String, String]?,
+        ?workflow_ids: Array[String]?,
+        ?worker_id: String?,
+        ?parent_task_external_id: String?,
+        ?triggering_event_external_id: String?
+      ) -> Array[untyped]
+
+      def list: (
+        ?since: Time?,
+        ?only_tasks: bool,
+        ?offset: Integer?,
+        ?limit: Integer?,
+        ?statuses: Array[untyped]?,
+        ?until_time: Time?,
+        ?additional_metadata: Hash[String, String]?,
+        ?workflow_ids: Array[String]?,
+        ?worker_id: String?,
+        ?parent_task_external_id: String?,
+        ?triggering_event_external_id: String?
+      ) -> untyped
+
+      def create: (
+        name: String,
+        input: Hash[String, untyped],
+        ?additional_metadata: Hash[String, untyped]?,
+        ?priority: Integer?
+      ) -> untyped
+
+      def replay: (String run_id) -> void
+      def bulk_replay: (BulkCancelReplayOpts opts) -> void
+      def cancel: (String run_id) -> void
+      def bulk_cancel: (BulkCancelReplayOpts opts) -> void
+      def get_result: (String run_id) -> Hash[String, untyped]
+      
+      def poll: (
+        String workflow_run_id,
+        ?interval: Numeric,
+        ?timeout: Numeric?
+      ) -> untyped
+    end
+  end
+end
+
+# External module from the generated REST client
+module HatchetSdkRest
+  class CreateEventRequest
+    attr_accessor key: String?
+    attr_accessor data: Hash[String, untyped]?
+    attr_accessor additional_metadata: Hash[String, untyped]?
+    attr_accessor priority: Integer?
+    attr_accessor scope: String?
+
+    def self.new: (
+      ?key: String,
+      ?data: Hash[String, untyped],
+      ?additional_metadata: Hash[String, untyped],
+      ?priority: Integer,
+      ?scope: String
+    ) -> instance
+
+    def initialize: (
+      ?key: String,
+      ?data: Hash[String, untyped],
+      ?additional_metadata: Hash[String, untyped],
+      ?priority: Integer,
+      ?scope: String
+    ) -> void
+  end
+
+  class BulkCreateEventRequest
+    attr_accessor events: Array[CreateEventRequest]?
+
+    def self.new: (?events: Array[CreateEventRequest]) -> instance
+    def initialize: (?events: Array[CreateEventRequest]) -> void
+  end
+
+  class V1EventList
+    attr_accessor rows: Array[untyped]?
+    attr_accessor pagination: untyped?
+
+    def self.new: (?rows: Array[untyped], ?pagination: untyped) -> instance
+    def initialize: (?rows: Array[untyped], ?pagination: untyped) -> void
+  end
+
+  class CancelEventRequest
+    attr_accessor event_ids: Array[String]?
+    attr_accessor keys: Array[String]?
+    attr_accessor since: String?
+    attr_accessor until: String?
+
+    def self.new: (
+      ?event_ids: Array[String],
+      ?keys: Array[String],
+      ?since: String,
+      ?until: String
+    ) -> instance
+
+    def initialize: (
+      ?event_ids: Array[String],
+      ?keys: Array[String],
+      ?since: String,
+      ?until: String
+    ) -> void
+  end
+
+  class ReplayEventRequest
+    attr_accessor event_ids: Array[String]?
+    attr_accessor keys: Array[String]?
+    attr_accessor since: String?
+    attr_accessor until: String?
+
+    def self.new: (
+      ?event_ids: Array[String],
+      ?keys: Array[String],
+      ?since: String,
+      ?until: String
+    ) -> instance
+
+    def initialize: (
+      ?event_ids: Array[String],
+      ?keys: Array[String],
+      ?since: String,
+      ?until: String
+    ) -> void
+  end
+
+  class V1TaskFilter
+    attr_accessor since: String?
+    attr_accessor until: String?
+    attr_accessor statuses: Array[untyped]?
+    attr_accessor workflow_ids: Array[String]?
+    attr_accessor additional_metadata: Array[Hash[String, String]]?
+
+    def self.new: (
+      ?since: String,
+      ?until: String,
+      ?statuses: Array[untyped],
+      ?workflow_ids: Array[String],
+      ?additional_metadata: Array[Hash[String, String]]
+    ) -> instance
+
+    def initialize: (
+      ?since: String,
+      ?until: String,
+      ?statuses: Array[untyped],
+      ?workflow_ids: Array[String],
+      ?additional_metadata: Array[Hash[String, String]]
+    ) -> void
+  end
+
+  class V1CancelTaskRequest
+    attr_accessor external_ids: Array[String]?
+    attr_accessor filter: V1TaskFilter?
+
+    def self.new: (?external_ids: Array[String], ?filter: V1TaskFilter) -> instance
+    def initialize: (?external_ids: Array[String], ?filter: V1TaskFilter) -> void
+  end
+
+  class V1ReplayTaskRequest
+    attr_accessor external_ids: Array[String]?
+    attr_accessor filter: V1TaskFilter?
+
+    def self.new: (?external_ids: Array[String], ?filter: V1TaskFilter) -> instance
+    def initialize: (?external_ids: Array[String], ?filter: V1TaskFilter) -> void
+  end
+
+  class V1TriggerWorkflowRunRequest
+    attr_accessor workflow_name: String?
+    attr_accessor input: Hash[String, untyped]?
+    attr_accessor additional_metadata: Hash[String, untyped]?
+    attr_accessor priority: Integer?
+
+    def self.new: (
+      ?workflow_name: String,
+      ?input: Hash[String, untyped],
+      ?additional_metadata: Hash[String, untyped],
+      ?priority: Integer
+    ) -> instance
+
+    def initialize: (
+      ?workflow_name: String,
+      ?input: Hash[String, untyped],
+      ?additional_metadata: Hash[String, untyped],
+      ?priority: Integer
+    ) -> void
+  end
+
+  class V1WorkflowRunDetails
+    attr_accessor run: untyped?
+
+    def self.new: (?run: untyped) -> instance
+    def initialize: (?run: untyped) -> void
+  end
+
+  class V1TaskSummary
+    attr_accessor metadata: untyped?
+    attr_accessor created_at: Time?
+
+    def self.new: (?metadata: untyped, ?created_at: Time) -> instance
+    def initialize: (?metadata: untyped, ?created_at: Time) -> void
+  end
+
+  class V1TaskSummaryList
+    attr_accessor rows: Array[V1TaskSummary]?
+
+    def self.new: (?rows: Array[V1TaskSummary]) -> instance
+    def initialize: (?rows: Array[V1TaskSummary]) -> void
+  end
+
+  class V1TaskStatus
+    def self.COMPLETED: () -> String
+    def self.CANCELLED: () -> String
+    def self.FAILED: () -> String
+  end
+
+  class WorkflowRunStatus
+    def self.SUCCEEDED: () -> String
+    def self.FAILED: () -> String
+    def self.CANCELLED: () -> String
+  end
+
+  class EventApi
+    def self.new: (untyped api_client) -> instance
+    def initialize: (untyped api_client) -> void
+  end
+
+  class WorkflowRunsApi
+    def self.new: (untyped api_client) -> instance
+    def initialize: (untyped api_client) -> void
+  end
+
+  class TaskApi
+    def self.new: (untyped api_client) -> instance
+    def initialize: (untyped api_client) -> void
+  end
 end