@stanlemon/server-with-auth 0.2.11 → 0.3.0

package/src/schema/index.js

@@ -0,0 +1,70 @@
+import Joi from "joi";
+import { ROUTES } from "../constants.js";
+
+/**
+ * Schema for a strong password.
+ */
+export const PASSWORD = Joi.string()
+  .required()
+  .min(8)
+  .max(64)
+  .label("Password");
+
+/**
+ * Schema for creating a new user
+ */
+export const CREATE_USER = Joi.object({
+  username: Joi.string().required().label("Username"),
+  password: PASSWORD,
+});
+
+export const RESET_PASSWORD = Joi.object({
+  username: Joi.string().required().label("Username"),
+});
+
+export const CHANGE_PASSWORD = Joi.object({
+  password: PASSWORD,
+  current_password: PASSWORD.label("Current Password"),
+});
+
+export const USER = Joi.object({});
+
+/**
+ * For use by the DAO to make sure the data shape is correct.
+ */
+export const DAO = Joi.object({
+  id: Joi.string().uuid().label("ID").default("").required(),
+  username: Joi.string().label("Username").default("").required(),
+  password: Joi.string().label("Password").default("").required(),
+  verification_token: Joi.string().label("Verification Token").default(""),
+  verify_at: Joi.date().label("Date Verified").default(null),
+  last_logged_in: Joi.date().label("Date Last Logged In").default(null),
+  created_at: Joi.date().label("Date Created").default(null).required(),
+  last_updated: Joi.date().label("Date Last Updated").default(null).required(),
+});
+
+/**
+ * Base schemas mapped to routes.
+ */
+const SCHEMAS = {
+  [ROUTES.SIGNUP]: CREATE_USER,
+  [ROUTES.RESET]: RESET_PASSWORD,
+  [ROUTES.PASSWORD]: CHANGE_PASSWORD,
+  [ROUTES.USER]: USER,
+};
+
+export default SCHEMAS;
+
+/**
+ * Create a collection of schemas while supplying a custom user schema.
+ * @param {Joi.Schema} user User schema to append to the base schemas for sign up and user operations.
+ * @returns {Object.<string, Joi.Schema>} Schemas by end point.
+ */
+export function createSchemas(user = {}) {
+  return {
+    ...SCHEMAS,
+    [ROUTES.SIGNUP]: SCHEMAS[[ROUTES.SIGNUP]].append(user),
+    [ROUTES.USER]: SCHEMAS[[ROUTES.USER]].append(user),
+    dao: DAO.append(user),
+  };
+}

package/src/utilities/checkSchemas.js

@@ -0,0 +1,25 @@
+import Joi from "joi";
+import { ROUTES } from "../constants.js";
+
+export default function checkSchemas(schemas) {
+  Object.values(schemas).forEach((schema) => {
+    if (!Joi.isSchema(schema)) {
+      throw new Error("The schema object must be of type Joi schema.");
+    }
+  });
+
+  if (schemas[ROUTES.SIGNUP] === undefined) {
+    throw new Error(
+      "The schemas object must have a schema designed for the signup route."
+    );
+  }
+
+  if (
+    !schemas[ROUTES.SIGNUP].describe().keys.username ||
+    !schemas[ROUTES.SIGNUP].describe().keys.password
+  ) {
+    throw new Error(
+      "The schema object for the signup route must have a username and password defined."
+    );
+  }
+}

package/src/utilities/checkUserDao.js

@@ -0,0 +1,7 @@
+import UserDao from "../data/user-dao.js";
+
+export default function checkUserDao(dao) {
+  if (!(dao instanceof UserDao)) {
+    throw new Error("The dao object must be of type UserDao.");
+  }
+}

package/test.http

@@ -2,11 +2,13 @@ GET http://localhost:3003/ HTTP/1.1
 content-type: application/json
 
 ###
-POST http://localhost:3003/auth/register HTTP/1.1
+# @name signup
+
+POST http://localhost:3003/auth/signup HTTP/1.1
 Content-Type: application/json
 
 {
-  "name": "Test Example",
+  "fullName": "Test Example",
   "email": "example@example.com",
   "username": "test123",
   "password": "password"
@@ -19,7 +21,7 @@ POST http://localhost:3003/auth/login HTTP/1.1
 Content-Type: application/json
 
 {
-  "username": "user",
+  "username": "test123",
   "password": "password"
 }
 
@@ -27,11 +29,67 @@ Content-Type: application/json
 
 @authToken = {{login.response.body.token}}
 
-# @name session
+###
+
 GET http://localhost:3003/auth/session
 Authorization: Bearer {{authToken}}
 
 ###
 
+GET http://localhost:3003/auth/user
+Authorization: Bearer {{authToken}}
+
+###
+
 GET http://localhost:3003/api/users
 Authorization: Bearer {{authToken}}
+
+###
+
+PUT http://localhost:3003/auth/user HTTP/1.1
+Authorization: Bearer {{authToken}}
+Content-Type: application/json
+
+{
+  "email": "test@test.com",
+  "fullName": "Stanley Lemon"
+}
+###
+
+POST http://localhost:3003/auth/reset HTTP/1.1
+Authorization: Bearer {{authToken}}
+Content-Type: application/json
+
+{
+  "username": "test123"
+}
+
+###
+
+POST http://localhost:3003/auth/password HTTP/1.1
+Authorization: Bearer {{authToken}}
+Content-Type: application/json
+
+{
+  "currentPassword": "password",
+  "password": "newPassw0rd"
+}
+
+###
+
+DELETE http://localhost:3003/auth/user HTTP/1.1
+Authorization: Bearer {{authToken}}
+
+###
+
+GET http://localhost:3003/auth/logout
+Authorization: Bearer {{authToken}}
+
+###
+
+GET http://localhost:3003/doesNotExist
+
+###
+
+GET http://localhost:3003/api/doesNotExist
+Authorization: Bearer {{authToken}}

package/src/data/lowdb-user-dao.test.js

@@ -1,111 +0,0 @@
-/**
- * @jest-environment node
- */
-import LowDBUserDao, { createInMemoryDb } from "./lowdb-user-dao.js";
-
-describe("lowdb-user-dao", () => {
-  // This is a user that we will reuse in our tests
-  const data = {
-    username: "test",
-    password: "password",
-  };
-
-  /** @type {LowSync} */
-  let db;
-  /** @type {LowDBUserDao} */
-  let dao;
-
-  beforeEach(() => {
-    // Before each test reset our users database
-    db = createInMemoryDb();
-    dao = new LowDBUserDao(db);
-  });
-
-  it("creates a user", async () => {
-    let user = await dao.createUser(data);
-
-    expect(user.username).toEqual(data.username);
-    // The value should be encrypted now
-    expect(user.password).not.toEqual(data.password);
-    // These fields are added by the create process
-    expect(user.verification_token).not.toBeUndefined();
-    expect(user.created_at).not.toBeUndefined();
-    expect(user.last_updated).not.toBeUndefined();
-
-    const refresh = dao.getUserByUsername(data.username);
-
-    // If we retrieve the user by username, it matches the object we got when we created it
-    expect(refresh).toMatchObject(user);
-  });
-
-  it("creates a user with an existing username errors", async () => {
-    let hasError = false;
-
-    try {
-      // Create the user
-      await dao.createUser(data);
-      // Attempt to create the user again, this will fail
-      await dao.createUser(data);
-    } catch (err) {
-      hasError = err;
-    }
-
-    expect(hasError).not.toBe(false);
-    expect(hasError.message).toEqual("This username is already taken.");
-  });
-
-  it("retrieve user by username and password", async () => {
-    const user1 = await dao.createUser(data);
-
-    const user2 = dao.getUserByUsernameAndPassword(
-      data.username,
-      data.password
-    );
-
-    expect(user1).toMatchObject(user2);
-  });
-
-  it("retrieve user by username and wrong password fails", async () => {
-    await dao.createUser(data);
-
-    const user2 = dao.getUserByUsernameAndPassword(
-      data.username,
-      "wrong password"
-    );
-
-    expect(user2).toBe(false);
-  });
-
-  it("retrieve user by username and undefined password fails", async () => {
-    await dao.createUser(data);
-
-    const user2 = dao.getUserByUsernameAndPassword(data.username, undefined);
-
-    expect(user2).toBe(false);
-  });
-
-  it("retrieve user by username that does not exist fails", async () => {
-    const user = dao.getUserByUsernameAndPassword("notarealuser", "password");
-
-    expect(user).toBe(false);
-  });
-
-  it("retrieve user by username that is undefined fails", async () => {
-    const user = dao.getUserByUsernameAndPassword(undefined, "password");
-
-    expect(user).toBe(false);
-  });
-
-  it("deletes a user by id", async () => {
-    const user = await dao.createUser(data);
-
-    expect(db.data.users).toHaveLength(1);
-
-    const deleted = dao.deleteUser(user.id);
-
-    expect(deleted).toBe(true);
-    expect(dao.getUserById(user.id)).toBeUndefined();
-
-    expect(db.data.users).toHaveLength(0);
-  });
-});

package/src/schema/user.js

@@ -1,8 +0,0 @@
-import Joi from "joi";
-
-const schema = Joi.object({
-  username: Joi.string().required().label("Username"),
-  password: Joi.string().required().min(8).max(64).label("Password"),
-});
-
-export default schema;