[FEAT]: NewsLetter Page Api Endpoint

[Ajinx1]

Description

Develop a backend endpoint to handle requests for newsletter subscriptions. The endpoint will accept an email address, validate and sanitize it, and then handle both successful and failed validations appropriately. If the email passes validation, it will be stored in the database and a 'success' response will be sent to the client. If validation fails, an error message will be returned._

Acceptance Criteria

• Accepts and validates User's email.
• Persist the data to the database.
• Return the appropriate response and status code

Requirements

• [x] Implement API endpoint with data validation and sanitization
• [x] Set up database integration and secure storage

Expected Outcome

• The user input data should be successfully sent to the backend, or the user will receive an error message if unsuccessful

Endpoint

HTTP POST /api/v1/newsletter

Requests:

headers:

• content-type: application/json

  {
   "email": "testing@gmail.com"
  }

  Responses:

  Successful response

  {
  "status": "success",
  "status_code": 201,
  "message": "subscribed successfully"
  }

  Unsuccessful Response:

  {
  "status": "error",
  "status_code": 409,
  "message": "Email already subscribed"
  }

  Validation Error Response::

  {
  "status": "error",
  "status_code": 422,
  "message": "Validation failed",
  "error": {
      "NewsLetter.Email": "Email must be a valid email address"
  }
  }

Database design

schema

Table new_letters { id uuid [primary key] email varchar(70) created_at timestamp updated_at timestamp }

_

Testing

1. Unit Tests

The systems should have unit tests covering:

• [x] Validates User's email and check for duplicate emails.
• [x] Ensure data is saved correctly to the database.
• [x] Test that the appropriate response and status code is returned

[Ajinx1]

copied from an approved issue here