Ticket16 #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

KitilCode wants to merge 33 commits into colorstackorg:main from KitilCode:ticket16

README.md

-Original file line number
+Diff line change
@@ -1,5 +1,8 @@
-    # PodSpace Template README
-    Skeleton code for the ColorStack Sprout Fall '21 pod project. PodSpace is a private social network for pods to stay connected with each other after the program.
-    ## Collaborators
+    # PodSpace Template README
+    Skeleton code for the ColorStack Sprout Fall '21 pod project. PodSpace is a private social network for pods to stay connected with each other after the program.
+    ## Collaborators
+    Dusk Kitil / CS @ Cornell University '25 <br>
+    Othniel Bondah / CS @ WPI '23

package-lock.json

Large diffs are not rendered by default.

package.json

-Original file line number
+Diff line change
@@ -1,64 +1,66 @@
-    {
-      "name": "@colorstack/podspace-server",
-      "author": "ColorStack, Inc.",
-      "license": "MIT",
-      "version": "0.1.0",
-      "description": "Skeleton backend code for the Sprout Fellowship '21 project.",
-      "scripts": {
-        "build": "tsc",
-        "copy-env:dev": "openssl base64 < ./.env.development | tr -d '\n' | pbcopy",
-        "copy-env:prod": "openssl base64 < ./.env.production | tr -d '\n' | pbcopy",
-        "dev": "env-cmd -f ./.env.development ts-node-dev src/index.ts",
-        "format": "prettier --ignore-path .gitignore --list-different \"**/*.+(ts|tsx)\"",
-        "format:fix": "prettier --ignore-path .gitignore --write \"**/*.+(ts|tsx)\"",
-        "lint": "eslint --ignore-path .gitignore . --ext .ts,.tsx src",
-        "lint:fix": "eslint --ignore-path .gitignore . --ext .ts,.tsx src --fix",
-        "test": "env-cmd -f ./.env.development jest --runInBand --verbose"
-      },
-      "dependencies": {
-        "aws-sdk": "^2.978.0",
-        "body-parser": "^1.19.0",
-        "cookie-parser": "^1.4.5",
-        "cors": "^2.8.5",
-        "express": "^4.17.1",
-        "express-validator": "^6.12.1",
-        "helmet": "^4.6.0",
-        "jsonwebtoken": "^8.5.1",
-        "mongodb": "^3.6.9",
-        "mongoose": "^5.12.13",
-        "multer": "^1.4.3",
-        "twilio": "^3.67.0"
-      },
-      "devDependencies": {
-        "@types/cookie-parser": "^1.4.2",
-        "@types/cors": "^2.8.12",
-        "@types/express": "^4.17.12",
-        "@types/jest-in-case": "^1.0.3",
-        "@types/jsonwebtoken": "^8.5.4",
-        "@types/multer": "^1.4.7",
-        "@types/supertest": "^2.0.11",
-        "@typescript-eslint/eslint-plugin": "^4.26.1",
-        "@typescript-eslint/parser": "^4.26.1",
-        "env-cmd": "^10.1.0",
-        "eslint": "^7.28.0",
-        "eslint-config-airbnb": "^18.2.1",
-        "eslint-config-prettier": "^8.3.0",
-        "eslint-config-rami": "^1.0.9",
-        "eslint-plugin-import": "^2.23.4",
-        "eslint-plugin-jest": "^24.3.6",
-        "eslint-plugin-jsx-a11y": "^6.4.1",
-        "eslint-plugin-prettier": "^3.4.0",
-        "eslint-plugin-react": "^7.24.0",
-        "eslint-plugin-react-hooks": "^4.2.0",
-        "eslint-plugin-simple-import-sort": "^7.0.0",
-        "eslint-plugin-sort-keys-fix": "^1.1.1",
-        "jest": "^27.0.4",
-        "jest-in-case": "^1.0.2",
-        "prettier": "^2.3.1",
-        "supertest": "^6.1.6",
-        "ts-jest": "^27.0.3",
-        "ts-loader": "^9.2.4",
-        "ts-node-dev": "^1.1.6",
-        "typescript": "^4.3.2"
-      }
-    }
+    {
+      "name": "@colorstack/podspace-server",
+      "author": "ColorStack, Inc.",
+      "license": "MIT",
+      "version": "0.1.0",
+      "description": "Skeleton backend code for the Sprout Fellowship '21 project.",
+      "scripts": {
+        "build": "tsc",
+        "copy-env:dev": "openssl base64 < ./.env.development | tr -d '\n' | pbcopy",
+        "copy-env:prod": "openssl base64 < ./.env.production | tr -d '\n' | pbcopy",
+        "dev": "env-cmd -f ./.env.development ts-node-dev src/index.ts",
+        "format": "prettier --ignore-path .gitignore --list-different \"**/*.+(ts|tsx)\"",
+        "format:fix": "prettier --ignore-path .gitignore --write \"**/*.+(ts|tsx)\"",
+        "lint": "eslint --ignore-path .gitignore . --ext .ts,.tsx src",
+        "lint:fix": "eslint --ignore-path .gitignore . --ext .ts,.tsx src --fix",
+        "test": "env-cmd -f ./.env.development jest --runInBand --verbose"
+      },
+      "dependencies": {
+        "aws-sdk": "^2.978.0",
+        "body-parser": "^1.19.0",
+        "cookie-parser": "^1.4.5",
+        "cors": "^2.8.5",
+        "express": "^4.17.1",
+        "express-validator": "^6.13.0",
+        "helmet": "^4.6.0",
+        "jsonwebtoken": "^8.5.1",
+        "mathjs": "^9.5.1",
+        "mongodb": "^3.6.9",
+        "mongoose": "^5.12.13",
+        "multer": "^1.4.3",
+        "twilio": "^3.67.0"
+      },
+      "devDependencies": {
+        "@types/cookie-parser": "^1.4.2",
+        "@types/cors": "^2.8.12",
+        "@types/express": "^4.17.12",
+        "@types/jest-in-case": "^1.0.3",
+        "@types/jsonwebtoken": "^8.5.4",
+        "@types/multer": "^1.4.7",
+        "@types/node": "^16.10.9",
+        "@types/supertest": "^2.0.11",
+        "@typescript-eslint/eslint-plugin": "^4.26.1",
+        "@typescript-eslint/parser": "^4.26.1",
+        "env-cmd": "^10.1.0",
+        "eslint": "^7.28.0",
+        "eslint-config-airbnb": "^18.2.1",
+        "eslint-config-prettier": "^8.3.0",
+        "eslint-config-rami": "^1.0.9",
+        "eslint-plugin-import": "^2.23.4",
+        "eslint-plugin-jest": "^24.3.6",
+        "eslint-plugin-jsx-a11y": "^6.4.1",
+        "eslint-plugin-prettier": "^3.4.0",
+        "eslint-plugin-react": "^7.24.0",
+        "eslint-plugin-react-hooks": "^4.2.0",
+        "eslint-plugin-simple-import-sort": "^7.0.0",
+        "eslint-plugin-sort-keys-fix": "^1.1.1",
+        "jest": "^27.0.4",
+        "jest-in-case": "^1.0.2",
+        "prettier": "^2.3.1",
+        "supertest": "^6.1.6",
+        "ts-jest": "^27.0.3",
+        "ts-loader": "^9.2.4",
+        "ts-node-dev": "^1.1.6",
+        "typescript": "^4.3.2"
+      }
+    }

src/models/AuthCode.ts

-Original file line number
+Diff line change
@@ -1,60 +1,65 @@
-    import mongoose, { Document, Schema } from 'mongoose';
-    import AuthUtils from '../utils/AuthUtils';
-    import { Model } from '../utils/constants';
-    import { BaseModel } from '../utils/types';
-    /**
-     * (1.01) TODO:
-     * - Read this interface.
-     * - Delete this comment once you've done so.
-     */
-    interface IAuthCode extends BaseModel {
-      /**
-       * Phone number in which the OTP code is associated with.
-       *
-       * There should a MAXIMUM of 1 AuthCode document per phone number. For
-       * example, if they submit their phone number twice at the login screen,
-       * and they receive 2 text messages (and different codes), then only the
-       * latter one will be associated with this phone number.
-       */
-      phoneNumber: string;
-      /**
-       * 6-digit OTP code that is generated randomly. This code is
-       * automatically generated upon creation of an AuthCode document.
-       */
-      value: number;
-    }
-    export type AuthCodeDocument = Document<{}, {}, IAuthCode> & IAuthCode;
-    const authCodeSchema: Schema<AuthCodeDocument> = new Schema<AuthCodeDocument>(
-      /**
-       * (1.03) TODO:
-       * - Create the schema for the AuthCodes that we'll save in the database.
-       * - Delete this comment and the example field.
-       * - Add comment(s) to explain your work.
-       */
-      {
-        // Here's an example of how to add a field to the schema.
-        exampleField: { required: true, type: String, unique: false }
-      },
-      { timestamps: true }
-    );
-    /**
-     * (1.04) TODO:
-     * - Add a line of code here that will elete every document in the "AuthCode"
-     * collection after 5 minutes (60 seconds * 5).
-     * - To be very clear, the only way you're going to figure this out is by
-     * Googling around for the answer. The solution is one line.
-     * - Once you find something, add the code to this document and include a link
-     * to the code you found in a comment.
-     * */
-    const AuthCode: mongoose.Model<AuthCodeDocument> =
-      mongoose.model<AuthCodeDocument>(Model.AUTH_CODE, authCodeSchema);
-    export default AuthCode;
+    /* eslint-disable prettier/prettier */
+    import { string } from 'mathjs';
+    import mongoose, { Document, Schema } from 'mongoose';
+    import AuthUtils from '../utils/AuthUtils';
+    import { Model } from '../utils/constants';
+    import { BaseModel } from '../utils/types';
+    /**
+     * (1.01) TODO:
+     * - Read this interface.
+     * - Delete this comment once you've done so.
+     */
+    interface IAuthCode extends BaseModel {
+      /**
+       * Phone number in which the OTP code is associated with.
+       *
+       * There should a MAXIMUM of 1 AuthCode document per phone number. For
+       * example, if they submit their phone number twice at the login screen,
+       * and they receive 2 text messages (and different codes), then only the
+       * latter one will be associated with this phone number.
+       */
+      phoneNumber: string;
+      /**
+       * 6-digit OTP code that is generated randomly. This code is
+       * automatically generated upon creation of an AuthCode document.
+       */
+      value: number;
+    }
+    export type AuthCodeDocument = Document<{}, {}, IAuthCode> & IAuthCode;
+    const authCodeSchema: Schema<AuthCodeDocument> = new Schema<AuthCodeDocument>(
+      /**
+       * (1.03) TODO:
+       * - Create the schema for the AuthCodes that we'll save in the database.
+       * - Delete this comment and the example field.
+       * - Add comment(s) to explain your work.
+       */
+      {
+        // Here's an example of how to add a field to the schema.
+        // exampleField: { required: true, type: String, unique: false }
+        phoneNumber: { required: true, type: String, unique: true },
+        value: { default: AuthUtils.generateOTP, required: true, type: String }
+      },
+      { timestamps: true }
+    );
+    /**
+     * (1.04) TODO:
+     * - Add a line of code here that will elete every document in the "AuthCode"
+     * collection after 5 minutes (60 seconds * 5).
+     * - To be very clear, the only way you're going to figure this out is by
+     * Googling around for the answer. The solution is one line.
+     * - Once you find something, add the code to this document and include a link
+     * to the code you found in a comment.
+     * */
+    authCodeSchema.index({ createdAt: 1 }, { expireAfterSeconds: 60 * 2 });
+    const AuthCode: mongoose.Model<AuthCodeDocument> =
+      mongoose.model<AuthCodeDocument>(Model.AUTH_CODE, authCodeSchema);
+    export default AuthCode;

src/models/Comment.ts

-Original file line number
+Diff line change
@@ -1,60 +1,52 @@
-    import mongoose, { Document, PopulatedDoc, Schema } from 'mongoose';
-    import TextService from '../services/TextService';
-    import { Model } from '../utils/constants';
-    import { BaseModel, ID } from '../utils/types';
-    import Post, { PostDocument } from './Post';
-    import User, { UserDocument } from './User';
-    /**
-     * TODO: (5.01)
-     * - Read this interface.
-     * - Delete this comment once you've done so.
-     */
-    interface IComment extends BaseModel {
-      /**
-       * User that is associated with the creation of the comment.
-       */
-      author: PopulatedDoc<UserDocument>;
-      /**
-       * Text content of the comment.
-       */
-      content: string;
-      /**
-       * Post that the comment was created on.
-       */
-      post: PopulatedDoc<PostDocument>;
-    }
-    export type CommentDocument = Document<{}, {}, IComment> & IComment;
-    const commentSchema: Schema<CommentDocument> = new Schema<CommentDocument>(
-      {
-        /**
-         * (5.02) TODO:
-         * - Create the schema for the Comments that we'll save in the database using
-         * the interface above as a reference.
-         * - Delete this comment and the example field.
-         * - Add comment(s) to explain your work.
-         */
-        exampleField: { ref: Model.USER, required: false, type: ID, unique: false }
-      },
-      { timestamps: true }
-    );
-    commentSchema.pre('save', function () {
-      if (this.isNew) {
-        /**
-         * TODO: (6.05)
-         * - Send a text to the author of the post notifying them that a podmate
-         * commented under it!
-         */
-      }
-    });
-    const Comment: mongoose.Model<CommentDocument> =
-      mongoose.model<CommentDocument>(Model.COMMENT, commentSchema);
-    export default Comment;
+    import mongoose, { Document, PopulatedDoc, Schema } from 'mongoose';
+    import TextService from '../services/TextService';
+    import { Model } from '../utils/constants';
+    import { BaseModel, ID } from '../utils/types';
+    import Post, { PostDocument } from './Post';
+    import User, { UserDocument } from './User';
+    interface IComment extends BaseModel {
+      /**
+       * User that is associated with the creation of the comment.
+       */
+      author: PopulatedDoc<UserDocument>;
+      /**
+       * Text content of the comment.
+       */
+      content: string;
+      /**
+       * Post that the comment was created on.
+       */
+      post: PopulatedDoc<PostDocument>;
+    }
+    export type CommentDocument = Document<{}, {}, IComment> & IComment;
+    const commentSchema: Schema<CommentDocument> = new Schema<CommentDocument>(
+      {
+        author: { ref: Model.USER, required: true, type: ID },
+        content: { required: true, type: String },
+        post: { ref: Model.POST, required: true, type: ID }
+      },
+      { timestamps: true }
+    );
+    commentSchema.pre('save', async function () {
+      if (this.isNew) {
+        const post: PostDocument = await Post.findById(this.post);
+        const postAuthor: UserDocument = await User.findById(post.author);
+        TextService.sendText({
+          message: 'One of your podmates commented on your post',
+          to: postAuthor.phoneNumber
+        });
+      }
+    });
+    const Comment: mongoose.Model<CommentDocument> =
+      mongoose.model<CommentDocument>(Model.COMMENT, commentSchema);
+    export default Comment;

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ticket16 #35

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Ticket16 #35

Are you sure you want to change the base?

Uh oh!

Ticket16 #35

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!