This repository contains the official Ruby SDK for the Evercatch platform. Its purpose is to provide a simple and convenient interface for developers to interact with the Evercatch API, manage webhooks, and handle events within their Ruby applications.

⚠️ This SDK is currently under active development and is not yet ready for production use. The package published on RubyGems is a placeholder to reserve the name.

🛠️ Tech Stack

The final technology stack is being determined. The planned stack is as follows:

Layer	Technology
Language	Ruby
Framework	None (Standard Library + Minimal Dependencies)
Key Dependencies	`httparty` or `net/http` (for HTTP), `Zod` (for data models)

🚀 Getting Started

Prerequisites

Ruby 2.7+

Installation (Future)

Once released, the package will be available on RubyGems:

# This will not work until the first official release
gem install evercatch

Local Development

The repository can be cloned for contribution or testing once development is further along.

# Clone the repo
git clone https://git.psmattas.com/Evercatch/evercatch-ruby.git

cd evercatch-ruby

# Note: The project is not yet functional.

🌿 Branching & Commits

All work follows the Evercatch contribution guide defined in the org README.

Branch format: EC-ID-short-description Commit format: EC-00: type(scope): message

See Evercatch Org README for full conventions.

⚙️ CI/CD

Automated via Jenkins. Merges to main trigger staging deployments.

Pipeline	Status
Build
Lint
Test

README.md

📦 Evercatch Ruby

🧭 Overview