Merge pull request #2 from cretz/activity-worker

Activity worker sample

Author: cretz

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: Continuous Integration
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - "releases/*"
+
+jobs:
+  build-lint-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-12, macos-latest]
+        # Earliest and latest supported
+        rubyVersion: ["3.1", "3.3"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.rubyVersion }}
+
+      - name: Install bundle
+        run: bundle install
+
+      - name: Lint and test
+        run: bundle exec rake TESTOPTS="--verbose"

.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+## Creating a sample
+
+When creating a sample, do the following:
+
+* Create a dir for the entire sample to live in, using underscores as word separators
+* Add code to sample dir that:
+  * Separates workers from starters
+  * Separates main/primary code from testable, modular code (latter should be in module named after the sample dir)
+* If needed, add tests in `test/<sample-dir>/<subject>_test.rb`
+* Add a `README.md` to sample dir that:
+  * Has high-level overview of what the sample shows
+  * Links to original `../README.md` for prerequisites
+  * Explains any additional setup steps
+  * Explains what to run and when/how to see desired result
+  * Adds anything else necessary to understand the sample
+* Add the sample dir to the root `README.md` bulleted list (keep list in alphabetical order)
+* Add any extra dependencies the sample requires to the root `Gemfile` as a group named after the sample (keep groups in
+  alphabetical order)
+* Add any extra tasks the sample requires to the root `Rakefile` under a namespace named after the sample (keep
+  namespaces in alphabetical order)

Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'temporalio'
+
+group :development do
+  gem 'minitest'
+  gem 'rake'
+  gem 'rubocop'
+end

README.md

@@ -1 +1,28 @@
-⚠️ UNDER ACTIVE DEVELOPMENT
+# Temporal Ruby SDK Samples
+
+This is the set of Ruby samples for the [Ruby SDK](https://github.com/temporalio/sdk-ruby).
+
+⚠️ UNDER ACTIVE DEVELOPMENT
+
+The Ruby SDK is under active development and has not released a stable version yet. APIs may change in incompatible ways
+until the SDK is marked stable.
+
+## Usage
+
+Prerequisites:
+
+* Ruby 3.1+
+* Local Temporal server running (can [install CLI](https://docs.temporal.io/cli#install) then
+  [run a dev server](https://docs.temporal.io/cli#start-dev-server))
+* `bundle install` run in the root
+
+## Samples
+
+<!-- Keep this list in alphabetical order -->
+* [activity_worker](activity_worker) - Use Ruby activities from a workflow in another language.
+
+## Development
+
+To check format and test this repository, run:
+
+    bundle exec rake

Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.warning = false
+  t.libs << 'test'
+  t.libs << '.'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %w[rubocop test]

activity_worker/README.md

@@ -0,0 +1,23 @@
+# Activity Worker
+
+This sample shows a Go workflow calling Ruby activity.
+
+To run, first see [README.md](../README.md) for prerequisites. Then, with [Go](https://go.dev/) installed, run the
+following from the [go-workflow] directory in a separate terminal to start the Go workflow worker:
+
+    go run .
+
+Then in another terminal, start the Ruby activity worker from this directory:
+
+    bundle exec ruby activity_worker.rb
+
+Finally in another terminal, use the Ruby client to the workflow from this directory:
+
+    bundle exec ruby starter.rb
+
+The Ruby code will invoke the Go workflow which will execute the Ruby activity and return. The output of the final
+command should be:
+
+```
+Workflow result: Hello, SomeUser!
+```

activity_worker/activity.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'temporalio/activity'
+
+module ActivityWorker
+  # Activity is a class with execute implemented
+  class SayHelloActivity < Temporalio::Activity
+    def execute(name)
+      "Hello, #{name}!"
+    end
+  end
+end

activity_worker/activity_worker.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'activity'
+require 'temporalio/client'
+require 'temporalio/worker'
+
+# Create a client
+client = Temporalio::Client.connect('localhost:7233', 'default')
+
+# Create worker with the client and activity
+worker = Temporalio::Worker.new(
+  client:,
+  task_queue: 'activity-worker-sample',
+  # By providing the class to the activity, it will be instantiated for every
+  # attempt. If we provide an instance (e.g. SayHelloActivity.new), the same
+  # instance is reused.
+  activities: [ActivityWorker::SayHelloActivity]
+)
+
+# Run the worker until SIGINT
+puts 'Starting worker (ctrl+c to exit)'
+worker.run(shutdown_signals: ['SIGINT'])