Fixed failing tests and prepared for release

Luciano Nooijen · Luciano Nooijen · commit 7f11b6c4da13 · 2018-12-06T15:58:42.000+01:00
diff --git a/README.md b/README.md
@@ -50,6 +50,13 @@ const debug = true || false;
 const blog = nodeBlog(client, host, user, database, password, debug);
 ```
 
+For authentication you should set the following environment (`process.env.[variable] = value`) variables, or the auth methods will not work:
+```
+SALT_ROUNDS=number
+JWT_SECRET=string
+JWT_EXPIRES_IN_DAYS=number_of_days
+```
+
 Then you can use the imported functions as you wish, for example:
 
 ```js
@@ -67,8 +74,10 @@ authors.add(blog, authorObject)
 authors.modify(blog, id, modifiedData)
 authors.delete(blog, id)
 
-auth.authenticate(blog, username, password) // Returns JWT
-auth.validate(blog, username, password) // Valid if data object is returned
+auth.authenticate(blog, username, password) // Returns true/false
+auth.generateToken(blog, username, password) // Returns JWT, throws error if invalid credentials
+auth.decode(jwt) // Returns decoded object
+auth.validate(blog, username, password) // Returns true/false
 
 users.list(blog)
 users.get(blog, id)
diff --git a/controllers/auth.js b/controllers/auth.js
@@ -40,7 +40,7 @@ const generateToken = async (knex, username, password) => {
 };
 
 const validateToken = async (knex, token) => {
-    let decodedToken = '';
+    let decodedToken = null;
 
     // Check if token can be decoded, is valid format
     try {
diff --git a/src/create-node-blog.js b/src/create-node-blog.js
@@ -1,7 +1,8 @@
-/* eslint-disable object-curly-newline */ // TODO: Write docs!!!!!!
+/* eslint-disable object-curly-newline */
 
 const getKnexInstance = require('knex');
 const generateKnexfile = require('../database/generate-knexfile');
+const { authHelper } = require('../helpers');
 
 const {
     Authors,
@@ -20,7 +21,9 @@ const authors = {
 };
 
 const auth = {
+    generateToken: Auth.generateToken,
     authenticate: Auth.authenticateUser,
+    decode: authHelper.decodeJWT,
     validate: Auth.validateToken,
 };
 
diff --git a/tests/controllers/auth.test.ts b/tests/controllers/auth.test.ts
@@ -111,7 +111,7 @@ describe('Auth Controller', () => {
         expect.assertions(1);
         const { username } = testUser;
         const tokenPayloadData = await generateTokenPayload(blog, username);
-        const validToken = authHelper.generateJWT(blog, tokenPayloadData);
+        const validToken = authHelper.generateJWT(tokenPayloadData);
         const validTokenIsValid = await validateToken(blog, validToken);
         expect(validTokenIsValid).toBe(true);
     });
diff --git a/tests/controllers/users.test.ts b/tests/controllers/users.test.ts
@@ -70,7 +70,7 @@ describe('Test if Users CRUD operations are working correctly', () => {
         const addedUser = await addUser(blog, newUser);
         const hashed = addedUser.password;
         const isValidHash =
-            await checkPasswordHash(blog, unhashedPassword, hashed);
+            await checkPasswordHash(unhashedPassword, hashed);
         expect(hashed).not.toBe(newUser.password);
         expect(isValidHash).toBe(true);
     });
