vagaBlog

This is an API for a Blogging App.

Requirements

Users should have a first_name, last_name, email, password, (you can add other attributes you want to store about the user)
A user should be able to sign up and sign in into the blog app
Use JWT as authentication strategy and expire the token after 1 hour
A blog can be in two states; draft and published
Logged in and not logged in users should be able to get a list of published blogs created
Logged in and not logged in users should be able to to get a published blog
Logged in users should be able to create a blog.
When a blog is created, it is in draft state
The owner of the blog should be able to update the state of the blog to published
The owner of a blog should be able to edit the blog in draft or published state
The owner of the blog should be able to delete the blog in draft or published state
The owner of the blog should be able to get a list of their blogs.
- The endpoint should be paginated
- It should be filterable by state
Blogs created should have title, description, tags, author, timestamp, state, read_count, reading_time and body.
The list of blogs endpoint that can be accessed by both logged in and not logged in users should be paginated,
- it should be defaulted to 20 blogs per page.
- It should also be searchable by author, title and tags.
- It should also be orderable by read_count, reading_time and timestamp
When a single blog is requested, the api should return the user information(the author) with the blog. The read_count of the blog too should be updated by 1
Should have an algorithm for calculating the reading_time of the blog.
Written tests for all endpoints

Setup

Install NodeJS, mongodb
pull this repo
update env with example.env
run npm run start:dev

Base URL

User

field	data_type	constraints
id	string	required
first_name	string	required
last_name	string	required
username	string	optional
email	string	required
password	string	required
role	string	optional, default: user, enum: ['user', 'admin']

Blog

field	data_type	constraints
id	string	required
timestamp	date	required
title	string	required
description	string	optional
tags	array	optional
author	ref	required
body	string	required
read_count	number	optional, default: 0
reading_time	string	optional,
state	string	required, enum default: 'draft', ['draft', 'published']

Signup User

Route: /api/v1/users/signup
Method: POST
Body:

{
    "first_name":"John",
    "last_name":"Doe",
    "email":"johndoe@yahoo.com",
    "password": "johndoepassword",
    "role": "user"
}

Responses

Success

{
    "status": "success",
    "data": {
        "user": {
            "first_name": "John",
            "last_name": "Dickson",
            "email":"johndoe@yahoo.com",
            "role": "user",
            "_id": "63652a9fe3fcbf87f4d90208",
            "username": "john_doe",
        }
    }
}

Login User

Route: /api/v1/users/login
Method: POST
Body:

{
  "email":"johndoe@yahoo.com",
  "password": "johndoepassword",
}

Responses

Success

{
    "status": "success",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6Ij...",
    "data": {
        "user": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "johndoe@yahoo.com",
            "role": "user",
            "username": "john_doe",
        }
    }
}

Get All Blogs

Route: /api/v1/blogs/
Method: GET
Body:
Query params:
- state (published)
- page (default: 1)
- per_page (default: 20)
- search by (options: tags | author (id) | title)
- order_by (default: read_count reading_time timestamp)
- order (options: asc | desc, default: desc)
Responses

Success

{
    "status": "success",
    "results": 4,
    "totalPages": 1,
    "currentPage": 1,
    "data": {
      "blogs": [
            {Object 1},
             {
                "_id": "63682894a76c94cc97dbc93d",
                "title": "Function of words",
                "description": "The function of words in our everyday lives and career.",
                "tags": ["words", "text", "learning"],
                "author": {
                    "_id": "63652a9fe3fcbf87f4d90208",
                    "username": "john_doe"
                },
                "state": "published",
                "read_count": 0,
                "body": "If the word kerning is kerned poorly, it kind of looks like learning - which is appropriate because both are importantA tagline for an airline: Take the High RoadI'm in a band that does Metallica covers with our private parts...",
                "timestamp": "2022-11-06T21:26:57.010Z",
                "reading_time": "2 mins",
                "__v": 0
            },
            {Object 3},
            {Object 4},
      ]
    },
}

Get A Blog

Route: /api/v1/blogs/:id
Method: GET
Body:
Query params:
- id
- state (published)
Responses

Success

{
    "status": "success",
    "data": {
      "blog": {
         "_id": "63652b25e3fcbf87f4d90210",
        "title": "Gentridue Indulgence",
        "description": "Making AI in the lightest means can be considered deadly in the long run because...",
        "tags": ["Artificial Intelligence","soft AI","hard AI"],
        "author": {
            "_id": "63652a9fe3fcbf87f4d90208",
            "username": "john_doe",
        },
        "state": "published",
        "read_count": 1,
        "body": "Denote simple fat denied add worthy little use. As some he so high down am week...",
        "timestamp": "2022-11-04T15:06:12.028Z",
        "reading_time": "1 mins",
      }
    },

}

Delete A Blog

Route: /api/v1/blogs/:id
Method: DELETE
Body:
Header:
- Authorization: Bearer {(admin) token}
Query params:
- search by (id)
- state (options: published)
Responses

Success

{
    "status": "success",
    "data": null

}

Create A Blog

Route: /api/v1/blogs/
Method: POST
Body:

{
    "title": "Ring light in the dark",
    "description": "Production of paper from wood e.g softwood or hardwood",
    "tags": ["paper", "pulp", "chemical compound"],
    "body": "Lorem Ipsum comes from a latin text written in 45BC by Roman statesman, lawyer, scholar..."
}

Header:
- Authorization: Bearer {(user) token}
Query params: nil
Responses

Success

{
    "status": "success",
    "data": {
        'blog': {
            "title": "Ring light in the dark",
            "description": "Production of paper from wood e.g softwood or hardwood",
            "tags": ["paper","pulp","chemical compound"],
            "author": "63652ebfb1dca37cdb7f5f0a",
            "state": "draft",
            "read_count": 0,
            "body": "Lorem Ipsum comes from a latin text written in 45BC by Roman statesman, lawyer, scholar...",
            "timestamp": "2022-11-04T15:39:14.470Z",
            "_id": "6365328c8ffc71a75f0fa9d3",
            "reading_time": "3 mins",
        }
    }
}

Get My Blogs

Route: /api/v1/blogs/myBlogs
Method: GET
Body:
Header:
- Authorization: Bearer {token}
Query params:
- page (default: 1)
- per_page (default: 20)
- state (options: draft | published)
Responses

Success

{
    "status": 'success',
    "results": 4,
    "totalPages": 1,
    "currentPage": 1,
    "data": {
        "blogs": {
            {Object 1},
            {Object 2},
            {Object 3},
            {Object 4},
        },
    }
}

Update My Blog

Route: /api/v1/blogs/myBlogs/:id
Method: PATCH
Body:

{
    "state" : "published",
    "title" : "Piano: Instrument of geniuses",
}

Header:
- Authorization: Bearer {token}
Query params:
- id
- state (options: draft | published)
Responses

Success

{
    "status": "success",
    "data": {
      "blog": {
        "_id": "63652b80e3fcbf87f4d90219",
        "title": "Piano: Instrument of geniuses",
        "description": "A big part of wood making is the art of using a nails is getting set up with the basics that involve the partitioning...",
        "tags": ["music", "piano", "instrument", "sound"],
        "author": {
            "_id": "63652a9fe3fcbf87f4d90208",
            "username": "john_doe"
        },
        "state": "published",
        "read_count": 0,
        "body": "Denote simple fat denied add worthy little use. As some he so high down am week. Conduct esteems by cottage...",
        "timestamp": "2022-11-04T15:06:12.028Z",
        "reading_time": "1 mins",
      }
    },
}

Delete My Blog

Route: /api/v1/blogs/myBlogs/:id
Method: DELETE
Body:
Header:
- Authorization: Bearer {token}
Query params:
- id
- state (options: draft | published)
Responses

Success

{
    "status": "success",
    "message": `${blog.title}, Deleted!`,
    "data": null,
}

Get All Users

Route: /api/v1/users/
Method: GET
Body:
Header:
- Authorization: Bearer {(admin) token}
Query params:
- page (default: 1)
- per_page (default: 20)
Responses

Success

{
    "status": "success",
    "results": 4,
    "totalPages": 1,
    "currentPage": 1,
    "data": {
      "blogs": [
            {Object 1},
            {Object 2},
            {Object 3},
            {Object 4},
      ]
    },
}

Update A User

Route: /api/v1/users/:id
Method: POST
Body:
Header:
- Authorization: Bearer {(admin) token}
Query params:
- id
Responses

Success

{
    "status": "success",
    "data": {
      "blogs": [
            {updated user Object},
      ]
    },
}

## API TESTING

This includes functions used to test the API routes/endpoints,

- The _auth_ object is used to control the whole test functions in the apiRoutes.test.js file, READ THE COMMENTS INCLUDED IN THIS FILE FOR DETAILS ABOUT THE TEST FUNCTIONS IN THIS FILE, AND HOW THEY SHOULD RUN.

```JavaScript

const auth = {};

After understanding how the auth object influences the test script, fill and update the necessary fields before running the script. You can do this(run the test script) by;

change into the test\integration folder using cd <filename\child_file> and run this code in the terminal.

    npm run test apiRoutes.test.js

Contributor

Zeuhz Droid(David A.)

Zeuhz-Droid/vagaBlog

vagaBlog

Requirements

Setup

Base URL

User

Blog

Signup User

Login User

Get All Blogs

Get A Blog

Delete A Blog

Create A Blog

Get My Blogs

Update My Blog

Delete My Blog

Get All Users

Update A User

Contributor