vihaya-events 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc964189032da23b22704e70018dfc84d1e062626c4dd1ce773afaba4746e30d
-  data.tar.gz: 9408a9f45ee799454fb04b93d4c0103c26016b478d07d830e232b7f5061c3b8e
+  metadata.gz: 2cf2e4426f093da66a4a1e774e526bb9c0344bb947a51d1ac8aaf092ebf19915
+  data.tar.gz: 2b51e967d193f5d0c6d2e162d5f8fb4fa48a05f89ae7b754c5defbdefab4d085
 SHA512:
-  metadata.gz: cc1711f1be3cd370091be2183c39dcda4c43e20d40a29d1a44f35d38237a34b95c8620aa7a5bcf98acd8fad0a6d129063a162a878c38bb59ed2c412904b2df84
-  data.tar.gz: e0df7f05daadcc52963abd838db56440ac685ec0326e797b00a85f3f9f20ef92a447fa66335c5a242a988d95b4a299710e9a0a597a1413e95c1d7ceda4f0939b
+  metadata.gz: 33f73e1555cfe6fdce8621fde104dee4c3dde06fc2150f53127e4f98bea768402b278b57fc23897e0ff59aee36a8a37c8cf8e75a7425081c3d7f6451179e23f5
+  data.tar.gz: 2441c05ee26e601ef990d2154f9c93532c2fbce8adad2e5adbc0b35912f0f9d1174c9e06cefedead5b3648c5c5b31cfe2633e77a08844d3b632acec7f194aa4d

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.1.1 — 2026-04-11
+
+### Changed
+- Expanded `README.md` into a comprehensive long-form guide with framework
+  integration examples (Rails, Sinatra, Sidekiq, Hanami, CLI), full API
+  reference, mega events / sub-events guide, Razorpay payment flow, security
+  best practices, FAQ, and cross-links to all seven Vihaya SDKs.
+
+No code changes — this is a documentation-only release.
+
 ## 0.1.0 — 2026-04-08
 
 First public release on RubyGems.

data/README.md

@@ -1,131 +1,478 @@
-# Vihaya Events — Ruby SDK
+# Vihaya SDK for Ruby — Official `vihaya-events` Gem
 
 [![Gem Version](https://img.shields.io/gem/v/vihaya-events.svg)](https://rubygems.org/gems/vihaya-events)
+[![Gem Downloads](https://img.shields.io/gem/dt/vihaya-events.svg)](https://rubygems.org/gems/vihaya-events)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D3.0-red)](https://www.ruby-lang.org/)
 
-The official Ruby SDK for the [Vihaya Events](https://vihaya.app) platform.
-Built on the Ruby standard library (`net/http` + `json`) with **zero runtime
-dependencies**, and feature parity with the JavaScript, Flutter, and Python
-SDKs.
+> **`vihaya-events`** is the official Ruby SDK for the **[Vihaya Events](https://vihaya.app)** platform. Build event listings, attendee registration flows, Razorpay payment verification, ticketing dashboards, Rails apps, Sinatra apps, Hanami services, Sidekiq background jobs, and CLI tools — all with idiomatic Ruby ergonomics and **zero runtime dependencies**.
 
-## Install
+**Vihaya** is the modern events platform for India — a single stack for event organisers, ticketing, sponsor management, attendee registration, live check-in, and real-time analytics. This gem is the fastest way to integrate the Vihaya Events API (`https://events.vihaya.app`) into any Ruby 3.0+ codebase.
+
+---
+
+## Table of contents
+
+- [What is Vihaya?](#-what-is-vihaya)
+- [Why the Vihaya Ruby SDK?](#-why-the-vihaya-ruby-sdk)
+- [The Vihaya SDK family](#-the-vihaya-sdk-family-7-languages)
+- [Installation](#-installation)
+- [Get your Vihaya API key](#-get-your-vihaya-api-key)
+- [Quick start](#-quick-start)
+- [Configuration](#-configuration)
+- [Core concepts](#-core-concepts)
+- [Usage guide](#-usage-guide)
+- [Framework integrations](#-framework-integrations)
+- [Mega events & sub-events](#-mega-events--sub-events)
+- [Razorpay payment flow](#-razorpay-payment-flow)
+- [API reference](#-api-reference)
+- [Error handling](#-error-handling)
+- [Security best practices](#-security-best-practices)
+- [FAQ](#-faq)
+- [Keywords](#-keywords)
+- [Development](#-development)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+---
+
+## 🇮🇳 What is Vihaya?
+
+**Vihaya** is an all-in-one events platform for India, built for organisers who run college fests, hackathons, conferences, workshops, meetups, bootcamps, summits, and corporate events. The Vihaya platform provides:
+
+- 🎟️ **Event creation & ticketing** with pricing tiers, promo codes, and a hosted checkout.
+- 🏢 **Mega events** — bundle dozens of sub-events under one parent fest.
+- 💳 **Razorpay payments** — end-to-end with server-side signature verification.
+- 📋 **Custom registration fields** — T-shirt size, college, team members, dietary preferences, accommodation.
+- 👥 **Attendee management** — real-time registrations, broadcasts, CSV exports.
+- 📱 **Live check-in** with mobile QR scanning.
+- 👩‍🏫 **Speakers, agenda, sponsors, FAQs.**
+- 📊 **Analytics** — registrations, revenue, funnel tracking.
+
+This **`vihaya-events`** Ruby gem lets developers embed the Vihaya Events API into Rails apps, Sinatra microservices, Hanami projects, Sidekiq jobs, Jekyll plugins, Bridgetown sites, Pakyow apps, and any Ruby script.
+
+Production URL: **`https://events.vihaya.app`** · Marketing site: **`https://vihaya.app`** · Developer dashboard: **`https://events.vihaya.app/profile/developer`**
+
+---
+
+## ✨ Why the Vihaya Ruby SDK?
+
+- **📦 Zero runtime dependencies** — built entirely on the Ruby standard library (`net/http` + `json`). No Faraday, no HTTParty, no Typhoeus, no transitive dependency tree to audit.
+- **💎 Idiomatic Ruby** — snake_case everywhere, predicate methods (`event.mega_event?`, `sub.free?`), keyword arguments, blocks-friendly.
+- **🪄 Tiny** — 10 tests, 44 assertions, runs in milliseconds against an in-process TCP stub server.
+- **🔐 Type-safe-ish** — every response is a typed value object with attribute readers.
+- **🧩 Rails ready** — drop into a Rails initializer or Sidekiq worker without ceremony.
+- **🛡️ MFA-protected** — `rubygems_mfa_required = true` so every release is two-factor authenticated.
+- **💳 Razorpay ready** — `vh.events.register` → Razorpay → `vh.payments.verify`.
+
+---
+
+## 🌍 The Vihaya SDK family (7 languages)
+
+| Language | Package | Repository | Install |
+| --- | --- | --- | --- |
+| 💎 **Ruby** | [`vihaya-events`](https://rubygems.org/gems/vihaya-events) | [Vishnu252005/vihaya-sdk-ruby](https://github.com/Vishnu252005/vihaya-sdk-ruby) | `gem install vihaya-events` |
+| 🟨 **JavaScript / TypeScript** | [`vihaya-sdk`](https://www.npmjs.com/package/vihaya-sdk) | [Vishnu252005/vihaya-sdk](https://github.com/Vishnu252005/vihaya-sdk) | `npm install vihaya-sdk` |
+| 🐍 **Python** | [`vihaya-events`](https://pypi.org/project/vihaya-events/) | [Vishnu252005/vihaya-sdk-python](https://github.com/Vishnu252005/vihaya-sdk-python) | `pip install vihaya-events` |
+| 🦫 **Go** | [`vihaya-sdk-go`](https://pkg.go.dev/github.com/Vishnu252005/vihaya-sdk-go) | [Vishnu252005/vihaya-sdk-go](https://github.com/Vishnu252005/vihaya-sdk-go) | `go get github.com/Vishnu252005/vihaya-sdk-go` |
+| ☕ **Java** | [`vihaya-sdk-java`](https://jitpack.io/#Vishnu252005/vihaya-sdk-java) | [Vishnu252005/vihaya-sdk-java](https://github.com/Vishnu252005/vihaya-sdk-java) | JitPack / Gradle / Maven |
+| 🐘 **PHP** | [`vihaya/events`](https://packagist.org/packages/vihaya/events) | [Vishnu252005/vihaya-sdk-php](https://github.com/Vishnu252005/vihaya-sdk-php) | `composer require vihaya/events` |
+| 📱 **Flutter / Dart** | [`vihaya_sdk_flutter`](https://pub.dev/packages/vihaya_sdk_flutter) | [Vishnu252005/vihaya-sdk-flutter](https://github.com/Vishnu252005/vihaya-sdk-flutter) | `flutter pub add vihaya_sdk_flutter` |
+
+All Vihaya SDKs target the same API base URL (`https://events.vihaya.app`), authenticate with the same `x-api-key` header, and expose the same methods.
+
+---
+
+## 📦 Installation
+
+Install the gem directly:
 
 ```bash
 gem install vihaya-events
 ```
 
-Or add it to your Gemfile:
+Or add it to your `Gemfile`:
 
 ```ruby
 gem "vihaya-events"
 ```
 
-Requires Ruby 3.0+.
+Then run:
+
+```bash
+bundle install
+```
+
+Requirements:
+
+- **Ruby 3.0, 3.1, 3.2, 3.3, 3.4+**
+- No other dependencies — pure stdlib
+
+Gem name: **`vihaya-events`**. Require path: **`vihaya`**.
+
+```ruby
+require "vihaya"
+```
+
+---
+
+## 🔑 Get your Vihaya API key
+
+1. Sign up or log in at **[events.vihaya.app](https://events.vihaya.app)**.
+2. Open the **[Developer Dashboard](https://events.vihaya.app/profile/developer)**.
+3. Click **Generate API Key** and copy the `vh_live_...` token.
+4. Store it in `ENV["VIHAYA_API_KEY"]`, Rails credentials, or a secrets manager — never commit it.
 
-## Quick start
+---
+
+## 🚀 Quick start
 
 ```ruby
 require "vihaya"
 
-vh = Vihaya::Client.new("vh_live_...")  # get your key from the developer dashboard
+vh = Vihaya::Client.new(ENV.fetch("VIHAYA_API_KEY"))
 
 vh.events.list.each do |event|
-  puts "#{event.title} — #{event.location}"
+  puts "#{event.title} — #{event.location} on #{event.date}"
+end
+```
+
+### Register an attendee
+
+```ruby
+registration = Vihaya::RegisterData.new(
+  name: "Anjali Mehta",
+  email: "anjali@example.com",
+  phone: "+919820012345",
+  custom_fields: {
+    "T-Shirt Size" => "L",
+    "College"      => "Vihaya Institute"
+  }
+)
+
+result = vh.events.register("evt_8x42j9", registration)
+
+if result[:isPaid]
+  puts "Razorpay order: #{result[:orderId]}"
+else
+  puts "Free registration: #{result[:registrationId]}"
 end
 ```
 
-## Fetch a full event
+### Verify a Razorpay payment
+
+```ruby
+vh.payments.verify(
+  payment_id: "pay_O8K2...",
+  order_id:   result[:orderId],
+  signature:  "signature_from_razorpay"
+)
+```
+
+---
 
-`events.get` returns an `Event` with every piece of metadata the organizer
-has configured — speakers, agenda, sponsors, FAQs, custom fields, pricing
-tiers, and sub-events for mega events.
+## ⚙️ Configuration
+
+```ruby
+vh = Vihaya::Client.new(
+  ENV.fetch("VIHAYA_API_KEY"),
+  base_url: "https://events.vihaya.app",   # override for staging
+  headers:  { "X-Trace-Id" => "abc123" },
+  timeout:  60                              # seconds
+)
+```
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `api_key` (positional) | — | Required. Sent as `x-api-key`. |
+| `base_url:` | `https://events.vihaya.app` | API base URL. Override for staging. |
+| `headers:` | `{}` | Extra headers attached to every request. |
+| `timeout:` | `30` | Per-request timeout in seconds. |
+
+---
+
+## 🧭 Core concepts
+
+- **Events** — the root record. Title, description, date, venue, tiers, custom fields, speakers, agenda, sponsors, FAQs, sub-events.
+- **Mega events** — parent events containing sub-events. Detect with `event.mega_event?`, iterate via `event.sub_events`.
+- **Registrations** — free or paid attendee entries with optional custom fields and team members.
+- **Payments** — Razorpay orders created during `events.register`, verified via `payments.verify`.
+- **API key** — `vh_live_...` token from the [developer dashboard](https://events.vihaya.app/profile/developer).
+
+---
+
+## 📚 Usage guide
+
+### Fetch a full event
 
 ```ruby
 event = vh.events.get("evt_8x42j9")
 
 puts event.title
 puts "Mode: #{event.event_mode}  Timezone: #{event.timezone}"
+puts "Location: #{event.location}"
+puts "Date: #{event.date} #{event.time}"
 
 event.speaker_list.each do |speaker|
-  puts "- #{speaker.name} (#{speaker.role})"
+  puts "- #{speaker.name} (#{speaker.role}) @ #{speaker.company}"
 end
 
 event.agenda_list.each do |item|
   puts "[#{item.time}] #{item.title}"
 end
 
+event.sponsors.each do |sponsor|
+  puts "#{sponsor.name} (#{sponsor.tier})"
+end
+
+event.faqs.each do |faq|
+  puts "Q: #{faq.question}\nA: #{faq.answer}\n\n"
+end
+
 event.special_prices.each do |tier|
   puts "  #{tier.name}: ₹#{tier.amount}"
 end
+
+event.custom_fields.each do |field|
+  puts "  #{field.name} [#{field.type}] required=#{field.required}"
+end
 ```
 
-### Mega events
+### List & filter events
+
+```ruby
+events = vh.events.list
 
-If `event.mega_event?` is true, it contains sub-events. Each sub-event has
-its own tiers, custom fields, etc.
+upcoming = events.select { |e| Date.parse(e.date) > Date.today }
+mega     = events.select(&:mega_event?)
+free     = events.select(&:free?)
+online   = events.select { |e| e.event_mode == "online" }
+```
+
+### Register with tiers, promo codes, and custom fields
 
 ```ruby
-if event.mega_event?
-  event.sub_events.each do |sub|
-    price = sub.free? ? "Free" : "₹#{sub.price}"
-    puts "- #{sub.title} (#{price})"
-  end
-end
+data = Vihaya::RegisterData.new(
+  name:  "Priya Raj",
+  email: "priya@example.com",
+  phone: "+919820012345",
+  tier:  "Early Bird",
+  promo_code: "LAUNCH10",
+  custom_fields: {
+    "College"       => "IIT Bombay",
+    "T-Shirt Size"  => "M",
+    "Year of Study" => "3rd"
+  }
+)
+
+vh.events.register("evt_conf_2026", data)
 ```
 
-## Register an attendee
+### Register a hackathon team
 
 ```ruby
-registration = Vihaya::RegisterData.new(
-  name: "Anjali Mehta",
-  email: "anjali@example.com",
+result = vh.events.register("evt_hackathon_2026",
+  name:  "Team Lead",
+  email: "lead@example.com",
   phone: "+919820012345",
-  custom_fields: { "T-Shirt Size" => "L", "College" => "Vihaya Institute" }
+  teamName: "Byte Squad",
+  teamMembers: [
+    { name: "Alice", email: "alice@example.com", phone: "+91..." },
+    { name: "Bob",   email: "bob@example.com",   phone: "+91..." },
+    { name: "Carol", email: "carol@example.com", phone: "+91..." }
+  ]
 )
+```
 
-result = vh.events.register("evt_8x42j9", registration)
+You can pass a plain `Hash` instead of `RegisterData` — use camelCase keys for that path since the SDK sends it as-is.
 
-if result[:isPaid]
-  order_id = result[:orderId]
-  # Launch Razorpay checkout with this order_id, then verify server-side:
-  vh.payments.verify(
-    payment_id: "pay_xxx",
-    order_id: order_id,
-    signature: "sig_xxx"
-  )
-else
-  puts "Registered! ID: #{result[:registrationId]}"
+---
+
+## 🎨 Framework integrations
+
+### Rails — initializer
+
+```ruby
+# config/initializers/vihaya.rb
+require "vihaya"
+
+VIHAYA = Vihaya::Client.new(Rails.application.credentials.vihaya[:api_key])
+```
+
+### Rails — controller
+
+```ruby
+class EventsController < ApplicationController
+  def index
+    @events = VIHAYA.events.list
+  end
+
+  def show
+    @event = VIHAYA.events.get(params[:id])
+  rescue Vihaya::Error => e
+    redirect_to events_path, alert: e.message
+  end
+
+  def register
+    result = VIHAYA.events.register(
+      params[:id],
+      Vihaya::RegisterData.new(**registration_params)
+    )
+    render json: result
+  rescue Vihaya::Error => e
+    render json: { error: e.message }, status: e.status || 500
+  end
+
+  private
+
+  def registration_params
+    params.permit(:name, :email, :phone, custom_fields: {})
+  end
 end
 ```
 
-You can also pass a plain `Hash` instead of `RegisterData` if you prefer — the
-SDK will send it as-is, so use camelCase keys for that path.
+### Sinatra
+
+```ruby
+require "sinatra"
+require "vihaya"
+require "json"
 
-## Error handling
+vh = Vihaya::Client.new(ENV.fetch("VIHAYA_API_KEY"))
 
-All API failures raise `Vihaya::Error` with the HTTP status and raw body:
+get "/events" do
+  content_type :json
+  vh.events.list.map(&:to_h).to_json
+end
+
+post "/events/:id/register" do
+  content_type :json
+  data = JSON.parse(request.body.read, symbolize_names: true)
+  vh.events.register(params[:id], Vihaya::RegisterData.new(**data)).to_json
+end
+```
+
+### Sidekiq background job
 
 ```ruby
-begin
-  vh.events.get("evt_does_not_exist")
-rescue Vihaya::Error => e
-  puts "#{e.message} (status=#{e.status})"
-  puts e.data.inspect
+class ProcessRegistrationJob
+  include Sidekiq::Job
+
+  def perform(event_id, payload)
+    vh = Vihaya::Client.new(ENV.fetch("VIHAYA_API_KEY"))
+    vh.events.register(event_id, Vihaya::RegisterData.new(**payload.symbolize_keys))
+  end
+end
+```
+
+### Hanami action
+
+```ruby
+module Web
+  module Actions
+    module Events
+      class Register < Web::Action
+        def handle(req, res)
+          vh = Vihaya::Client.new(ENV.fetch("VIHAYA_API_KEY"))
+          result = vh.events.register(req.params[:id], req.params.to_h)
+          res.body = result.to_json
+        end
+      end
+    end
+  end
+end
+```
+
+### Standalone CLI script
+
+```ruby
+#!/usr/bin/env ruby
+require "vihaya"
+
+vh = Vihaya::Client.new(ENV.fetch("VIHAYA_API_KEY"))
+
+vh.events.list.each do |event|
+  puts "#{event.title.ljust(40)} #{event.date}  #{event.location}"
+end
+```
+
+---
+
+## 🏢 Mega events & sub-events
+
+```ruby
+fest = vh.events.get("evt_mega_fest_2026")
+
+if fest.mega_event?
+  puts "#{fest.title} — #{fest.sub_events.size} sub-events"
+
+  fest.sub_events.each do |sub|
+    price = sub.free? ? "Free" : "₹#{sub.price}"
+    puts "  - #{sub.title} (#{price})"
+
+    sub.custom_fields.each do |field|
+      puts "    * #{field.name} [#{field.type}]"
+    end
+  end
 end
 ```
 
-## API reference
+Register for a specific sub-event:
+
+```ruby
+vh.events.register("evt_sub_workshop_ml",
+  Vihaya::RegisterData.new(
+    name:  "Rahul",
+    email: "rahul@example.com",
+    phone: "+91..."
+  )
+)
+```
+
+---
+
+## 💳 Razorpay payment flow
+
+1. **Backend** — `vh.events.register(id, data)` → Vihaya creates a Razorpay order and returns `:orderId`.
+2. **Frontend** — launch Razorpay Checkout with that order ID.
+3. **Razorpay callback** — hands back `razorpay_payment_id`, `razorpay_order_id`, `razorpay_signature`.
+4. **Backend** — `vh.payments.verify(...)` confirms the signature and marks the registration paid.
+
+```ruby
+result = vh.events.register("evt_conf_2026",
+  Vihaya::RegisterData.new(
+    name:  "Attendee",
+    email: "a@example.com",
+    phone: "+91..."
+  )
+)
+order_id = result[:orderId]
+
+# Frontend: Razorpay Checkout with order_id ...
+
+vh.payments.verify(
+  payment_id: razorpay_payment_id,
+  order_id:   razorpay_order_id,
+  signature:  razorpay_signature
+)
+```
+
+> **⚠️ Always verify payments on the server.** Never trust a signature checked only in the browser.
+
+---
+
+## 📖 API reference
 
 ### `Vihaya::Client.new(api_key, base_url: ..., headers: {}, timeout: 30)`
 
-The main client. `api_key` is required; everything else is keyword.
+The main client. `api_key` is required and positional; everything else is keyword.
 
 ### `vh.events`
 
 | Method | Returns | Description |
 | --- | --- | --- |
 | `list` | `Array<Vihaya::Event>` | All events on the authenticated account. |
-| `get(event_id)` | `Vihaya::Event` | Full metadata for one event. |
+| `get(event_id)` | `Vihaya::Event` | Full metadata for one event — tiers, custom fields, speakers, agenda, sponsors, FAQs, sub-events. |
 | `register(event_id, data)` | `Hash` | Submit a registration. `data` can be `RegisterData` or `Hash`. |
 
 ### `vh.payments`
@@ -134,19 +481,138 @@ The main client. `api_key` is required; everything else is keyword.
 | --- | --- | --- |
 | `verify(payment_id:, order_id:, signature:, amount: nil)` | `Hash` | Server-side Razorpay signature verification. |
 
-> **Security:** never hard-code a live secret key in client-side code. Use
-> environment variables and perform payment verification from a trusted
-> backend environment only.
+### Models (module `Vihaya`)
+
+- `Vihaya::Event` — root event with all metadata + predicate methods (`mega_event?`, `free?`, `online?`)
+- `Vihaya::Speaker`, `Vihaya::Sponsor`, `Vihaya::AgendaItem`, `Vihaya::FAQItem`, `Vihaya::Contact`
+- `Vihaya::CustomField`, `Vihaya::SpecialPrice`, `Vihaya::PromoCode`
+- `Vihaya::RegisterData` — registration payload with keyword constructor
+- `Vihaya::Error` — raised on every API failure
+
+---
+
+## 🚨 Error handling
+
+All API failures raise `Vihaya::Error` with the HTTP status and raw body:
+
+```ruby
+begin
+  vh.events.get("evt_does_not_exist")
+rescue Vihaya::Error => e
+  puts "#{e.message} (status=#{e.status})"
+  puts e.data.inspect
+
+  case e.status
+  when 404 then puts "Not found"
+  when 401, 403 then puts "Auth error"
+  when 429 then puts "Rate limited"
+  end
+end
+```
+
+---
+
+## 🛡️ Security best practices
+
+> **Never hard-code a `vh_live_...` key in code that ships to a client.**
+
+- Use `ENV`, Rails encrypted credentials (`Rails.application.credentials.vihaya`), `dotenv`, or a secrets manager.
+- Call `events.register` and `payments.verify` from backend code only.
+- Always verify Razorpay signatures server-side.
+- Rotate keys via the [Vihaya developer dashboard](https://events.vihaya.app/profile/developer) if you suspect a leak.
+- Use separate keys for staging and production.
+
+---
+
+## ❓ FAQ
+
+### What is Vihaya?
+
+Vihaya is an events platform for India — ticketing, registrations, payments, check-in, analytics, and attendee management. Platform: [vihaya.app](https://vihaya.app). Dashboard: [events.vihaya.app](https://events.vihaya.app).
+
+### Why does the gem name differ from the require path?
+
+You install with `gem install vihaya-events` but require with `require "vihaya"`. The gem name reflects what it does on the platform; the require path is short and ergonomic.
+
+### Does the SDK support Faraday / HTTParty / Typhoeus?
 
-## Development
+No — and that's intentional. Pure stdlib means no transitive dependencies, smaller install footprint, and no version conflicts with whatever HTTP library your Rails app already uses.
+
+### Does it work with Sidekiq, Resque, GoodJob?
+
+Yes — the client is just a Ruby object. Build it once at startup, share it across workers.
+
+### Does Vihaya support Razorpay test mode?
+
+Yes — use a test API key from the Vihaya developer dashboard.
+
+### Can I pass a plain Hash instead of `RegisterData`?
+
+Yes. `RegisterData` is a convenience wrapper. A plain Hash works too — just use camelCase keys (`teamMembers`, `customFields`, etc.) on that path.
+
+---
+
+## 🔎 Keywords
+
+`vihaya` · `vihaya sdk` · `vihaya ruby` · `vihaya events` · `vihaya gem` · `vihaya-events` · `vihaya rails` · `vihaya sinatra` · `vihaya hanami` · `ruby events api` · `ruby ticketing gem` · `rails events sdk` · `ruby razorpay events` · `vihaya razorpay ruby` · `events api india ruby` · `event management gem` · `sidekiq vihaya` · `vihaya client ruby` · `rubygems vihaya` · `events.vihaya.app ruby` · `vihaya official ruby sdk`
+
+---
+
+## 🛠️ Development
 
 ```bash
 git clone https://github.com/Vishnu252005/vihaya-sdk-ruby.git
 cd vihaya-sdk-ruby
-ruby test/test_client.rb
-gem build vihaya-events.gemspec
+ruby test/test_client.rb               # Minitest suite (10 tests, 44 assertions)
+gem build vihaya-events.gemspec        # build the .gem file
 ```
 
-## License
+The test suite uses an in-process TCP stub server — no Bundler, WebMock, or VCR required, no network calls.
+
+> **Ruby version note:** the gemspec requires Ruby ≥ 3.0. Use `/opt/homebrew/opt/ruby/bin/ruby` on macOS — system Ruby (`/usr/bin/ruby` 2.6) is too old.
+
+---
+
+## 🤝 Contributing
+
+Contributions to the Vihaya Ruby SDK are very welcome. The project is open source and MIT-licensed.
+
+1. Fork [Vishnu252005/vihaya-sdk-ruby](https://github.com/Vishnu252005/vihaya-sdk-ruby).
+2. Create a feature branch.
+3. Run `ruby test/test_client.rb`.
+4. Commit, push, and open a Pull Request.
+
+### Reporting issues
+
+Found a bug or have a feature request? Open an issue at [github.com/Vishnu252005/vihaya-sdk-ruby/issues](https://github.com/Vishnu252005/vihaya-sdk-ruby/issues).
+
+---
+
+## 📄 License
+
+MIT © Vihaya. See [LICENSE](LICENSE).
+
+---
+
+## 💬 Support
+
+- 📧 Email: **support@vihaya.app**
+- 🌐 Website: **[vihaya.app](https://vihaya.app)**
+- 🛠️ Dashboard: **[events.vihaya.app](https://events.vihaya.app)**
+- 👨‍💻 Developer docs: **[events.vihaya.app/profile/developer/docs](https://events.vihaya.app/profile/developer/docs)**
+- 💎 RubyGems: **[rubygems.org/gems/vihaya-events](https://rubygems.org/gems/vihaya-events)**
+- 🐛 Issues: **[github.com/Vishnu252005/vihaya-sdk-ruby/issues](https://github.com/Vishnu252005/vihaya-sdk-ruby/issues)**
+
+Built with ❤️ by the Vihaya team.
+
+---
+
+### Related Vihaya SDK repositories
 
-MIT — see [LICENSE](LICENSE).
+- **Ruby:** [vihaya-sdk-ruby](https://github.com/Vishnu252005/vihaya-sdk-ruby) — *you are here*
+- **JavaScript / TypeScript:** [vihaya-sdk](https://github.com/Vishnu252005/vihaya-sdk)
+- **Python:** [vihaya-sdk-python](https://github.com/Vishnu252005/vihaya-sdk-python)
+- **Go:** [vihaya-sdk-go](https://github.com/Vishnu252005/vihaya-sdk-go)
+- **Java:** [vihaya-sdk-java](https://github.com/Vishnu252005/vihaya-sdk-java)
+- **PHP:** [vihaya-sdk-php](https://github.com/Vishnu252005/vihaya-sdk-php)
+- **Flutter:** [vihaya-sdk-flutter](https://github.com/Vishnu252005/vihaya-sdk-flutter)

data/lib/vihaya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vihaya
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vihaya-events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vihaya Team