temporalio 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a772f8c38831abb97dc31fa9be30ffc543dbb40194eaac1d18205af6a40dac72
-  data.tar.gz: 5a89f5c305501c0a926167d2736c06b8d9269a59f9dd9128e87abf6f5f569b42
+  metadata.gz: c61a784d88682c42f1dae18ee88ce556f6f705914abccf793f7a37ae4877bb83
+  data.tar.gz: 72a8f479f63d3acad8944eee20f4eb53f2db84e6304c930d29d2180e4181100f
 SHA512:
-  metadata.gz: cec1c83612f01cc1affb6b22bfcad392d0611af378cb6cc6db3c77e91be1448f1d41f886f51fc3db3bc3756c74aa870de55dd3e2d3e982e2a4f9ef625e2f41a2
-  data.tar.gz: dd7bad401f055148dd59aaf88b62594b80daea1028d89ebcfe65d5612237b98fdb6b8ca92181e2ca0a88bc009af13e754ad1b2e0b5af923a51279db581b7dabc
+  metadata.gz: c6d6e559f5f71e48d823acef13e32576fc61d589882f35c6ba5b2bbd5addd83bfbab0cf76480de6895e9afa005c2fa9a8fa2dd973048443fd152d5057ea9724f
+  data.tar.gz: 1cab9eb98faaa44e715f046870bcc83a64a979720da6ef28c1ff5dd0a600041cd7f32a4bdc44afcc9b4576171d07b36fe80c7eb7815c5a5c83f52c51f96cb16e

data/README.md

@@ -0,0 +1,130 @@
+# Temporal Ruby SDK
+
+[![CI status](https://github.com/temporalio/sdk-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/temporalio/sdk-ruby/actions/workflows/ci.yml?query=branch%3Amain)
+[![Build](https://github.com/temporalio/sdk-ruby/actions/workflows/build-native-ext.yml/badge.svg)](https://github.com/temporalio/sdk-ruby/actions/workflows/build-native-ext.yml?query=branch%3Amain+event%3Arelease)
+[![Gem Version](https://badge.fury.io/rb/temporalio.svg)](https://rubygems.org/gems/temporalio)
+
+[Temporal](https://temporal.io/) is a distributed, scalable, durable, and highly available
+orchestration engine used to execute asynchronous long-running business logic in a scalable and
+resilient way.
+
+"Temporal Ruby SDK" is the framework for authoring workflows and activities using the Ruby
+programming language.
+
+⚠️ UNDER DEVELOPMENT
+
+The Ruby SDK is under development. There are no compatibility guarantees at this time.
+
+At this point the SDK only supports the **Temporal Client** capabilities:
+
+- Starting a workflow (defined in any other SDK)
+- Interacting with a workflow (cancelling, querying, signalling, etc)
+- Interceptor and Data Conversion support
+- gRPC access to Temporal Server
+- Temporal Cloud is not yet supported due to the lack of TLS support, but it's coming soon
+
+
+## Quick Start
+
+### Installation
+
+Add the [`temporalio` gem](https://rubygems.org/gems/temporalio) to your Gemfile:
+
+```ruby
+gem 'temporalio'
+```
+
+The SDK is now ready for use. To build from source, see [Dev Setup](#dev-setup).
+
+**NOTE: This README is for the current branch and not necessarily what's released on RubyGems.**
+
+
+## Usage
+
+### Client
+
+A client can be created and used to start a workflow like so:
+
+```ruby
+# Establish a gRPC connection to the server
+connection = Temporal::Connection.new('localhost:7233')
+
+# Initialize a Client with a namespace
+client = Temporal::Client.new(connection, 'my-namespace')
+
+# Start a workflow
+handle = client.start_workflow('MyWorkflow', 'some input', id: 'my-id', task_queue: 'my-task-queue')
+
+# Wait for the workflow to finish processing
+result = handle.result
+puts "Result: #{result}"
+```
+
+Some things to note about the above code:
+
+- A `Client` does not have an explicit "close"
+- TLS is not yet supported
+- All positional arguments after the workflow name are treated as workflow arguments
+- The `handle` represents the workflow that was started and can be used for more than just getting
+  the result
+- Clients can have many more options not shown here (e.g. data converters and interceptors)
+
+### Data Conversion
+
+Data converters are used to convert raw Temporal payloads to/from actual Ruby types. These consist
+of 3 distinct types of converters:
+
+- **Payload Converters** to convert Ruby values to/from serialized bytes
+- **Payload Codecs** to convert bytes to bytes (e.g. for compression or encryption)
+- **Failure Converters** to convert exceptions to/from serialized failures
+
+The default data converter supports converting multiple types including:
+
+- `nil`
+- bytes (`String` with `Encoding::ASCII_8BIT`)
+- Anything that [`JSON.generate`](https://ruby-doc.org/stdlib-3.0.0/libdoc/json/rdoc/JSON.html#method-i-generate)
+  supports
+
+This notably doesn't include any `Date`, `Time`, or `DateTime` objects as they may not work across
+different SDKs. A custom payload converter can be implemented to support these.
+
+
+## Dev Setup
+
+Once you've forked/cloned the repository you want to make sure all the submodules are fetched as
+well. You can do that using:
+
+```sh
+> git submodule update --recursive
+```
+
+From there you should be able to install all the Ruby gems using:
+
+```sh
+> bundle install
+```
+
+In order to compile the Rust Bridge you need to have `rust`, `cargo` and `rustup` installed. You
+will also need to install the `rustfmt` component:
+
+```sh
+> rustup component add rustfmt
+```
+
+Now you should be able to compile a dev build of the Bridge:
+
+```sh
+> bundle exec rake bridge:build
+```
+
+You can then run all the specs against a dev build using:
+
+```sh
+> bundle exec rspec
+```
+
+And open an IRB session using:
+
+```sh
+> bundle console
+```