Merge pull request #40 from CMU-17313Q/feat/polls-get-by-post-clean

feat(polls): add GET /api/posts/:pid/poll (Issue 3)

Author: IndyaG

public/openapi/read.yaml

@@ -256,6 +256,8 @@ paths:
     $ref: 'read/email/unsubscribe/token.yaml'
   "/api/post/{pid}":
     $ref: 'read/post/pid.yaml'
+  "/api/posts/{pid}/poll":
+    $ref: 'read/posts/pid/poll.yaml'
   /api/flags:
     $ref: 'read/flags.yaml'
   "/api/flags/{flagId}":
@@ -367,4 +369,4 @@ paths:
   /api/ap:
     $ref: 'read/ap.yaml'
   /api/outgoing:
-    $ref: 'read/outgoing.yaml'
+    $ref: 'read/outgoing.yaml'

public/openapi/read/posts.yaml

@@ -0,0 +1,7 @@
+/posts/{pid}:
+  # ...existing code...
+  
+/posts/{pid}/poll:
+  $ref: './posts/poll.yaml#/get'
+
+# ...existing code...

public/openapi/read/posts/pid/poll.yaml

@@ -0,0 +1,84 @@
+get:
+  tags:
+    - posts
+  summary: Get poll for a specific post
+  parameters:
+    - in: path
+      name: pid
+      schema:
+        type: integer
+      required: true
+      description: Post ID
+      example: 1
+  responses:
+    "200":
+      description: Poll data for the post
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              postId:
+                type: integer
+                description: The post ID
+              poll:
+                oneOf:
+                  - type: object
+                    additionalProperties: false
+                    description: Empty poll object when no poll exists
+                  - type: object
+                    description: Poll data when poll exists
+                    properties:
+                      id:
+                        type: string
+                        description: Poll ID
+                      question:
+                        type: string
+                        description: Poll question
+                      options:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            index:
+                              type: integer
+                            text:
+                              type: string
+                      hasVoted:
+                        type: boolean
+                        description: Whether the current user has voted
+                      selectedOptionIndex:
+                        type: integer
+                        nullable: true
+                        description: Index of the option the user selected
+                      counts:
+                        type: array
+                        nullable: true
+                        items:
+                          type: integer
+                        description: Vote counts for each option (shown after voting)
+                      totalVotes:
+                        type: integer
+                        nullable: true
+                        description: Total number of votes (shown after voting)
+    "400":
+      description: Bad request (invalid post ID)
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+                example: "bad pid"
+    "404":
+      description: Poll not found for this post
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              postId:
+                type: integer
+              poll:
+                type: object

public/openapi/read/posts/poll.yaml

@@ -0,0 +1,79 @@
+get:
+  tags:
+    - Posts
+  summary: Get poll data for a post
+  description: Retrieve poll information for a specific post, including voting status and results (if allowed)
+  parameters:
+    - name: pid
+      in: path
+      required: true
+      description: Post ID
+      schema:
+        type: string
+  responses:
+    '200':
+      description: Poll data retrieved successfully
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              status:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    example: ok
+                  message:
+                    type: string
+                    example: OK
+              response:
+                oneOf:
+                  - type: object
+                    description: Empty object when post has no poll
+                    example: {}
+                  - type: object
+                    description: Poll data when post has a poll
+                    properties:
+                      question:
+                        type: string
+                        example: "What is your favorite color?"
+                      options:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            title:
+                              type: string
+                              example: "Blue"
+                            count:
+                              type: integer
+                              description: Vote count (only included if user has voted or results are visible)
+                              example: 5
+                      hasVoted:
+                        type: boolean
+                        example: true
+                      selectedOptionIndex:
+                        type: integer
+                        description: Index of user's selected option (only if hasVoted is true)
+                        example: 0
+                      totalVotes:
+                        type: integer
+                        description: Total number of votes (only included if user has voted or results are visible)
+                        example: 15
+    '404':
+      description: Post not found
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              status:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    example: not-found
+                  message:
+                    type: string
+                    example: Post not found

public/openapi/write/files/folder.yaml

@@ -1,8 +1,8 @@
 put:
   tags:
-    - files
-  summary: create a new folder
-  description: This operation creates a new folder inside upload path
+    - Files
+  summary: Create a new folder
+  description: This operation creates a new folder inside the upload path.
   requestBody:
     required: true
     content:
@@ -12,7 +12,7 @@ put:
           properties:
             path:
               type: string
-              description: Path to the file (relative to the configured `upload_path`)
+              description: Path relative to the configured `upload_path`
               example: /files
             folderName:
               type: string
@@ -23,14 +23,31 @@ put:
             - folderName
   responses:
     '200':
-      description: Folder created
+      description: Folder created successfully
       content:
         application/json:
           schema:
             type: object
             properties:
               status:
-                $ref: ../../components/schemas/Status.yaml#/Status
+                type: object
+                properties:
+                  code:
+                    type: string
+                    example: ok
+                  message:
+                    type: string
+                    example: OK
               response:
                 type: object
-                properties: {}
+                description: Additional response data
+    '403':
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+                example: forbidden

src/polls/model.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const db = require.main.require('./src/database');
+const { v4: uuid } = require('uuid');
+
+const PollModel = {
+	/**
+	 * Create a poll and index it by postId.
+	 * @param {Object} p
+	 * @param {string|number} p.postId
+	 * @param {string} p.question
+	 * @param {string[]} p.options - at least 2
+	 * @param {string|number} p.createdBy
+	 * @param {number|null} [p.closesAt]
+	 */
+	async createPoll({ postId, question, options, createdBy, closesAt = null }) {
+		if (!postId || !question || !Array.isArray(options) || options.length < 2) {
+			throw new Error('Invalid poll: need postId, question, and at least 2 options');
+		}
+
+		const pollId = uuid();
+
+		const pollKey = `poll:${pollId}`;
+		const data = {
+			pollId,
+			postId: String(postId),
+			question: String(question),
+			options: JSON.stringify(options),
+			createdBy: String(createdBy ?? ''),
+			createdAt: String(Date.now()),
+			closesAt: closesAt ? String(closesAt) : '',
+		};
+
+		// Store main poll object
+		await db.setObject(pollKey, data);
+
+		// Index polls by post (future-proof if you ever allow >1 poll/post)
+		await db.setAdd(`poll:byPost:${postId}`, pollId);
+
+		// Initialize counts for each option to 0
+		const counts = {};
+		options.forEach((_, idx) => { counts[idx] = 0; });
+		await db.setObject(`poll:counts:${pollId}`, counts);
+
+		return { ...data, options };
+	},
+
+	async getPollById(pollId) {
+		const obj = await db.getObject(`poll:${pollId}`);
+		if (!obj || !obj.pollId) return null;
+		return { ...obj, options: JSON.parse(obj.options || '[]') };
+	},
+
+	async getPollIdsByPostId(postId) {
+		return db.getSetMembers(`poll:byPost:${postId}`);
+	},
+
+	// Common case: one poll per post — return the first if it exists
+	async getPollByPostId(postId) {
+		const ids = await db.getSetMembers(`poll:byPost:${postId}`);
+		if (!ids || !ids.length) return null;
+		return this.getPollById(ids[0]);
+	},
+};
+
+module.exports = PollModel;

src/polls/votes.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const db = require.main.require('./src/database');
+
+const Votes = {
+	/**
+	 * Check if a user already voted in a poll
+	 */
+	async hasUserVoted(pollId, userId) {
+		return db.isSetMember(`poll:voters:${pollId}`, String(userId));
+	},
+
+	/**
+	 * Record a vote and increment counts.
+	 * Throws { code: 'ALREADY_VOTED' } if same user votes again.
+	 */
+	async recordVote({ pollId, userId, optionIndex }) {
+		if (!pollId || !userId || typeof optionIndex !== 'number' || Number.isNaN(optionIndex)) {
+			const e = new Error('Missing pollId/userId or bad optionIndex');
+			e.code = 'BAD_INPUT';
+			throw e;
+		}
+
+		// Uniqueness: check first, then add
+		const already = await db.isSetMember(`poll:voters:${pollId}`, String(userId));
+		if (already) {
+			const err = new Error('User has already voted on this poll');
+			err.code = 'ALREADY_VOTED';
+			throw err;
+		}
+		await db.setAdd(`poll:voters:${pollId}`, String(userId));
+
+		// Optional: store the user’s choice
+		await db.setObject(`poll:vote:${pollId}:${userId}`, {
+			optionIndex: String(optionIndex),
+			createdAt: String(Date.now()),
+		});
+
+		// Increment aggregate count for the chosen option
+		await db.incrObjectField(`poll:counts:${pollId}`, String(optionIndex), 1);
+		return true;
+	},
+
+	/**
+	 * Get aggregate counts for all options in a poll
+	 */
+	async getCounts(pollId) {
+		const counts = await db.getObject(`poll:counts:${pollId}`) || {};
+		const out = {};
+		for (const k of Object.keys(counts)) {
+			out[k] = Number(counts[k]);
+		}
+		return out;
+	},
+
+	/**
+	 * Get the option a specific user voted for
+	 */
+	async getUserChoice(pollId, userId) {
+		const obj = await db.getObject(`poll:vote:${pollId}:${userId}`);
+		if (!obj || typeof obj.optionIndex === 'undefined') {
+			return null;
+		}
+		return Number(obj.optionIndex);
+	},
+};
+
+module.exports = Votes;