converted to TDD project

as all the tests are basically written right there in the acceptance criteria already

Author: SallyMcGrath

.gitignore

@@ -0,0 +1,2 @@
+
+E-Commerce-API/node_modules/

E-Commerce-API/index.js E-Commerce-API/app.jsE-Commerce-API/index.js renamed to E-Commerce-API/app.js

@@ -1,7 +1,8 @@
 const express = require("express");
 const app = express();
-const { Pool } = require("pg");
 // Your code to run the server should go here
 // Don't hardcode your DB password in the code or upload it to GitHub! Never ever do this ever.
 // Use environment variables instead:
 // https://www.codementor.io/@parthibakumarmurugesan/what-is-env-how-to-set-up-and-run-a-env-file-in-node-1pnyxw9yxj
+
+module.exports = app;

E-Commerce-API/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "cyf-ecommerce-api",
+  "version": "1.0.0",
+  "description": "API for the CYF ecommerce application",
+  "main": "index.js",
+  "scripts": {
+    "start": "node app.js",
+    "test": "jest"
+  },
+  "keywords": [
+    "node",
+    "express",
+    "API",
+    "CYF"
+  ],
+  "author": "CYF",
+  "license": "CC-BY-4-0",
+  "dependencies": {
+    "express": "^4.17.1"
+  },
+  "devDependencies": {
+    "jest": "^27.2.5",
+    "supertest": "^6.1.6"
+  }
+}

E-Commerce-API/readme.md

@@ -1,9 +1,15 @@
 # Project Brief: E-Commerce API
 
+You are a developer building an Express application to connect your e-commerce database to a shop front. Your client requires a fully tested API so you will write this application TDD-style: writing the test first and then the code to make the test pass. There is a starter test given to help you, that satisfies the first user story.
+
+How will you make this test pass?
+
 ## User Stories
 
 As a developer, I want to add new API endpoints to the NodeJS application for the cyf-ecommerce-api, so that I can improve the functionality of the application.
 
+As a developer, I want to build up my API using TDD - writing the test first and then iterating : adding one feature to pass one unit test.
+
 - As a user, I want to view a list of all products with their prices and supplier names.
 - As a user, I want to search for products by name.
 - As a user, I want to view a single customer by their ID.
@@ -18,6 +24,11 @@ As a developer, I want to add new API endpoints to the NodeJS application for th
 
 ## Acceptance Criteria
 
+- [ ] Each user story has an accompanying unit test
+- [ ] Secrets are not stored in the codebase
+
+<details>
+<summary>Try writing out your own acceptance criteria from the user stories before looking here</summary>
 - [ ] Endpoint `/products` should return a list of all product names with their prices and supplier names.
 - [ ] Endpoint `/products` should filter the list of products by name using a query parameter, even if the parameter is not used.
 - [ ] Endpoint `/customers/:customerId` should load a single customer by their ID.
@@ -29,3 +40,12 @@ As a developer, I want to add new API endpoints to the NodeJS application for th
 - [ ] Endpoint `/orders/:orderId` should delete an existing order and all associated order items.
 - [ ] Endpoint `/customers/:customerId` should delete an existing customer only if the customer doesn't have any orders.
 - [ ] Endpoint `/customers/:customerId/orders` should load all the orders along with the items in the orders of a specific customer. The information returned should include order references, order dates, product names, unit prices, suppliers, and quantities.
+</details>
+
+### Sanity check!
+
+In this project, you must write the test first.
+
+It's better to turn in a smaller set of user stories than to turn in untested features.
+
+If you're running out of time, scope down your application rather than commit untested code. Cut your _scope_, not your quality.

E-Commerce-API/tests/products.spec.js

@@ -0,0 +1,18 @@
+const request = require("supertest");
+const app = require("../app");
+
+describe("GET /products", () => {
+  it("should return a list of all product names with their prices and supplier names", async () => {
+    const response = await request(app).get("/products");
+    expect(response.status).toBe(200);
+    expect(response.body).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          name: expect.any(String),
+          price: expect.any(Number),
+          supplierName: expect.any(String),
+        }),
+      ])
+    );
+  });
+});