adding combination endpoint

Author: notEduardo

README.md

@@ -1,9 +1,10 @@
-
 # Faucet Backend API
 
-This API provides endpoints for interacting with two main tables: `faucet.solana_balances` and `faucet.rate_limits`. Below are the available endpoints for each table.
+This API provides endpoints for interacting with two main tables: `faucet.solana_balances` and `faucet.rate_limits`.
+Below are the available endpoints for each table.
 
 ---
+
 ## How to Run
 
 1. Clone the repository
@@ -78,8 +79,7 @@ This API provides endpoints for interacting with two main tables: `faucet.solana
       "account": "string",
       "balance": "number",
       "date": "timestamp"
-    },
-    ...
+    }
   ]
   ```
 
@@ -99,8 +99,7 @@ This API provides endpoints for interacting with two main tables: `faucet.solana
       "account": "string",
       "balance": "number",
       "date": "timestamp"
-    },
-    ...
+    }
   ]
   ```
 
@@ -176,6 +175,40 @@ This API provides endpoints for interacting with two main tables: `faucet.solana
   }
   ```
 
+### **Create a New Rate Limit Combination**
+
+**POST** `/api/rate-limits-combo`
+
+- **Description**: Adds a new rate limit combination entry. Each combination of `ip_address`, `wallet_address`,
+  and `github_username` is checked for uniqueness before inserting to DB.
+- **Request Body**:
+  ```json
+  {
+    "ip_address": "string",
+    "wallet_address": "string",
+    "github_username": "string"
+  }
+  ```
+- **Curl Command**:
+  ```bash
+  curl -v -X POST http://localhost:3000/api/rate-limits-combo \
+    -H "Content-Type: application/json" \
+    -d '{
+      "ip_address": "19216801",
+      "wallet_address": "wallet_123",
+      "github_userid": "user123"
+    }'
+  ```
+- **Response**:
+ ```json
+  {
+   "id": "3",
+  "ip_address":"19216801",
+  "wallet_address":"wallet_123",
+  "github_userid":"user123"
+  }
+  ```
+
 ---
 
 ## Error Handling

src/db/config.js

@@ -4,11 +4,13 @@ const { Pool } = pg;
 
 dotenv.config();
 
-const pgClient = new Pool({
+const pgClient = new Pool(process.env.DB_CONNECTION_NAME ? {
     user: process.env.DB_USER,
     database: process.env.DB_NAME,
     password: process.env.DB_PASSWORD,
     host: `/cloudsql/${process.env.DB_CONNECTION_NAME}`
+} : {
+    connectionString: process.env.POSTGRES_STRING
 });
 
 const query = (text, params) => pgClient.query(text, params);

src/db/rateLimits.js

@@ -44,9 +44,23 @@ const deleteRateLimit = async (key) => {
     return result.rows[0];
 };
 
+async function createRateLimitCombo(ip_address, wallet_address, github_userid ) {
+    const query = `
+        INSERT INTO faucet.rate_limits_combo (ip_address, wallet_address, github_userid)
+        VALUES ($1, $2, $3)
+        RETURNING *;
+    `;
+
+    const values = [ip_address, wallet_address, github_userid];
+    const result = await db.query(query, values);
+
+    return result.rows[0];
+}
+
 export default {
     createRateLimit,
     getRateLimit,
     updateRateLimit,
     deleteRateLimit,
+    createRateLimitCombo
 };

src/db/rateLimitsCombo.js

@@ -0,0 +1,30 @@
+import db from './config.js'; // Import the database configuration
+
+const addRateLimitCombo = async (ip_address, wallet_address, github_username) => {
+    const query = `
+    INSERT INTO faucet.rate_limits_combo (ip_address, wallet_address, github_username)
+    VALUES ($1, $2, $3)
+    ON CONFLICT (ip_address, wallet_address, github_username) DO NOTHING
+    RETURNING *;
+  `;
+    const values = [ip_address, wallet_address, github_username];
+
+    try {
+        const result = await db.query(query, values);
+
+        if (result.rowCount === 0) {
+            console.log('Duplicate combination found:', {ip_address, wallet_address, github_username});
+        } else {
+            console.log('New combo inserted:', result.rows[0]);
+        }
+
+        return result.rows[0];
+    } catch (error) {
+        console.error('Error during combo creation:', error);
+        throw error;
+    }
+};
+
+export default {
+    addRateLimitCombo,
+};

src/routes/rateLimitRoute.js

@@ -3,7 +3,7 @@ import rateLimits from '../db/rateLimits.js'; // Import the CRUD methods for the
 
 const router = express.Router();
 
-// CREATE a new rate limit
+// POST a new rate limit
 router.post('/rate-limits', async (req, res, next) => {
     const { key, timestamps } = req.body;
 
@@ -16,7 +16,7 @@ router.post('/rate-limits', async (req, res, next) => {
     }
 });
 
-// READ a rate limit by key
+// GET a rate limit by key
 router.get('/rate-limits/:key', async (req, res, next) => {
     const { key } = req.params;
 
@@ -34,7 +34,7 @@ router.get('/rate-limits/:key', async (req, res, next) => {
     }
 });
 
-// UPDATE timestamps for a rate limit by key
+// PUT timestamps for a rate limit by key
 router.put('/rate-limits/:key', async (req, res, next) => {
     const { key } = req.params;
     const { timestamps } = req.body;
@@ -53,4 +53,29 @@ router.put('/rate-limits/:key', async (req, res, next) => {
     }
 });
 
+// POST rate limit combination
+router.post('/rate-limits-combo', async (req, res, next) => {
+    const { ip_address, wallet_address, github_userid } = req.body;
+
+    // Validate the input
+    if (!ip_address || !wallet_address) {
+        return res.status(400).json({ message: 'All fields (ip_address, wallet_address, github_username) are required.' });
+    }
+
+    try {
+        // Insert the new combination into the database
+        const newCombo = await rateLimits.createRateLimitCombo(ip_address, wallet_address, github_userid ?? '');
+
+        res.status(201).json(newCombo);
+    } catch (error) {
+        if (error.code === '23505') { // Unique violation error code for PostgreSQL
+            console.warn('Duplicate rate limit combo:', error.detail);
+            res.status(409).json({ message: 'Combination of ip_address, wallet_address, and github_userid already exists.' });
+        } else {
+            console.error('Error creating rate limit combo:', error);
+            next(error);
+        }
+    }
+});
+
 export default router;