Merge pull request #62 from Agbasimere/feat/top-rated-owners-5

Feat: Implement Top Rated Owners Leaderboard #5

Author: elizabetheonoja-art

index.js

@@ -2,6 +2,7 @@ require('dotenv').config();
 const express = require('express');
 const cors = require('cors');
 const leaseRoutes = require('./src/routes/leaseRoutes');
+const ownerRoutes = require('./src/routes/ownerRoutes');
 
 const app = express();
 const port = process.env.PORT || 3000;
@@ -68,6 +69,7 @@ app.use(express.urlencoded({ extended: true, limit: '50mb' }));
 
 // Routes
 app.use('/api/leases', leaseRoutes);
+app.use('/api/owners', ownerRoutes);
 
 app.get('/', (req, res) => {
   res.json({ 
@@ -78,7 +80,8 @@ app.get('/', (req, res) => {
     contract_id: process.env.CONTRACT_ID || 'CAEGD57WVTVQSYWYB23AISBW334QO7WNA5XQ56S45GH6BP3D2AVHKUG4',
     endpoints: {
       upload_lease: 'POST /api/leases/upload',
-      view_lease_handshake: 'GET /api/leases/:leaseCID/handshake'
+      view_lease_handshake: 'GET /api/leases/:leaseCID/handshake',
+      top_owners: 'GET /api/owners/top'
     }
 app.use(express.json());
 app.use('/uploads', express.static(path.join(__dirname, 'uploads')));

src/controllers/OwnerController.js

@@ -0,0 +1,27 @@
+const OwnerService = require('../services/OwnerService');
+
+class OwnerController {
+    /**
+     * Retrieves the top-rated owners based on completed lease counts.
+     * @route GET /api/owners/top
+     */
+    async getTopRated(req, res) {
+        try {
+            const limit = parseInt(req.query.limit) || 10;
+            const topOwners = await OwnerService.getTopRatedOwners(limit);
+
+            console.log(`[OwnerController] Found ${topOwners.length} top-rated owners.`);
+
+            return res.status(200).json({
+                status: 'success',
+                message: 'Top-rated owners retrieved successfully.',
+                data: topOwners
+            });
+        } catch (error) {
+            console.error('[OwnerController] Error fetching top owners:', error);
+            return res.status(500).json({ error: 'Internal server error while retrieving top owners.', details: error.message });
+        }
+    }
+}
+
+module.exports = new OwnerController();

src/routes/ownerRoutes.js

@@ -0,0 +1,11 @@
+const express = require('express');
+const router = express.Router();
+const OwnerController = require('../controllers/OwnerController');
+
+/**
+ * Route: GET /api/owners/top
+ * Description: Retrieves a leaderboard of top property owners by completed rentals.
+ */
+router.get('/top', (req, res) => OwnerController.getTopRated(req, res));
+
+module.exports = router;

src/services/OwnerService.js

@@ -0,0 +1,59 @@
+/**
+ * OwnerService handles analytics and retrieval for property owners.
+ * In a real-world scenario, this service would fetch historical data from a 
+ * blockchain indexer (like Soroban event logs) or a local database.
+ */
+
+class OwnerService {
+    constructor() {
+        // Mock data representing a subset of Indexed Leases
+        // Status: 'Draft', 'Active', 'Completed', 'Cancelled'
+        this.leases = [
+            { id: 'lease-101', owner_id: 'owner-A', status: 'Completed', tenant_id: 'tenant-1' },
+            { id: 'lease-102', owner_id: 'owner-B', status: 'Completed', tenant_id: 'tenant-2' },
+            { id: 'lease-103', owner_id: 'owner-A', status: 'Completed', tenant_id: 'tenant-3' },
+            { id: 'lease-104', owner_id: 'owner-C', status: 'Completed', tenant_id: 'tenant-4' },
+            { id: 'lease-105', owner_id: 'owner-B', status: 'Active', tenant_id: 'tenant-5' },
+            { id: 'lease-106', owner_id: 'owner-A', status: 'Completed', tenant_id: 'tenant-6' },
+            { id: 'lease-107', owner_id: 'owner-D', status: 'Completed', tenant_id: 'tenant-7' },
+            { id: 'lease-108', owner_id: 'owner-B', status: 'Completed', tenant_id: 'tenant-8' },
+        ];
+
+        // Mock data for Owner profiles
+        this.owners = {
+            'owner-A': { id: 'owner-A', name: 'Alice Estate', public_key: 'G...A1' },
+            'owner-B': { id: 'owner-B', name: 'Bob Properties', public_key: 'G...B2' },
+            'owner-C': { id: 'owner-C', name: 'Charlie Homes', public_key: 'G...C3' },
+            'owner-D': { id: 'owner-D', name: 'David Rentals', public_key: 'G...D4' },
+        };
+    }
+
+    /**
+     * Retrieves a leaderboard of Owners with the most 'Completed' leases.
+     * @param {number} limit - Maximum number of top owners to return.
+     * @returns {Array} - List of top owners with their success count.
+     */
+    async getTopRatedOwners(limit = 5) {
+        // 1. Filter for completed leases only
+        const completedLeases = this.leases.filter(lease => lease.status === 'Completed');
+
+        // 2. Count completions per owner
+        const countsByOwner = {};
+        completedLeases.forEach(lease => {
+            countsByOwner[lease.owner_id] = (countsByOwner[lease.owner_id] || 0) + 1;
+        });
+
+        // 3. Map to owner objects and sort
+        const topRated = Object.keys(countsByOwner)
+            .map(ownerId => ({
+                ...this.owners[ownerId],
+                successful_rentals: countsByOwner[ownerId]
+            }))
+            .sort((a, b) => b.successful_rentals - a.successful_rentals) // Descending
+            .slice(0, limit);
+
+        return topRated;
+    }
+}
+
+module.exports = new OwnerService();

tests/controllers/OwnerController.test.js

@@ -0,0 +1,31 @@
+const request = require('supertest');
+const app = require('../../index');
+
+describe('OwnerController', () => {
+    describe('GET /api/owners/top', () => {
+        it('should return 200 and a list of top-rated owners', async () => {
+            const response = await request(app).get('/api/owners/top');
+            
+            expect(response.status).toBe(200);
+            expect(response.body.status).toBe('success');
+            expect(Array.isArray(response.body.data)).toBe(true);
+            
+            // Check sorting (descending)
+            const owners = response.body.data;
+            if (owners.length >= 2) {
+                expect(owners[0].successful_rentals).toBeGreaterThanOrEqual(owners[1].successful_rentals);
+            }
+
+            // Check specific mock data from OwnerService (Alice should be top with 3)
+            const alice = owners.find(o => o.name === 'Alice Estate');
+            expect(alice).toBeDefined();
+            expect(alice.successful_rentals).toBe(3);
+        });
+
+        it('should respect the limit query parameter', async () => {
+            const response = await request(app).get('/api/owners/top?limit=2');
+            expect(response.status).toBe(200);
+            expect(response.body.data.length).toBeLessThanOrEqual(2);
+        });
+    });
+});