conductor_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eaac8568f7cf211e8337d9c41ccf454d9362d8c1b5f4d8adefb2a6f2faff64e
+  data.tar.gz: 5c34b569b0080d6ea6ea2b20411614076ba1fbefd5de6901ea581a917f3ac30c
+SHA512:
+  metadata.gz: 364e5f398619c081bc979e0158d15daf6cbe2df9f2b548e90d81d8811da900c828f88a34e619a992e0847ce210ae24f0fe3a4a6b29fff6c2e3ce743bdbbe81eb
+  data.tar.gz: 66b81f3609e971ce064ab042287fea9e96e9ce197765d1ba5cf46b5265583f37f73311cec754f6ef97ec03b28391e310809cbb7504e4ce147dd8519f7086e12c

data/CHANGELOG.md

@@ -0,0 +1,142 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0]
+
+### Added
+
+- Canonical (harmonized) metrics as the sole metric surface -- [details](docs/METRICS_AND_INTERCEPTORS.md#detailed-technical-notes----unreleased)
+- Bounded `uri` label on `http_api_client_request_seconds`: uses path templates (e.g. `/workflow/{workflowId}`) instead of fully-resolved paths, preventing metric cardinality explosion
+- `WorkflowStatusProbe` in harness: opt-in probe (via `HARNESS_PROBE_RATE_PER_SEC`) that exercises UUID-bearing endpoints to validate template URI metrics
+
+### Changed
+
+- **BREAKING: Workflow DSL Redesign** - Complete redesign of the workflow DSL for Ruby-idiomatic syntax
+  - New entry point: `Conductor.workflow :name do...end` instead of `ConductorWorkflow.new`
+  - Block-based workflow definition with method chaining
+  - Output references using `task[:field]` syntax instead of `task.output('field')`
+  - Input references using `wf[:param]` syntax instead of `workflow.input('param')`
+  - Control flow blocks: `parallel do`, `decide expr do`, `loop_over items do`
+  - Auto-generated task reference names
+  - Simplified LLM task methods with hash-to-ChatMessage auto-conversion
+- HTTP request timing (`http_api_client_request_seconds`) is zero-overhead when no collector is active: `RestClient` only enters the timing path when a `MetricsCollector` is subscribed to `GlobalDispatcher`
+- `thread_uncaught_exceptions_total` is no longer incremented for caught exceptions in the polling loop; the metric surface is retained but unwired, matching the Python and JavaScript SDKs
+- `MetricsCollector` responds to `stop`; `TaskHandler#stop` calls it automatically to unsubscribe from process-wide dispatchers
+- `MetricsCollector.create` accepts `measure_payload_size:` (default `true`) to opt out of `workflow_input_size_bytes` JSON serialization overhead
+
+### Removed
+
+- Old DSL classes removed (breaking change):
+  - `ConductorWorkflow` - replaced by `Conductor.workflow` entry point
+  - `TaskInterface` - replaced by `TaskRef` (internal)
+  - Task classes: `SimpleTask`, `SwitchTask`, `ForkTask`, `JoinTask`, `DoWhileTask`, `HttpTask`, `SubWorkflowTask`, `WaitTask`, `TerminateTask`, `SetVariableTask`, `DynamicForkTask`, `JavascriptTask`, `JsonJqTask`, `EventTask`, `HttpPollTask`, `DynamicTask`, `HumanTask`, `StartWorkflowTask`, `KafkaPublishTask`, `WaitForWebhookTask`
+  - LLM task classes: `LlmChatCompleteTask`, `LlmTextCompleteTask`, `LlmGenerateEmbeddingsTask`, `LlmIndexTextTask`, `LlmIndexDocumentTask`, `LlmSearchIndexTask`, `LlmQueryEmbeddingsTask`, `LlmStoreEmbeddingsTask`, `LlmSearchEmbeddingsTask`, `GenerateImageTask`, `GenerateAudioTask`, `GetDocumentTask`, `ListMcpToolsTask`, `CallMcpToolTask`
+
+### Migration Guide
+
+**Before (old DSL):**
+```ruby
+include Conductor::Workflow
+workflow = ConductorWorkflow.new(client, 'my_workflow', version: 1)
+task = SimpleTask.new('greet', 'greet_ref').input('name', workflow.input('name'))
+workflow >> task
+workflow.output_parameter('result', task.output('result'))
+```
+
+**After (new DSL):**
+```ruby
+workflow = Conductor.workflow :my_workflow, version: 1, executor: executor do
+  task = simple :greet, name: wf[:name]
+  output result: task[:result]
+end
+```
+
+## [Unreleased] - 2026-02-09
+
+### Added
+
+- **Core Infrastructure**
+  - Configuration with environment variable support
+  - Authentication (token management, TTL refresh, exponential backoff)
+  - HTTP Transport using Faraday with retry, connection pooling, SSL support
+  - ApiClient with serialization/deserialization and auth injection
+  - Exception hierarchy (ApiError, AuthenticationError, etc.)
+
+- **Resource APIs (17 classes)**
+  - WorkflowResourceApi - Workflow operations
+  - TaskResourceApi - Task operations
+  - MetadataResourceApi - Workflow/task definitions
+  - SchedulerResourceApi - Schedule management
+  - EventResourceApi - Event handlers
+  - WorkflowBulkResourceApi - Bulk operations
+  - PromptResourceApi - AI prompt management
+  - SecretResourceApi - Secret management
+  - IntegrationResourceApi - External integrations
+  - SchemaResourceApi - JSON schema management
+  - AuthorizationResourceApi - Permissions
+  - ApplicationResourceApi - Application management
+  - UserResourceApi - User management
+  - GroupResourceApi - Group management
+  - RoleResourceApi - Role management
+  - TokenResourceApi - Token operations
+  - GatewayAuthResourceApi - Gateway authentication
+
+- **High-Level Clients (9 classes)**
+  - WorkflowClient - Workflow operations
+  - TaskClient - Task operations
+  - MetadataClient - Metadata operations
+  - SchedulerClient - Schedule management
+  - PromptClient - AI prompts
+  - SecretClient - Secrets
+  - IntegrationClient - Integrations
+  - SchemaClient - Schemas
+  - AuthorizationClient - Authorization
+
+- **Worker Framework**
+  - Worker module with DSL for task definition
+  - Class-based workers using `include Conductor::Worker::WorkerModule`
+  - Block-based workers using `Conductor::Worker.define`
+  - TaskRunner with multi-threaded polling and execution
+  - FiberExecutor for lightweight concurrency
+  - RactorTaskRunner for true parallelism (Ruby 3+)
+  - Telemetry with Prometheus metrics backend
+  - Event system for task lifecycle hooks
+
+- **Workflow DSL (25+ task types)**
+  - Control Flow: SimpleTask, SwitchTask, ForkTask, JoinTask, DoWhileTask, DynamicTask, DynamicForkTask, SubWorkflowTask
+  - System Tasks: HttpTask, HttpPollTask, EventTask, WaitTask, WaitForWebhookTask, TerminateTask, SetVariableTask, JsonJqTask, JavascriptTask, KafkaPublishTask, StartWorkflowTask, HumanTask
+  - LLM/AI Tasks: LlmChatCompleteTask, LlmTextCompleteTask, LlmGenerateEmbeddingsTask, LlmIndexTextTask, LlmIndexDocumentTask, LlmSearchIndexTask, LlmQueryEmbeddingsTask, LlmSearchEmbeddingsTask, LlmStoreEmbeddingsTask, GenerateImageTask, GenerateAudioTask, GetDocumentTask, CallMcpToolTask, ListMcpToolsTask
+
+- **OrkesClients Factory**
+  - Single entry point for all client creation
+  - WorkflowExecutor for synchronous workflow execution
+
+- **Models (50+ classes)**
+  - HTTP models for all API request/response types
+  - Orkes-specific models (MetadataTag, RateLimitTag, etc.)
+
+- **Examples**
+  - `helloworld/` - Simplest complete example
+  - `simple_worker.rb` - Worker implementation patterns
+  - `simple_workflow.rb` - Basic workflow client usage
+  - `workflow_dsl.rb` - Comprehensive DSL examples
+  - `dynamic_workflow.rb` - Runtime workflow creation
+  - `kitchensink.rb` - All major task types demo
+  - `workflow_ops.rb` - Workflow lifecycle operations
+
+- **Testing**
+  - 281 unit tests
+  - 110 integration tests covering all major API categories
+  - Tests for Scheduler, Events, Bulk Operations, Workflow, Task, Prompt APIs
+
+### Notes
+
+- Full feature parity with Python SDK
+- Supports both OSS Conductor and Orkes Cloud
+- Ruby 2.6+ compatible (Ruby 3+ recommended for Ractor support)
+
+[0.1.0]: https://github.com/conductor-oss/ruby-sdk/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,190 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Conductor OSS
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.