EC-21: FEAT: Added new Ruby package and initialized the repo #1
3
.gitignore
vendored
3
.gitignore
vendored
@@ -45,3 +45,6 @@ coverage/
|
|||||||
*.p12
|
*.p12
|
||||||
*.pfx
|
*.pfx
|
||||||
secrets/
|
secrets/
|
||||||
|
|
||||||
|
# Ruby
|
||||||
|
*.gem
|
||||||
|
|||||||
38
README.md
38
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
|
## 🧭 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
|
## 🛠️ Tech Stack
|
||||||
|
|
||||||
|
The final technology stack is being determined. The planned stack is as follows:
|
||||||
|
|
||||||
| Layer | Technology |
|
| Layer | Technology |
|
||||||
| :--- | :--- |
|
| :--- | :--- |
|
||||||
| Language | — |
|
| Language | Ruby |
|
||||||
| Framework | — |
|
| Framework | None (Standard Library + Minimal Dependencies) |
|
||||||
| Key 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
|
### Prerequisites
|
||||||
|
|
||||||
- Docker & Docker Compose
|
- Ruby 2.7+
|
||||||
- Node.js / Python (specify version)
|
|
||||||
|
### 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
|
### Local Development
|
||||||
|
|
||||||
|
The repository can be cloned for contribution or testing once development is further along.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repo
|
# Clone the repo
|
||||||
git clone https://git.psmattas.com/Evercatch/REPO_NAME.git
|
git clone https://git.psmattas.com/Evercatch/evercatch-ruby.git
|
||||||
cd REPO_NAME
|
|
||||||
|
|
||||||
# Copy environment variables
|
cd evercatch-ruby
|
||||||
cp .env.example .env
|
|
||||||
|
|
||||||
# Start services
|
# Note: The project is not yet functional.
|
||||||
docker compose up -d
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
14
evercatch.gemspec
Normal file
14
evercatch.gemspec
Normal file
@@ -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
|
||||||
7
lib/evercatch.rb
Normal file
7
lib/evercatch.rb
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Evercatch Ruby SDK
|
||||||
|
# Coming Soon - Q2 2026
|
||||||
|
# Visit https://evercatch.dev
|
||||||
|
|
||||||
|
module Evercatch
|
||||||
|
VERSION = "0.0.1"
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user