hatchet-sdk 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04cba5845adc6fdaa4fe8211dcf3326ff8e029d458ea80db7c9aa8018092a466
+  data.tar.gz: 54e7411d0da2caba1198049225642b1242fe25838d62d1b70560fefdd9bc30f5
+SHA512:
+  metadata.gz: cd5c9791787389f7a844f2cb61f9394b31ee8212a8fde4a06701be212683536de20cf78fa5db8c55a8ab03fcab09c190101ef6dd084720a92b66f739d0f2016d
+  data.tar.gz: 86d51a2da75ccd5cdae6c9fd01fb6e18e8956227661f34cd892ad26b517e51ce4add58b93fd212eec92da7621a7c4aa729746ebe39804d79dd8d5ed278f0c62c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-04
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,42 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is the Ruby SDK for Hatchet (gem name: hatchet-sdk), currently in early development (version 0.0.0). The project follows standard Ruby gem conventions with a simple structure containing a main `Hatchet` module with a `Client` class for API key authentication.
+
+## Common Commands
+
+**Testing:**
+- `rake spec` or `bundle exec rspec` - Run all tests
+- `rspec spec/hatchet_spec.rb` - Run specific test file
+
+**Linting:**
+- `rubocop` - Run Ruby linter
+- `rubocop --safe-auto-correct` - Auto-fix safe lint issues
+
+**Development:**
+- `bin/setup` - Install dependencies after checkout
+- `bin/console` - Start interactive console with gem loaded
+- `bundle exec rake install` - Install gem locally
+- `rake` - Run default task (spec + rubocop)
+
+**Gem Management:**
+- `bundle exec rake release` - Release new version (updates version, creates git tag, pushes to rubygems)
+
+## Architecture
+
+**Core Structure:**
+- `lib/hatchet-sdk.rb` - Main entry point, defines `Hatchet` module with `Error` and `Client` classes
+- `lib/hatchet/version.rb` - Version constant
+- `spec/` - RSpec tests with monkey patching disabled
+- `sig/hatchet-sdk.rbs` - Ruby type signatures
+
+**Key Classes:**
+- `Hatchet::Client` - Main client class that accepts an API key for authentication
+- `Hatchet::Error` - Base error class for gem-specific exceptions
+
+The codebase uses frozen string literals and follows Ruby 3.1+ requirements.
+
+Keep the CLAUDE.md instructions up to date as the project continues to develop.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 gabriel ruttner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Hatchet Ruby SDK
+
+<div align="center">
+
+[![Gem Version](https://badge.fury.io/rb/hatchet.svg)](https://badge.fury.io/rb/hatchet)
+[![Documentation](https://img.shields.io/badge/docs-hatchet.run-blue)](https://docs.hatchet.run)
+[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+This is the official Ruby SDK for [Hatchet](https://hatchet.run), a distributed, fault-tolerant task queue. The SDK allows you to easily integrate Hatchet's task scheduling and workflow orchestration capabilities into your Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hatchet'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install hatchet
+```
+
+## Quick Start
+
+For examples of how to use the Hatchet Ruby SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/home/setup).
+
+## Features
+
+- 🔄 **Workflow Orchestration**: Define complex workflows with dependencies and parallel execution
+- 🔁 **Automatic Retries**: Configure retry policies for handling transient failures
+- 📊 **Observability**: Track workflow progress and monitor execution metrics
+- ⏰ **Scheduling**: Schedule workflows to run at specific times or on a recurring basis
+- 🔄 **Event-Driven**: Trigger workflows based on events in your system
+
+## Documentation
+
+For detailed documentation, examples, and best practices, visit:
+- [Hatchet Documentation](https://docs.hatchet.run)
+- [Examples](https://github.com/hatchet-dev/hatchet/tree/main/sdks/ruby/examples)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Run tests with `bundle exec rspec spec`.
+
+This project uses `gem-release` to help with versioning.
+
+```
+$ gem bum # bumps to the next patch version
+$ gem bump --version minor # bumps to the next minor version
+$ gem bump --version major # bumps to the next major version
+$ gem bump --version 1.1.1 # bumps to the specified version
+```
+
+## Contributing
+
+We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://hatchet.run/discord) for discussions and support.
+
+## License
+
+This SDK is released under the MIT License. See [LICENSE](https://github.com/hatchet-dev/hatchet/blob/main/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/hatchet/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hatchet
+  VERSION = "0.0.0"
+end

data/lib/hatchet-sdk.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "hatchet/version"
+
+module Hatchet
+  class Error < StandardError; end
+
+  class Client
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+  end
+end

data/sig/hatchet-sdk.rbs

@@ -0,0 +1,4 @@
+module Hatchet
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: hatchet-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- gabriel ruttner
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The official Ruby SDK for Hatchet, a distributed, fault-tolerant task
+  orchestration engine. Easily integrate Hatchet's task scheduling and workflow orchestration
+  capabilities into your Ruby applications.
+email:
+- gabe@hatchet.run
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CLAUDE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hatchet-sdk.rb
+- lib/hatchet/version.rb
+- sig/hatchet-sdk.rbs
+homepage: https://hatchet.run
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://hatchet.run
+  source_code_uri: https://github.com/hatchet-dev/hatchet/tree/main/sdks/ruby
+  changelog_uri: https://github.com/hatchet-dev/hatchet/blob/main/sdks/ruby/src/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby SDK for Hatchet, a distributed, fault-tolerant task orchestration engine
+test_files: []