soel30/mifx-test

Introduction

You are working on an online bookstore application. You have to finish a few web API methods.

The project contains functional tests. Your task is to make all the tests pass by writing the missing code.

Setup

composer install
cp .env.example .env
php artisan db:init
php artisan migrate --seed

Tests

php artisan test

Requirements

An implementation of migration file for the tables is already given. However, it is missing a part that creates many-to-many relationship between book and author.

Also, the API has to provide endpoints for four operations:

GET /api/books - a list of Books with pagination, sorting and filtering options.

Available query parameters:

• page - page number
• sortColumn - one of title, avg_review or published_year
• sortDirection - one of ASC or DESC
• title - search by book title
• authors - search by author’s ID (comma-separated)

Sample response (HTTP 200)

{
   "data":[
      {
         "id":1,
         "isbn":"9077765476",
         "title":"Et hic et mollitia ea nihil culpa.",
         "description":"Possimus voluptatem rerum harum nemo asperiores. Consequuntur tenetur ut nemo ipsam placeat. Sunt eos cum assumenda quasi est. Dolores earum qui quod nihil commodi nisi.",
         "published_year": 2020,
         "authors":[
            {
               "id":1,
               "name":"Dr. Beth Weber PhD",
               "surname":"Jenkins"
            }
         ],
         "review":{
            "avg":4,
            "count":3
         }
      }
   ],
   "links":{
      "first":"http:\/\/localhost\/api\/books?page=1",
      "last":"http:\/\/localhost\/api\/books?page=1",
      "prev":null,
      "next":null
   },
   "meta":{
      "current_page":1,
      "from":1,
      "last_page":1,
      "path":"http:\/\/localhost\/api\/books",
      "per_page":15,
      "to":5,
      "total":5
   }
}

TODO:

• Implement App\Http\Resources\BookResource::toArray method.
• Query the data from Book Eloquent model and respond with BookResource collection.
• Implement pagination feature (from Eloquent).
• Allow sorting by title.
• Allow sorting by average review.
• Allow searching by title (SQL like query).
• Allow searching by author’s ID.

---

POST /api/books - creates a new Book resource.

Access to this endpoint requires authentication with an API token and admin privileges.

Required parameters:

• isbn - string (13 characters, digits only)
• title - string
• description - string
• authors - int[] - author’s ID
• published_year - int (between 1900 and 2020)

Sample response (HTTP 201)

{
   "data":{
      "id":1,
      "isbn":"9788328302341",
      "title":"Clean code",
      "description":"Lorem ipsum",
      "published_year": 2020,
      "authors":[
         {
            "id":1,
            "name":"Prof. Darrin Mraz Jr.",
            "surname":"Bins"
         }
      ],
      "review":{
         "avg":0,
         "count":0
      }
   }
}

In case of validation errors, the API should respond with the default error list from the Laravel framework and the 422 HTTP code.

TODO:

• Validate the required fields.
• Ensure that the ISBN is unique and author’s ID exist in the DB.
• Store Book in the DB.
• Restrict access only for administrators with auth.admin middleware.
• Respond with BookResource.

---

POST /api/books/{id}/reviews - creates a new BookReview resource.

Access to this endpoint requires authentication with an API token.

Required parameters:

• review - int (1-10)
• comment - string

Sample response (HTTP 201)

{
   "data":{
      "id":1,
      "review":5,
      "comment":"Lorem ipsum",
      "user":{
         "id":1,
         "name":"Kody Lebsack"
      }
   }
}

In case of an invalid Book ID, the API should respond with the 404 HTTP code. In case of validation errors, the API should respond with the default error list from the Laravel framework and the 422 HTTP code.

TODO:

• Validate the required fields.
• Store BookReview in the DB.
• Restrict access only for authenticated users.
• Respond with BookReviewResource.

---

DELETE /api/books/{id}/reviews/{id} - deletes a BookReview resource.

Access to this endpoint requires authentication with an API token and admin privileges.

Sample response (HTTP 204)

{}

In case of an invalid Book ID, the API should respond with the 404 HTTP code.

TODO:

• Validate if the book exists.
• Delete the book from DB.
• Return an empty body and 204 status code.

---

Hints

• The project is configured to use an SQLite database.
• Do not modify any tests.
• Look for comments with @todo.
• To make sure your answer is correct, please do a unit test or run php artisan test
• Create answer branch based on main branch.
• Push to branch answer.