conductor_ruby 0.1.0

data/examples/workflow_ops.rb

@@ -0,0 +1,305 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Workflow Operations Example
+# ============================
+#
+# Demonstrates various workflow lifecycle operations and control mechanisms.
+#
+# What it does:
+# -------------
+# - Start workflow: Create and execute a new workflow instance
+# - Pause workflow: Temporarily halt workflow execution
+# - Resume workflow: Continue paused workflow
+# - Terminate workflow: Force stop a running workflow
+# - Restart workflow: Restart from a specific task
+# - Rerun workflow: Re-execute from beginning with same/different inputs
+# - Update task: Manually update task status and output
+# - Search workflows: Find workflows by correlation ID or query
+#
+# Use Cases:
+# ----------
+# - Workflow lifecycle management (start, pause, resume, terminate)
+# - Manual intervention in workflow execution
+# - Debugging and testing workflows
+# - Implementing human-in-the-loop patterns
+# - External event handling via task updates
+# - Recovery from failures (restart, rerun)
+#
+# Key Operations:
+# ---------------
+# - start_workflow(): Launch new workflow instance
+# - pause_workflow(): Halt at current task
+# - resume_workflow(): Continue from pause
+# - terminate_workflow(): Force stop with reason
+# - restart_workflow(): Resume from failed task
+# - rerun_workflow(): Start fresh with new/same inputs
+# - update_task(): Manually complete tasks
+#
+# Usage:
+#   bundle exec ruby examples/workflow_ops.rb
+
+require 'securerandom'
+require_relative '../lib/conductor'
+
+# Include workflow DSL
+include Conductor::Workflow
+
+def start_demo_workflow(workflow_executor, workflow_client)
+  # Create a workflow with wait tasks for demonstrating operations
+  workflow = ConductorWorkflow.new(workflow_client, 'workflow_ops_demo', version: 1, executor: workflow_executor)
+
+  # Wait for 2 seconds
+  wait_for_two_sec = WaitTask.new('wait_for_2_sec', wait_for_seconds: 2)
+
+  # Wait for external signal (no timeout - waits indefinitely until updated)
+  wait_for_signal = WaitTask.new('wait_for_signal')
+
+  # HTTP call
+  http_call = HttpTask.new('call_remote_api', {
+                             'uri' => 'https://orkes-api-tester.orkesconductor.com/api'
+                           })
+
+  # Build workflow
+  workflow >> wait_for_two_sec >> wait_for_signal >> http_call
+
+  # Register the workflow
+  workflow_executor.register_workflow(workflow, overwrite: true)
+
+  # Start workflow with a correlation ID
+  request = Conductor::Http::Models::StartWorkflowRequest.new(
+    name: 'workflow_ops_demo',
+    version: 1,
+    input: {},
+    correlation_id: 'correlation_123'
+  )
+
+  workflow_executor.start_workflow(request)
+end
+
+def main
+  # Configuration from environment variables
+  config = Conductor::Configuration.new
+
+  puts '=' * 70
+  puts 'Conductor Ruby SDK - Workflow Operations Example'
+  puts '=' * 70
+  puts
+  puts "Server: #{config.server_url}"
+  puts
+
+  # Create clients
+  clients = Conductor::Orkes::OrkesClients.new(config)
+  workflow_client = clients.get_workflow_client
+  task_client = clients.get_task_client
+  workflow_executor = clients.get_workflow_executor
+
+  # ============================================================================
+  # START WORKFLOW
+  # ============================================================================
+
+  workflow_id = start_demo_workflow(workflow_executor, workflow_client)
+  puts "Started workflow with ID: #{workflow_id}"
+  puts "Monitor at: #{config.ui_host}/execution/#{workflow_id}"
+  puts
+
+  # ============================================================================
+  # GET WORKFLOW STATUS
+  # ============================================================================
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  last_task = workflow['tasks'].last
+  puts "Workflow status: #{workflow['status']}"
+  puts "Currently running task: #{last_task['referenceTaskName']}"
+  puts
+
+  # ============================================================================
+  # WAIT FOR TIMED WAIT TO COMPLETE
+  # ============================================================================
+
+  puts 'Waiting 3 seconds for the timed wait task to complete...'
+  sleep 3
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  last_task = workflow['tasks'].last
+  puts "Workflow status: #{workflow['status']}"
+  puts "Currently running task: #{last_task['referenceTaskName']}"
+  puts
+
+  # ============================================================================
+  # TERMINATE WORKFLOW
+  # ============================================================================
+
+  puts 'Terminating workflow...'
+  workflow_client.terminate_workflow(workflow_id, reason: 'testing termination')
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  last_task = workflow['tasks'].last
+  puts "Workflow status: #{workflow['status']}"
+  puts "Last task status: #{last_task['status']}"
+  puts
+
+  # ============================================================================
+  # RETRY WORKFLOW
+  # ============================================================================
+
+  puts 'Retrying workflow...'
+  workflow_client.retry_workflow(workflow_id)
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  last_task = workflow['tasks'].last
+  puts "Workflow status: #{workflow['status']}"
+  puts "Last task: #{last_task['referenceTaskName']} (status: #{last_task['status']})"
+  puts
+
+  # ============================================================================
+  # MANUALLY COMPLETE WAIT TASK
+  # ============================================================================
+
+  puts 'Manually completing the wait_for_signal task...'
+
+  # Create task result to complete the WAIT task
+  task_result = Conductor::Http::Models::TaskResult.new(
+    workflow_instance_id: workflow_id,
+    task_id: last_task['taskId'],
+    status: 'COMPLETED',
+    output_data: { 'greetings' => 'hello from Conductor Ruby SDK' }
+  )
+  task_client.update_task(task_result)
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  last_task = workflow['tasks'].last
+  puts "Workflow status: #{workflow['status']}"
+  puts "Last task: #{last_task['referenceTaskName']} (status: #{last_task['status']})"
+
+  # Wait for HTTP task to complete
+  sleep 2
+
+  # ============================================================================
+  # RERUN WORKFLOW
+  # ============================================================================
+
+  puts
+  puts 'Re-running workflow from the second task...'
+
+  # Get the workflow again to find the second task
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+
+  if workflow['tasks'].length > 1
+    second_task_id = workflow['tasks'][1]['taskId']
+
+    rerun_request = {
+      're_run_from_task_id' => second_task_id
+    }
+    workflow_client.rerun_workflow(workflow_id, rerun_request)
+
+    workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+    puts "Workflow status after rerun: #{workflow['status']}"
+  end
+
+  # ============================================================================
+  # RESTART WORKFLOW
+  # ============================================================================
+
+  puts
+  puts 'Terminating and restarting workflow...'
+
+  workflow_client.terminate_workflow(workflow_id, reason: 'terminating so we can restart')
+  workflow_client.restart_workflow(workflow_id)
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  puts "Workflow status after restart: #{workflow['status']}"
+
+  # ============================================================================
+  # PAUSE AND RESUME WORKFLOW
+  # ============================================================================
+
+  puts
+  puts 'Pausing workflow...'
+  workflow_client.pause_workflow(workflow_id)
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  puts "Workflow status: #{workflow['status']}"
+
+  puts 'Waiting 3 seconds while paused...'
+  sleep 3
+
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  # While paused, wait task may complete but no new tasks scheduled
+  wait_task = workflow['tasks'].first
+  puts "Wait task status: #{wait_task['status']}"
+  puts "Number of tasks: #{workflow['tasks'].length} (should be limited while paused)"
+
+  puts
+  puts 'Resuming workflow...'
+  workflow_client.resume_workflow(workflow_id)
+
+  sleep 1
+  workflow = workflow_client.get_workflow(workflow_id, include_tasks: true)
+  puts "Workflow status after resume: #{workflow['status']}"
+  puts "Number of tasks after resume: #{workflow['tasks'].length}"
+
+  # ============================================================================
+  # SEARCH WORKFLOWS
+  # ============================================================================
+
+  puts
+  puts 'Searching for workflows with correlation_id "correlation_123"...'
+
+  search_results = workflow_client.search(
+    start: 0,
+    size: 100,
+    free_text: '*',
+    query: 'correlationId = "correlation_123"'
+  )
+
+  puts "Found #{search_results['results']&.length || 0} workflow(s) with correlation_id 'correlation_123'"
+
+  # Search for a random correlation ID (should find nothing)
+  random_correlation_id = SecureRandom.uuid
+  search_results = workflow_client.search(
+    start: 0,
+    size: 100,
+    free_text: '*',
+    query: "status IN (RUNNING) AND correlationId = \"#{random_correlation_id}\""
+  )
+
+  puts "Found #{search_results['results']&.length || 0} workflow(s) with random correlation_id (expected: 0)"
+
+  # ============================================================================
+  # CLEANUP
+  # ============================================================================
+
+  puts
+  puts 'Terminating workflow for cleanup...'
+  workflow_client.terminate_workflow(workflow_id, reason: 'cleanup after demo')
+
+  puts
+  puts '-' * 70
+  puts 'Workflow Operations Demo Complete!'
+  puts '-' * 70
+  puts
+  puts 'Operations demonstrated:'
+  puts '  - Start workflow'
+  puts '  - Get workflow status'
+  puts '  - Terminate workflow'
+  puts '  - Retry workflow'
+  puts '  - Update task manually'
+  puts '  - Rerun workflow from task'
+  puts '  - Restart workflow'
+  puts '  - Pause workflow'
+  puts '  - Resume workflow'
+  puts '  - Search workflows'
+end
+
+if __FILE__ == $PROGRAM_NAME
+  begin
+    main
+  rescue Conductor::ApiError => e
+    puts "API Error: #{e.message}"
+    puts e.backtrace.first(5).join("\n")
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    puts e.backtrace.first(5).join("\n")
+  end
+end

data/lib/conductor/client/authorization_client.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Conductor
+  module Client
+    # AuthorizationClient - High-level client for authorization operations (Orkes)
+    # Delegates to 6 resource APIs: application, user, group, authorization, role, token, gateway_auth
+    class AuthorizationClient
+      def initialize(api_client)
+        @application_api = Http::Api::ApplicationResourceApi.new(api_client)
+        @user_api = Http::Api::UserResourceApi.new(api_client)
+        @group_api = Http::Api::GroupResourceApi.new(api_client)
+        @authorization_api = Http::Api::AuthorizationResourceApi.new(api_client)
+        @role_api = Http::Api::RoleResourceApi.new(api_client)
+        @token_api = Http::Api::TokenResourceApi.new(api_client)
+        @gateway_auth_api = Http::Api::GatewayAuthResourceApi.new(api_client)
+      end
+
+      # === Applications ===
+
+      def create_application(request)
+        @application_api.create_application(request)
+      end
+
+      def get_application(application_id)
+        @application_api.get_application(application_id)
+      end
+
+      def list_applications
+        @application_api.list_applications
+      end
+
+      def update_application(request, application_id)
+        @application_api.update_application(request, application_id)
+      end
+
+      def delete_application(application_id)
+        @application_api.delete_application(application_id)
+      end
+
+      def add_role_to_application_user(application_id, role)
+        @application_api.add_role_to_application_user(application_id, role)
+      end
+
+      def remove_role_from_application_user(application_id, role)
+        @application_api.remove_role_from_application_user(application_id, role)
+      end
+
+      def set_application_tags(tags, application_id)
+        @application_api.put_tags_for_application(tags, application_id)
+      end
+
+      def get_application_tags(application_id)
+        @application_api.get_tags_for_application(application_id)
+      end
+
+      def delete_application_tags(tags, application_id)
+        @application_api.delete_tags_for_application(tags, application_id)
+      end
+
+      def create_access_key(application_id)
+        @application_api.create_access_key(application_id)
+      end
+
+      def get_access_keys(application_id)
+        @application_api.get_access_keys(application_id)
+      end
+
+      def toggle_access_key_status(application_id, key_id)
+        @application_api.toggle_access_key_status(application_id, key_id)
+      end
+
+      def delete_access_key(application_id, key_id)
+        @application_api.delete_access_key(application_id, key_id)
+      end
+
+      def get_app_by_access_key_id(access_key_id)
+        @application_api.get_app_by_access_key_id(access_key_id)
+      end
+
+      # === Users ===
+
+      def upsert_user(request, user_id)
+        @user_api.upsert_user(request, user_id)
+      end
+
+      def get_user(user_id)
+        @user_api.get_user(user_id)
+      end
+
+      def list_users(apps: false)
+        @user_api.list_users(apps: apps)
+      end
+
+      def delete_user(user_id)
+        @user_api.delete_user(user_id)
+      end
+
+      def check_permissions(user_id, target_type, target_id)
+        @user_api.check_permissions(user_id, target_type, target_id)
+      end
+
+      def get_granted_permissions_for_user(user_id)
+        @user_api.get_granted_permissions(user_id)
+      end
+
+      # === Groups ===
+
+      def upsert_group(request, group_id)
+        @group_api.upsert_group(request, group_id)
+      end
+
+      def get_group(group_id)
+        @group_api.get_group(group_id)
+      end
+
+      def list_groups
+        @group_api.list_groups
+      end
+
+      def delete_group(group_id)
+        @group_api.delete_group(group_id)
+      end
+
+      def add_user_to_group(group_id, user_id)
+        @group_api.add_user_to_group(group_id, user_id)
+      end
+
+      def get_users_in_group(group_id)
+        @group_api.get_users_in_group(group_id)
+      end
+
+      def remove_user_from_group(group_id, user_id)
+        @group_api.remove_user_from_group(group_id, user_id)
+      end
+
+      def add_users_to_group(group_id, user_ids)
+        @group_api.add_users_to_group(group_id, user_ids)
+      end
+
+      def remove_users_from_group(group_id, user_ids)
+        @group_api.remove_users_from_group(group_id, user_ids)
+      end
+
+      def get_granted_permissions_for_group(group_id)
+        @group_api.get_granted_permissions(group_id)
+      end
+
+      # === Permissions ===
+
+      def grant_permissions(subject, target, access)
+        request = Http::Models::AuthorizationRequest.new(
+          subject: subject, target: target, access: access
+        )
+        @authorization_api.grant_permissions(request)
+      end
+
+      def get_permissions(target)
+        @authorization_api.get_permissions(target.type, target.id)
+      end
+
+      def remove_permissions(subject, target, access)
+        request = Http::Models::AuthorizationRequest.new(
+          subject: subject, target: target, access: access
+        )
+        @authorization_api.remove_permissions(request)
+      end
+
+      # === Tokens ===
+
+      def generate_token(key_id, key_secret)
+        request = Http::Models::GenerateTokenRequest.new(
+          key_id: key_id, key_secret: key_secret
+        )
+        @token_api.generate_token(request)
+      end
+
+      def get_user_info_from_token
+        @token_api.get_user_info
+      end
+
+      # === Roles ===
+
+      def list_all_roles
+        @role_api.list_all_roles
+      end
+
+      def list_system_roles
+        @role_api.list_system_roles
+      end
+
+      def list_custom_roles
+        @role_api.list_custom_roles
+      end
+
+      def list_available_permissions
+        @role_api.list_available_permissions
+      end
+
+      def create_role(request)
+        @role_api.create_role(request)
+      end
+
+      def get_role(role_name)
+        @role_api.get_role(role_name)
+      end
+
+      def update_role(role_name, request)
+        @role_api.update_role(role_name, request)
+      end
+
+      def delete_role(role_name)
+        @role_api.delete_role(role_name)
+      end
+
+      # === Gateway Auth Config ===
+
+      def create_gateway_auth_config(auth_config)
+        @gateway_auth_api.create_config(auth_config)
+      end
+
+      def get_gateway_auth_config(config_id)
+        @gateway_auth_api.get_config(config_id)
+      end
+
+      def list_gateway_auth_configs
+        @gateway_auth_api.list_configs
+      end
+
+      def update_gateway_auth_config(config_id, auth_config)
+        @gateway_auth_api.update_config(config_id, auth_config)
+      end
+
+      def delete_gateway_auth_config(config_id)
+        @gateway_auth_api.delete_config(config_id)
+      end
+    end
+  end
+end

data/lib/conductor/client/integration_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Conductor
+  module Client
+    # IntegrationClient - High-level client for integration management operations (Orkes)
+    class IntegrationClient
+      def initialize(api_client)
+        @integration_api = Http::Api::IntegrationResourceApi.new(api_client)
+      end
+
+      # === Integration Providers ===
+
+      def save_integration(integration_name, integration_details)
+        @integration_api.save_integration(integration_details, integration_name)
+      end
+
+      def get_integration(integration_name)
+        @integration_api.get_integration(integration_name)
+      end
+
+      def get_integrations
+        @integration_api.get_integrations
+      end
+
+      def delete_integration(integration_name)
+        @integration_api.delete_integration(integration_name)
+      end
+
+      # === Integration APIs ===
+
+      def save_integration_api(integration_name, api_name, api_details)
+        @integration_api.save_integration_api(api_details, integration_name, api_name)
+      end
+
+      def get_integration_api(api_name, integration_name)
+        @integration_api.get_integration_api(integration_name, api_name)
+      end
+
+      def get_integration_apis(integration_name)
+        @integration_api.get_integration_apis(integration_name)
+      end
+
+      def delete_integration_api(api_name, integration_name)
+        @integration_api.delete_integration_api(integration_name, api_name)
+      end
+
+      # === Prompts ===
+
+      def associate_prompt_with_integration(ai_integration, model_name, prompt_name)
+        @integration_api.associate_prompt_with_integration(ai_integration, model_name, prompt_name)
+      end
+
+      def get_prompts_with_integration(ai_integration, model_name)
+        @integration_api.get_prompts_with_integration(ai_integration, model_name)
+      end
+
+      # === Token Usage ===
+
+      def get_token_usage_for_integration(name, integration_name)
+        @integration_api.get_token_usage_for_integration(name, integration_name)
+      end
+
+      def get_token_usage_for_integration_provider(name)
+        @integration_api.get_token_usage_for_integration_provider(name)
+      end
+
+      # === Tags ===
+
+      def put_tag_for_integration(body, name, integration_name)
+        @integration_api.put_tag_for_integration(body, name, integration_name)
+      end
+
+      def get_tags_for_integration(name, integration_name)
+        @integration_api.get_tags_for_integration(name, integration_name)
+      end
+
+      def delete_tag_for_integration(body, name, integration_name)
+        @integration_api.delete_tag_for_integration(body, name, integration_name)
+      end
+
+      def put_tag_for_integration_provider(body, name)
+        @integration_api.put_tag_for_integration_provider(body, name)
+      end
+
+      def get_tags_for_integration_provider(name)
+        @integration_api.get_tags_for_integration_provider(name)
+      end
+
+      def delete_tag_for_integration_provider(body, name)
+        @integration_api.delete_tag_for_integration_provider(body, name)
+      end
+
+      # === Discovery ===
+
+      def get_integration_available_apis(integration_name)
+        @integration_api.get_integration_available_apis(integration_name)
+      end
+
+      def get_integration_provider_defs
+        @integration_api.get_integration_provider_defs
+      end
+
+      def get_providers_and_integrations
+        @integration_api.get_providers_and_integrations
+      end
+    end
+  end
+end