chinmaykunkikar / news-aggregator-api

A RESTful API that allows users to fetch news articles from multiple sources based on their preferences.

🙏🏼 नमस्कार

I'm Chinmay, a frontend developer, thriving on the joy of creating delightful web experiences.

news-aggregator-api's Issues

Task - Optimize performance by implementing caching

Implement a caching mechanism to store news articles and reduce the number of calls to external news APIs. Use async/await and Promises to handle cache updates and retrievals.

Write tests for user and preferences validations

Task - Write test cases for the API endpoints

Set up unit testing and write test cases for the API endpoints, focusing on testing input validation and proper functioning of CRUD operations. Make sure to achieve good test coverage and test edge cases.

Task: Show appropriate error messages

Refactor the API code to improve error handling, ensuring that appropriate error messages are returned for different types of errors (e.g., validation errors, authentication errors, authorization errors, and server errors).

Add validations for preference sources.

We can get all sources like this: https://newsapi.org/v2/top-headlines/sources?apiKey=
It will be easy to add a validation to that.

Cache the response for 24hrs

Implement `GET /news` endpoint

GET /news: Fetch news articles based on the logged-in user's preferences.

Use this API: https://newsapi.org/docs

Task: Log API requests and responses for auditing purposes.

Log API requests and responses for auditing purposes. Use a logging library like Winston or Morgan to log request and response data.

Task: Add user email verification to the registration process

Add user email verification to the registration process. Send a verification email with a unique token and require the user to confirm their email address before they can access the API.

Task: Implement a rate limiter

Implement rate limiting to protect the API against brute-force attacks and excessive requests.

User registration and login functionality

Implement user registration and login functionality using bcrypt for password hashing and JWT for token-based authentication. Use POST /register and POST /login endpoints to handle user registration and login requests.

Refactor: News and preferences controllers; constants

• Move preferences logic from routes file to a controller file
• Move news logic from routes file to a controller file
• Move all strings to a constants file

Add environment flags for various use cases

1. Add a flag that can turn off the use of redis. If you don't want to install and setup redis, you can use this flag. (Note: Will also have to use in-memory store for rate limiting).
2. Add a flag to turn off logging.

Implement preferences endpoints

1. GET /preferences

2. PUT /preferences

Task - Implement input validation and sanitization

• For user registration.
• For preferences updates.

Task - Identify potential security vulnerabilities

Task: End-to-end tests for the API

Add end-to-end tests for the API using a testing tool like Supertest to simulate user interaction and test the entire application workflow.