feat(api): added a enedpoint to redeem rewards

Author: a3ryk

src/controllers/v4/internal/rewards.js

@@ -1,4 +1,5 @@
 import System from '../../../models/schemas/System.js';
+import User from '../../../models/schemas/User.js';
 
 /**
  * Fetches rewards/rewards from the system.
@@ -103,3 +104,79 @@ export const createReward = async (req, res) => {
     return res.status(500).json({ message: 'Internal Server Error' });
   }
 };
+
+/**
+ * Redeems a reward for a user if not already claimed.
+ */
+export const redeemReward = async (req, res) => {
+  try {
+    const key = req.headers.key;
+
+    // Authorization check
+    if (!key || key !== process.env.ACCESS_KEY) {
+      return res.status(401).json({ message: 'Unauthorized' });
+    }
+
+    const { code } = req.body;
+    const userId = req.headers.id; // Adjust based on how you auth
+
+    if (!code || !userId) {
+      return res.status(400).json({ message: 'Missing code or user ID' });
+    }
+
+    // Find the system document (assuming you have only one system doc)
+    const system = await System.findById('system').select('rewards');
+    if (!system) {
+      return res.status(500).json({ message: 'System configuration not found for rewards' });
+    }
+
+    // Find the reward by _id (code)
+    const reward = system.rewards.find(r => r._id.toLowerCase() === code.toLowerCase() && r.isActive);
+
+    if (!reward) {
+      return res.status(404).json({ message: 'Invalid or inactive reward code' });
+    }
+
+    // Check valid date range if set
+    const now = new Date();
+    if (reward.validFrom && now < reward.validFrom) {
+      return res.status(400).json({ message: 'Reward is not yet valid' });
+    }
+    if (reward.validUntil && now > reward.validUntil) {
+      return res.status(400).json({ message: 'Reward has expired' });
+    }
+
+    // Get user and check status_history
+    const user = await User.findById(userId);
+    if (!user) {
+      return res.status(404).json({ message: 'User not found' });
+    }
+
+    const alreadyClaimed = user.status_history?.some(status => status.value === code.toUpperCase());
+    if (alreadyClaimed) {
+      return res.status(409).json({ message: 'Reward already claimed' });
+    }
+
+    // Add reward to user's history
+    user.status_history.push({
+      _id: user.status_history.length + 1,
+      value: code.toUpperCase(),
+      timestamp: new Date(),
+      reason: 'Self Reward redeemed',
+    });
+
+    await user.save();
+
+    return res.status(200).json({
+      message: 'Reward redeemed successfully',
+      reward: {
+        name: reward.name,
+        type: reward.type,
+        value: reward.value,
+      },
+    });
+  } catch (err) {
+    console.error('Error redeeming reward:', err);
+    return res.status(500).json({ message: 'Internal Server Error' });
+  }
+};

src/routes/v4/internal/rewards.js

@@ -66,4 +66,23 @@ router
    */
   .get(createRateLimiter(), getRewards);
 
+router.route('/redeem');
+/**
+ * @api {post} v4/rewards/redeem Redeem a Reward
+ * @apiDescription Redeem a reward using its unique ID.
+ * @apiName redeemReward
+ * @apiGroup Rewards
+ * @apiPermission user
+ *
+ * @apiHeader {String} Key Internal access token
+ *
+ * @apiBody {String} id Unique ID of the reward to redeem.
+ *
+ * @apiSuccess {Object} result Redemption result.
+ * @apiError (Bad Request 400) BadRequest Missing or invalid fields.
+ * @apiError (Not Found 404) NotFound Reward with the given ID does not exist.
+ * @apiError (Unauthorized 401) Unauthorized Invalid or missing access key.
+ * @apiError (Internal Server Error 500) InternalServerError An error occurred while redeeming reward.
+ */
+
 export default router;