From 460c332d3955e43637308e27ab5060f8c8ba360c Mon Sep 17 00:00:00 2001 From: default Date: Thu, 19 Feb 2026 19:47:44 +0000 Subject: [PATCH] EC-21: FEAT: Added new Ruby package and initialized the repo Refers Evercatch/evercatch-board#21 --- .gitignore | 3 +++ README.md | 38 ++++++++++++++++++++++++-------------- evercatch.gemspec | 14 ++++++++++++++ lib/evercatch.rb | 7 +++++++ 4 files changed, 48 insertions(+), 14 deletions(-) create mode 100644 evercatch.gemspec create mode 100644 lib/evercatch.rb diff --git a/.gitignore b/.gitignore index 0be5d15..534b8a0 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,6 @@ coverage/ *.p12 *.pfx secrets/ + +# Ruby +*.gem diff --git a/README.md b/README.md index 788863e..bd22572 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,26 @@ -# 📦 Repository Name +# 📦 Evercatch Ruby -> Short one-line description of what this repository does. +> Official Ruby SDK for Evercatch webhook infrastructure platform. --- ## 🧭 Overview -Describe what this service/module is responsible for within the Evercatch platform. +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 | — | -| Framework | — | -| Key Dependencies | — | +| Language | Ruby | +| Framework | None (Standard Library + Minimal Dependencies) | +| Key Dependencies | `httparty` or `net/http` (for HTTP), `Zod` (for data models) | --- @@ -24,21 +28,27 @@ Describe what this service/module is responsible for within the Evercatch platfo ### Prerequisites -- Docker & Docker Compose -- Node.js / Python (specify version) +- Ruby 2.7+ + +### Installation (Future) + +Once released, the package will be available on RubyGems: +```bash +# 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. + ```bash # Clone the repo -git clone https://git.psmattas.com/Evercatch/REPO_NAME.git -cd REPO_NAME +git clone https://git.psmattas.com/Evercatch/evercatch-ruby.git -# Copy environment variables -cp .env.example .env +cd evercatch-ruby -# Start services -docker compose up -d +# Note: The project is not yet functional. ``` --- diff --git a/evercatch.gemspec b/evercatch.gemspec new file mode 100644 index 0000000..5bf5742 --- /dev/null +++ b/evercatch.gemspec @@ -0,0 +1,14 @@ +Gem::Specification.new do |s| + s.name = 'evercatch' + s.version = '0.0.1' + s.summary = 'Evercatch SDK for Ruby (Coming Soon)' + s.description = 'Official Ruby SDK for Evercatch webhook platform' + s.authors = ['Evercatch'] + s.email = 'support@evercatch.dev' + s.files = ['lib/evercatch.rb'] + s.homepage = 'https://git.psmattas.com/evercatch/evercatch-ruby' + s.license = 'MIT' + s.metadata = { + 'source_code_uri' => 'https://git.psmattas.com/evercatch/evercatch-ruby' + } +end diff --git a/lib/evercatch.rb b/lib/evercatch.rb new file mode 100644 index 0000000..2aa1dbf --- /dev/null +++ b/lib/evercatch.rb @@ -0,0 +1,7 @@ +# Evercatch Ruby SDK +# Coming Soon - Q2 2026 +# Visit https://evercatch.dev + +module Evercatch + VERSION = "0.0.1" +end