README.md

@@ -22,4 +22,4 @@ pnpm build
 pnpm start
 ```
 
-To post a review to the server, use [Simple Review Client](https://git.povario.com/powermaker450/simple-review-client), or consult the [API Docs](https://git.povario.com/powermaker450/simple-review-server/src/branch/main/docs/API.md)
+To post a review to the server, use [Simple Review Client](https://git.povario.com/powermaker450/simple-review-client)

docs/API.md

@@ -1,4 +0,0 @@
-# API Docs
-
-### [POST](https://git.povario.com/powermaker450/simple-review-server/src/branch/main/docs/POST.md)
-### [GET](https://git.povario.com/powermaker450/simple-review-server/src/branch/main/docs/GET.md)

docs/GET.md

@@ -1,75 +0,0 @@
-# GET
-
-## `/api/reviews/`
-
-**Response Codes:** `200` \
-**Response Format:** `JSON`
-
-### Example response:
-
-```
-[
-    {
-        "username": "bob",
-        "rating": 4.5,
-        "title": "All fields",
-        "content": "This user review contains all required and allowed fields!",
-        "id": "a1b2c3",
-        "timestamp": "2024-09-12T03a:55:23.830Z"
-    },
-    {
-        "username": "sarah",
-        "rating": 4.5,
-        "title": "Only a title",
-        "content": null,
-        "id": "e1f2g3",
-        "timestamp": "2024-09-12T03a:56:23.830Z"
-    },
-    {
-        "username": "phillip",
-        "rating": 4.5,
-        "title": null,
-        "content": null,
-        "id": "h1i2j3",
-        "timestamp": "2024-09-12T03a:57:23.830Z"
-    }
-]
-```
-
----
-
-## `/api/reviews/:id`
-
-**Response Codes:** `200`, `404`, `400` \
-**Response Format:** `JSON`
-
-## Example requests and responses:
-
-### Good Request
-`GET /api/reviews/a1b2c3`
-
-**Server Response (`200`):**
-```
-{
-    "username": "bob",
-    "rating": 4.5,
-    "title": "All fields",
-    "content": "This user review contains all required and allowed fields!",
-    "timestamp": "2024-09-12T03a:55:23.830Z"
-}
-```
-
-### Bad Request
-`GET /api/reviews/a`
-
-**Server Response (`400`)**:
-```
-{
-    error: {
-        "type": "requestError",
-        "message": "review id must be 6 characters"
-    }
-}
-```
-
----

docs/POST.md

@@ -1,59 +0,0 @@
-# POST
-
-## `/api/post`
-
-**Encoding:** `JSON` \
-**Response Codes:** `201`, `400`, `500` \
-**Response Format:** `JSON`
-
-**Schema:**
-| **Field** | **Type** |     **Info**     | **Required** |
-| --------- | -------- | ---------------- | ------------ |
-| username  | string   | 2-30 characters  | `true`       |
-| rating    | number   | from 0.5-5, only .5 increments | `true` |
-| title     | string   | 0-50 characters | `false` |
-| content   | string   | 0-2000 characters | `false` |
-
-## Example Objects (being submitted by a client):
-
-### Good Request
-```
-{
-    "username": "bob",
-    "rating": 4.5,
-    "title": "All fields",
-    "content": "This user review contains all required and allowed fields!"
-}
-```
-
-**Server Response (`200`):**
-```
-{
-    "message": "review was sent"
-}
-```
-
-### Bad Request
-```
-{
-    "username": "hacker",
-    "rating": -3
-}
-```
-**Server Response (`400`):**
-```
-{
-    "error": {
-        "type": "ValidationError",
-        "message": "rating must be a positive number"
-    }
-}
-```
-
-**Additional info:** When submitted, the server will add two more fields to your review and store this info server side:
-| **Field** | **Type** | **Info** |
-| --------- | -------- | -------- |
-| id        | string   | 6 randomly-generated characters |
-| timestamp | string   | ISO timestamp |
-
----

src/routes/reviews.ts

@@ -22,33 +22,20 @@ export class MessagesResponder extends ApiRoute {
     });
 
     this.server.get(`${this.routeName}/:id`, (req: IdRequest, res: Response) => {
-      // "req.params.id" is the review ID that was receieved
-      // "result" is the review that is identified by that ID, if any
-
       const receiver = req.headers["user-agent"];
       const result = data.getReviewById(req.params.id);
-      let err = false;
 
-      if (req.params.id.length === 6) {
+      if (Object.keys(result).length) {
-        if (Object.keys(result).length) {
+        res.writeHead(200, typeJson);
-          res.writeHead(200, typeJson);
+        res.write(JSON.stringify(result));
-          res.write(JSON.stringify(result));
+        res.end();
-          res.end();
+      } else {
-        } else {
+        res.writeHead(404, typeJson);
-          res.writeHead(404, typeJson);
+        res.write(Responder.requestError("review not found"));
-          res.write(Responder.notFoundError("review not found"));
-          res.end();
-          err = true;
-        }
-      } else {
-        res.writeHead(400, typeJson);
-        res.write(Responder.requestError("review id must be 6 characters"));
         res.end();
-        err = true;
       }
 
-      // If an error was returned to the client, mark their user agent red in the logs
+      this.logger.log(`${Logger.emp(receiver)} <~ "${req.path}"`);
-      this.logger.log(`${err ? Logger.err(receiver) : Logger.emp(receiver)} <~ "${req.path}"`);
     });
 
     this.complete();

src/utils/responder.ts

@@ -42,13 +42,4 @@ export class Responder {
       },
     });
   }
-
-  public static notFoundError(errorMessage: string): string {
-    return JSON.stringify({
-      error: {
-        type: "notFoundError",
-        message: errorMessage
-      }
-    });
-  }
 }