Add Ruby + PostgreSQL quickstart guide

src/components/QuickStartFilter.js

@@ -2,7 +2,7 @@ import React, {useState} from "react";
 import quickstarts from "./QuickStartList";
 import Link from "@docusaurus/Link";
 import {FaGolang} from "react-icons/fa6";
-import {FaJava, FaLaptopCode, FaDocker, FaPython, FaCheck, FaArrowRight, FaArrowLeft} from "react-icons/fa";
+import {FaJava, FaLaptopCode, FaDocker, FaPython, FaCheck, FaArrowRight, FaArrowLeft, FaGem} from "react-icons/fa";
 import {TbBrandCSharp} from "react-icons/tb";
 import {IoLogoJavascript} from "react-icons/io5";
 import {useColorMode} from "@docusaurus/theme-common";
@@ -28,6 +28,7 @@ export default function QuickstartFilter({defaultLanguage = null}) {
     {name: "Java", icon: <FaJava size={24} />, color: "#007396"},
     {name: "JS/TS", icon: <IoLogoJavascript size={24} />, color: "#F7DF1E"},
     {name: "C#", icon: <TbBrandCSharp size={24} />, color: "#512BD4"},
+    {name: "Ruby", icon: <FaGem size={24} />, color: "#CC342D"},
   ];
 
   const servers = [

src/components/QuickStartList.js

@@ -306,6 +306,26 @@ const quickstarts = [
     link: "/docs/quickstart/flask-redis/",
   },
 
+  // Ruby list
+
+  {
+    title: "Ruby + Postgres",
+    language: "Ruby",
+    server: "Docker",
+    description:
+      "A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
+    link: "/docs/quickstart/samples-ruby/#using-docker-compose-",
+  },
+
+  {
+    title: "Ruby + Postgres",
+    language: "Ruby",
+    server: "Local",
+    description:
+      "A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
+    link: "/docs/quickstart/samples-ruby/#running-app-locally-on-linuxwsl-",
+  },
+
   //Javascript list
 
   /*  {

versioned_docs/version-4.0.0/quickstart/ruby-sinatra-postgres.md

@@ -0,0 +1,284 @@
+---
+id: samples-ruby
+title: Sample Books API
+sidebar_label: Ruby + Postgres
+description: The following sample app showcases how to use the Ruby (Sinatra) framework and the Keploy Platform.
+tags:
+  - ruby
+  - quickstart
+  - samples
+  - examples
+  - tutorial
+  - sinatra
+  - postgresql
+  - ruby-framework
+keyword:
+  - Sinatra Framework
+  - PostgreSQL
+  - Ruby
+  - API Test generator
+  - Auto case generation
+---
+
+import InstallReminder from '@site/src/components/InstallReminder';
+import SectionDivider from '@site/src/components/SectionDivider';
+
+## Introduction
+
+🪄 Dive into the world of Books CRUD API and see how seamlessly Keploy integrates with [Ruby (Sinatra)](http://sinatrarb.com/) and [PostgreSQL](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢
+
+<InstallReminder />
+
+## Prerequisites
+
+### For Local Setup:
+- Ruby 3.2 or higher
+- PostgreSQL 15 or higher
+- Bundler (`gem install bundler`)
+
+### For Docker Setup:
+- Docker (20.10 or higher)
+- Docker Compose (v2.0 or higher)
+
+<SectionDivider />
+
+## Using Docker Compose 🐳
+
+We will be using Docker compose to run the application as well as PostgreSQL on Docker container.
+
+### Clone the Application 🧪
+
+```bash
+git clone https://github.com/Nsanjayboruds/keploy-ruby-postgresql-quickstart.git && cd keploy-ruby-postgresql-quickstart
+```
+
+### Build and Start Services
+
+```bash
+docker-compose up --build
+```
+
+This will:
+- Start a PostgreSQL container
+- Build and start the Ruby application container
+- Initialize the database with sample data
+- Expose the API on port 8000
+
+### Verify the Setup
+
+```bash
+curl http://localhost:8000/health
+```
+
+Expected Response:
+```json
+{"status":"healthy","service":"Ruby Books API"}
+```
+
+### Lights, Camera, Record! 🎥
+
+Capture the test-cases-
+
+```bash
+keploy record -c "docker-compose up" --container-name "ruby-books-app"
+```
+
+🔥**Make some API calls**. Postman, Hoppscotch or even curl - take your pick!
+
+### Generate Testcases
+
+To generate testcases we just need to **make some API calls.**
+
+#### 1. Get All Books
+
+```bash
+curl http://localhost:8000/books
+```
+
+#### 2. Get a Specific Book
+
+```bash
+curl http://localhost:8000/books/1
+```
+
+#### 3. Create a New Book
+
+```bash
+curl -X POST http://localhost:8000/books \
+  -H "Content-Type: application/json" \
+  -d '{
+    "title": "The Hobbit",
+    "author": "J.R.R. Tolkien",
+    "isbn": "9780547928227",
+    "published_year": 1937
+  }'
+```
+
+#### 4. Update a Book
+
+```bash
+curl -X PUT http://localhost:8000/books/1 \
+  -H "Content-Type: application/json" \
+  -d '{
+    "title": "The Great Gatsby (Updated)",
+    "author": "F. Scott Fitzgerald",
+    "isbn": "9780743273565",
+    "published_year": 1925
+  }'
+```
+
+#### 5. Delete a Book
+
+```bash
+curl -X DELETE http://localhost:8000/books/1
+```
+
+And once you are done, you can stop the recording and give yourself a pat on the back! With that simple spell, you've conjured up test cases with mocks! Explore the **keploy** directory and you'll discover your handiwork in the `tests` directory and `mocks.yml`.
+
+Want to see if everything works as expected?
+
+### Run Tests 🧪
+
+Time to put things to the test 🧪
+
+```bash
+keploy test -c "docker-compose up" --container-name "ruby-books-app" --delay 10
+```
+
+> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.
+
+Final thoughts? Dive deeper! Try different API calls, tweak the DB response in the `mocks.yml`, or fiddle with the request or response in `test-x.yml`. Run the tests again and see the magic unfold!✨👩‍💻👨‍💻✨
+
+<SectionDivider />
+
+## Running App Locally on Linux/WSL 🐧
+
+We'll be running our sample application locally on Linux/WSL. There are 2 ways you can run this application:
+
+### Clone the Application 🧪
+
+```bash
+git clone https://github.com/Nsanjayboruds/keploy-ruby-postgresql-quickstart.git && cd keploy-ruby-postgresql-quickstart
+```
+
+### Install Dependencies
+
+```bash
+bundle install
+```
+
+### Set up PostgreSQL Database
+
+Create the database:
+
+```bash
+createdb booksdb
+```
+
+Initialize the database with the schema:
+
+```bash
+psql -d booksdb -f init.sql
+```
+
+### Configure Environment Variables
+
+```bash
+cp .env.example .env
+# Edit .env if needed for your local PostgreSQL configuration
+```
+
+### Start the Application
+
+```bash
+bundle exec ruby app.rb
+```
+
+The API will be available at `http://localhost:8000`
+
+### Verify the Setup
+
+```bash
+curl http://localhost:8000/health
+```
+
+Expected Response:
+```json
+{"status":"healthy","service":"Ruby Books API"}
+```
+
+### Lights, Camera, Record! 🎥
+
+Capture the test-cases-
+
+```bash
+keploy record -c "bundle exec ruby app.rb"
+```
+
+🔥**Make some API calls**. Postman, Hoppscotch or even curl - take your pick!
+
+### Generate Testcases
+
+To generate testcases we just need to **make some API calls.**
+
+#### 1. Get All Books
+
+```bash
+curl http://localhost:8000/books
+```
+
+#### 2. Get a Specific Book
+
+```bash
+curl http://localhost:8000/books/1
+```
+
+#### 3. Create a New Book
+
+```bash
+curl -X POST http://localhost:8000/books \
+  -H "Content-Type: application/json" \
+  -d '{
+    "title": "The Hobbit",
+    "author": "J.R.R. Tolkien",
+    "isbn": "9780547928227",
+    "published_year": 1937
+  }'
+```
+
+#### 4. Update a Book
+
+```bash
+curl -X PUT http://localhost:8000/books/1 \
+  -H "Content-Type: application/json" \
+  -d '{
+    "title": "The Great Gatsby (Updated)",
+    "author": "F. Scott Fitzgerald",
+    "isbn": "9780743273565",
+    "published_year": 1925
+  }'
+```
+
+#### 5. Delete a Book
+
+```bash
+curl -X DELETE http://localhost:8000/books/1
+```
+
+And once you are done, you can stop the recording and give yourself a pat on the back! With that simple spell, you've conjured up test cases with mocks! Explore the **keploy** directory and you'll discover your handiwork in the `tests` directory and `mocks.yml`.
+
+Want to see if everything works as expected?
+
+### Run Tests 🧪
+
+Time to put things to the test 🧪
+
+```bash
+keploy test -c "bundle exec ruby app.rb" --delay 10
+```
+
+> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.
+
+Final thoughts? Dive deeper! Try different API calls, tweak the DB response in the `mocks.yml`, or fiddle with the request or response in `test-x.yml`. Run the tests again and see the magic unfold!✨👩‍💻👨‍💻✨
+
+Happy coding! ✨👩‍💻👨‍💻✨

versioned_sidebars/version-4.0.0-sidebars.json

@@ -117,6 +117,15 @@
               "items": [
                 "quickstart/samples-csharp"
               ]
+            },
+            {
+              "type": "category",
+              "label": "Ruby",
+              "collapsible": true,
+              "collapsed": true,
+              "items": [
+                "quickstart/samples-ruby"
+              ]
             }
           ]
         },