Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the GET: /comments endpoint. This endpoint will be used to get all comments of a particular reference id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the GET: /comments endpoint.

Is your feature request related to a problem? Please describe.

Various endpoints will need request data or parameters to be validated. This middleware when placed in a particular route and supplied validation rules should accept or reject with an appropriate response

Describe the solution you'd like

Implementation of validation middleware using Joi validation package

Is your feature request related to a problem? Please describe.

The current Contributions.md file contains old endpoints and its also not documentation on how to contribute, which causes confusion due to its file name as a list of endpoints isn't a responsibility of such a file. The CONTRIBUTING.md file should contain documentation on how to contribute so as to be much more in line with the responsibility of such a file.

Describe the solution you'd like

• Create a CONTRIBUTING.md file with documentation on contributing.
• Delete the Contributions.md file as it will not be required anymore with the Swagger Documentation up and running.
• Update the README.md file to direct contributors to the contributing file and also steps on how to view API documentation (via Swagger).

Describe alternatives you've considered

None.

Additional context

The Swagger Documentation will be the single source of truth when it comes to documentation on API endpoints. This will reduce errors and confusion.

Describe the bug

#25 was merged incomplete, leading to CI errors
This should fix CI errors and complement the GET / tests

To Reproduce

Expected behavior

Screenshots

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the GET: comment/{commentId}/reply/all endpoint. This endpoint will be used to get all replies to a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the GET: comment/{commentId}/reply/all endpoint.

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The most upvoted comments are likely to be the most interesting, there should be an option to get all comments in ordered according to to the number of upvotes.

Describe the solution you'd like

A clear and concise description of what you want to happen.
Write a controller that gets all comments including flagged comments from the db and then orders them according tho the number of upvotes.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.
The alternative is that the comments can be sorted in the frontend but our api should be able to return data in this order easily.

Additional context

Add any other context or screenshots about the feature request here.
I think i've explained everything to the best of my ability,please comment if there is any concern

The current model for voting is not really scalable and efficient and could lead to an unreliable voting system

Is your feature request related to a problem? Please describe.

This Document will be a guide to the contributors for them to know how to return their responses and routes.
And also aid easy documentation of the API Endpoints

Describe the solution you'd like

Swagger Documentation Tool for the API Documentation

Describe alternatives you've considered

Aternative Considered is Apiary

Additional context

None

Is your feature request related to a problem? Please describe.

There is no invalid route handler

Describe the solution you'd like

Create a catch-all route for non-existent endpoints. In other words a 404 route handler

Additional context

Currently, invalid routes crash the server because there is no default route handler

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the GET: comments/refs/{refId} endpoint. This endpoint will be used to get all comments of a particular reference id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the GET: comments/refs/{refId} endpoint.

Describe the bug

A clear and concise description of what the bug is.
The comment model is not referencing other models appropriately.

To Reproduce

Steps to reproduce the behavior:

1. Go to controller
2. Click on the comment.js file inside the controller
3. Scroll down to see the schema of the model.
4. see an error: Schema.Types.ObjectId.

Expected behavior

A clear and concise description of what you expected to happen.
It should be: mongoose.Schema.Types.ObjectId

Screenshots

If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [windows]
• Browser [chrome]
• Version 83.0.4103.116

Additional context

No

Is your feature request related to a problem? Please describe.

@shelf/jest-mongodb includes setup, teardown and database in-memory management

Should resolve this nagging warning

Describe the solution you'd like

• Add @shelf/jest-mongodb package #77
• Refactor database code to switch between testing and production environments #77
• Drop wait timeouts from existing tests #77

Describe alternatives you've considered

• Using real cloud database for testing as in TEST_DB_URL from .env.example

Additional context

###Test Feature .
Test cases for downvote and upvote of comments

Description

A Jest test suite function that tests downvote and upvote of comments controller functionality.

Overview

• Users can flag off comments
  This will update the comment as being flagged and the number of times a comment is being flagged off is shown which increases or decreases as the case may be

UPDATE COMMENTS

Controller and API endpoint for updating comments

Describe the solution you'd like

Authenticated user should be able to edit his/her comments and if possible edited comments should carry the label "edited"

Additional context

Edited comments should recognizable, by including an "edited" label

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the DELETE: comment/delete/{commentId} endpoint. This endpoint will be used to delete a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the DELETE: comment/delete/{commentId} endpoint.

Is your feature request related to a problem? Please describe.

• I want to create a function for users to flag off replies of a comment

Is your feature request related to a problem? Please describe.

Currently almost every test suite adds a delay to compensate for the MongoDB connection. As the number of tests increase the time to run tests will become extreme. We also need to prepare the application to work with different DBs either test, development or production environments because at the moment the DB url is hardcoded and inflexible

Describe the solution you'd like

• Move mongoDB connection out of the express app initialization and into main entry file
• Modify DB connection url to use environment variables (something similar mentioned in #24)
• Setup test setup/teardown to enable DB connection only at beginning of all tests and disconnection after all tests are done
• Optionally, seed test DB with initial values that is used within test environment

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the POST: comment/{commentId}/reply/create endpoint. This endpoint will be used to create a reply to a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the POST: comment/{commentId}/reply/create endpoint.

Is your feature request related to a problem? Please describe.

Several contributors with different coding styles may end up sending responses in different formats.

Describe the solution you'd like

Create utility functions/middleware to ensure that all reponses and error messages are uniform

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the PATCH: comment/flag/{commentId} endpoint. This endpoint will be used to set the flagged status of a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the PATCH: comment/flag/{commentId} endpoint.

Is your feature request related to a problem? Please describe.

To enable continuous testing and deployment of develop branch on a test

Describe the solution you'd like

• Run lint and tests on CI on PR and on merge
• Deploy develop branch to a test server on heroku

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints.

Describe the solution you'd like

Create documentation for each comments endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation.

GET ALL COMMENTS (ADMIN)

Write a controller method that returns all comments on a particular expense report including flagged comments for admin moderation

Describe the solution you'd like

Write a controller method and endpoint url that returns all comments on a particular expense report

Describe alternatives you've considered

Another controller method can be written that will return only un-flagged comments for frontend display

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the PATCH: comment/vote/{commentId} endpoint. This endpoint will be used to modify the votes of a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the PATCH: comment/vote/{commentId} endpoint.

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the PATCH: comment/edit/{commentId} endpoint. This endpoint will be used to edit a comment with a particular comment id.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible responses.

Describe alternatives you've considered

None.

Additional context

For more information, see the Contribution documentation on the PATCH: comment/edit/{commentId} endpoint.

Is your feature request related to a problem? Please describe.

This feature will return all replies under a comment and return as json

Describe the solution you'd like

A controller method to implement the endpoint /comments/{commentId}/replies

Describe alternatives you've considered

Additional context

Overview

Every pull request before being being created should have a brief description about the entirety of the what the PR entails:

• What the PR does?
  Summarize the main tasks handled by the PR
• How should it be manually tested?
• Any background context that's needed (e.g. an API KEY etc)
• The related issue this PR is reflecting if any
• Screenshots (where appropriate)

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
The most upvoted comments are likely to be the most interesting, there should be an option to get all comments in ordered according to to the number of upvotes.

Describe the solution you'd like

A clear and concise description of what you want to happen.
Write a controller that gets all comments including flagged comments from the db and then orders them according tho the number of upvotes.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.
The alternative is that the comments can be sorted in the frontend but our api should be able to return data in this order easily.

Additional context

Add any other context or screenshots about the feature request here.
I think i've explained everything to the best of my ability,please comment if there is any concern

###GET ALL COMMENTS (UNFLAGGED)
Controller method that returns ony unflagged comments on a particular expense report for web display

###Solution
Write a controller method and endpoint URL that returns only unflagged comments on a particular expense report

Additional context

Add any other context or screenshots about the feature request here.

Overview

• After replies are made to a specific comment, users can react to these replies by upvoting if the reply is ok to them or downvoting the reply if not

To enable code consistency and possible CI integration, we need to setup linting and a test framework (e.g Jest)

What tasks need to be carried out?

• Setup ESLint
• Setup prettier for code formatting
• Setup Jest testing framework
• Initialize test

Overview

• Users can make replies to a comment

Describe the bug

Refractor of the swagger documentation of API

To Reproduce

Steps to reproduce the behavior:

1. Change the file into multiple files
2. Then we create the main file for the YAML definition
3. Each of the files will reference the main file.

Expected behavior

To ease the teammates that will work on the API docs issue and to prevent breaking changes in code.

Screenshots

No

Desktop (please complete the following information):

• OS: Windows
• Browser Chrome
• Version 83.0.4103.116

Additional context

No

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

• When a test case is created that has to do with database manipulations ,the current database will be affected

Describe the solution you'd like

A clear and concise description of what you want to happen.

• A new database for tests which will be used in test environments
  • create a new database for tests
  • add a new config file for handling the different parameters by environment
  • change the url in mongoose config to point at new test DB

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe.

Code can break, and response not handled properly. To avoid code breaking on live, test cases need be passed and routes coverage be maximum

Describe the solution you'd like

Write test cases using jest for listed endpoints on the Documentation

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

No

Feature

The user comment can be upvoted or downvoted based on the app requirements

Describe the solution you'd like

A user comment can be upvoted or downvoted and the number of votes recorded and dispalyed

Route

'/comments/{commentId}/votes'

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Users should be able to add comments.

Describe the solution you'd like

A clear and concise description of what you want to happen.
The controller will validate the request body and save the comment in the db.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered
This is a core feature so there is really no alternative.

Additional context

Add any other context or screenshots about the feature request here.

U### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Users should be able to get all comments for a particular referenceId (i.e user).

Describe the solution you'd like

A clear and concise description of what you want to happen.
A controller to get all comment for a specific reference Id
Endpoints: /comment/refs/:{refId}

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.
No alternative

Additional context

Add any other context or screenshots about the feature request here.
No

Time Duration to finish

50mins

Is your feature request related to a problem? Please describe.

It is important to do validation of data from a user before persisting it in the db.Data validation can get very complex especially when dealing with multiple schemas like we are.

Describe the solution you'd like

@hapi/joi is a module that is used to define a schema or blueprint of Javascript objects. Once the schema is defined, you then can use Joi's handy methods that come bundled with it, to validate any other objects against the schema. In our case the req.body will be compared with a schema we describe using @hapi/joi. @hapi/joi will also create detailed error messages for us so we don't have to write error messages again and again for every case.

Describe alternatives you've considered

I've considered writing all the validation from scatch for all the schemas but this can get long and clutter our code.

Additional context

With @hapi/joi we can just describe a schema and compare it with data sent by a user every time a POST request is made.Joi will validate the data and create a detailed error message if any errors are found.

I'd like to work on this so please assign this to me if this issue is accepted.

Is your feature request related to a problem? Please describe.

I'd like to start adding documentation for the API but there is no setup for me to view the documentation I write via a route.

Describe the solution you'd like

Setup swagger-jsdoc and swagger-ui-express and integrate the swagger-ui through a route so that we can view the documentation we will be writing.

Describe alternatives you've considered

None

Additional context

None

Is your feature request related to a problem? Please describe.

creating a controller method to enable users to delete an already made comment

Is your feature request related to a problem? Please describe.

Documentation is required so that consumers of the API have a clear idea of how the API works and what is expected of them when using the API and its endpoints. This documentation pertains to the POST: /comment/create endpoint. This endpoint will be used to save new comment coming from a particular report on the web.

Describe the solution you'd like

Create documentation for the endpoint, its method, the required body, the response body, and the other possible response.

Describe alternatives you've considered

None

Additional context

For more information, see the Contribution.md file.

Is your feature request related to a problem? Please describe.

There is no validation of the email to be entered

Describe the solution you'd like

Validation of emails entered and to return an error when an incorrect email is sent

Is your feature request related to a problem? Please describe.

Tests for continuous integration

Describe the solution you'd like

• POST /comments #77
• POST /comments/{commentId}/replies #77
• DELETE /comments/{commentId} #77
• DELETE /comments/{commentId}/replies/{replyId} #77

Describe alternatives you've considered

Additional context

Please assign me to this issue

Is your feature request related to a problem? Please describe.

Initial test example for the root endpoint

Describe the solution you'd like

• test GET /
• test HTTP status
• test JSON object returned

Describe alternatives you've considered

Additional context

I would submit a PR for this issue. Anyone using Jest first time can build on this

Fix readme description error

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like

A clear and concise description of what you want to happen.

• There should be an endpoint to get all replies to a comment

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Endpoint :

GET /comments/{commentId}/replies