## Pull Request: Add Initial Backend Features (API v1) for Vecs School #26

christianonoh · 2023-08-30T09:29:15Z

Description:

This pull request introduces the first version (v1) of the Vecs School backend API, encompassing fundamental features for managing courses, reservations, user registration, authentication, and user-specific operations.

Link to frontend application - VECS School Frontend

Features Added:

Endpoints for Courses (API v1):
- CRUD operations for courses.
- API routes for course listing and retrieval by ID.
Endpoints for Reservations (API v1):
- CRUD operations for reservations associated with courses.
- API routes for reservation creation, listing, update, and deletion.
User Authentication and Authorization:
- Implemented user authentication utilizing Devise and Devise JWT for secure registration, login, and logout processes.
- Integrated JSON Web Tokens (JWT) for token-based authentication and security.
Endpoint for Current Logged-In User:
- Added an API endpoint to fetch details about the currently logged-in user.
- Permits authenticated users to access their personalized user information.
Testing and Documentation:
- Wrote comprehensive RSpec tests for models and controllers.
- Created API documentation using Swagger for clear and interactive endpoint documentation.

Changes Made:

Developed controllers, models, and migrations for courses and reservations.
Implemented user registration, login, and logout using Devise.
Integrated Devise JWT for token-based authentication.
Created versioned API endpoints for CRUD operations on courses and reservations.
Added API routes for user authentication and user-specific operations.
Enforced proper error handling and consistent response messages.
Accompanied with comprehensive unit tests and API documentation.

API Routes (API v1):

POST /signup - Register a new user.
POST /login - Authenticate and receive an access token.
DELETE /logout - Log out the current user.
GET /api/v1/courses - Retrieve a list of all courses.
GET /api/v1/courses/:id - Retrieve details of a specific course.
POST /api/v1/courses - Create a new course.
PUT /api/v1/courses/:id - Update details of a course.
DELETE /api/v1/courses/:id - Delete a course.
GET /api/v1/reservations - Retrieve a list of all reservations.
GET /api/v1/reservations/:id - Retrieve details of a specific reservation.
POST /api/v1/reservations - Create a new reservation.
GET /api/v1/current_user - Retrieve details of the current logged-in user.

Reviewer:

Kindly review this pull request to ensure adherence to coding standards, security practices, and overall code quality.

Thank you for your time and consideration.

Best regards,
@christianonoh, @smunoz1988, @Ellyboi and @vvoo21

Setup Rails app

Reservations

API Documentation Using Rswag

Meltrust

Hi @christianonoh,

Good job so far!
There are some issues that you still need to work on to prepare your project for the final evaluation, but you are almost there!

To highlight:

Nice code organization ✔️
App is working well✔️
Good readme ✔️

You are really close to finishing the Microverse program!! Keep it up! 👍👍👍

After implementing the requested changes, please submit another review request. ♻️

Check the comments under the review.

Cheers and Happy coding!👏👏👏

Please, do not open a new Pull Request for re-reviews. You should use the same Pull Request submitted for the previous reviews unless it is requested otherwise.

Meltrust · 2023-08-30T09:50:54Z

README.md

+```sh
+rails db:create
+rails db:migrate
+```


You have a very functional seeds.rb. Kindly add to your db commands rails db:seed.

That way, your users will enjoy a pre-seeded database. 👍

Meltrust · 2023-08-30T09:54:31Z

README.md

+- **Run Tests:** Use the following command to run the tests.
+```sh
+  rspec
+```


When I run your tests according to your instructions, this happens:

This is because all your request tests are swagger tests. Rspec won't run them properly.

Therefore, kindly be more specific in your instructions so your users never get a failing test:

rspec ./spec/models rspec ./spec/controllers

Result:

That way, your users will never get a failing test 👍

Meltrust · 2023-08-30T09:55:03Z

README.md

+
+- **Run Tests:** Use the following command to run the tests.
+```sh
+  rspec


You are using Rspec, but the "test" folder still exists, which is used by another test framework. Kindly consider deleting that folder if you are not using it. 👍

Ellyboi · 2023-08-30T10:03:39Z

Thank you taking your time to give this acceptable criticism......The corrections will immediately be implemented

Fix review changes

Meltrust

Hi @christianonoh,

Wow, you did it 🎉

Thank you for the changes implemented 💪 🥇 ㊗️

Unless you want to add more features, go ahead to your final presentation ⏩ ⏩ ⏩

You are about to finish the Microverse program. You have come a long way!!!

Good luck in the software industry!! I'll see you there. ✨

Congratulations!!!!!! 🎉

To highlight

Superfluous test folder has been removed✔️
db seeding instructions have been included✔️
Tests instructions have been improved ✔️
Great job✔️

Cheers and Happy coding!👏👏👏

christianonoh and others added 30 commits August 17, 2023 10:36

Create new rails app

777292b

Add linters

278bb1d

Create user model

1f1ad4c

Add course model

8ea4efb

Update schema and seeds files

a0532b6

Update course model to add validations

9d7fb1a

Create course controller with CRUD functions

a501532

Update routes file

0fd29ab

Add user controller and update routes file

5e27bf9

Fix linter errors

30d61b0

Merge pull request #19 from christianonoh/setup

11fb9ab

Setup Rails app

update gimfile

6794183

add reservation controllers

16babb3

add reservation models

d5e9602

update db

10acf3b

update routes to accommondate reservations

15be68d

update schema with reservation model

4ead6a1

update controller test

d6976c6

Modify reservation migration file

0ec7332

Modify reservation model to add associations

ccbddad

Add associations to user model

49dbcc1

Modify course model to add associations

1171491

Fix typo error

50336ce

Modify reservation controller

2c0aba9

Update Schema

6962d8c

fix the linters error

653c24a

Merge pull request #20 from christianonoh/reservations

d30bb3c

Reservations

Install dependencies

ea0c139

Setup devise and necessary configurations

603828d

Add devise to user model + migration file + modify route

0df0bb5

Ellyboi and others added 20 commits August 28, 2023 23:28

add course documentation using rswag

6662d08

add registration session using rswag for do

98a07da

add rservation documentation using rswag

47ba741

add session to doc

4ba9b8b

update db

931b415

add rswag to gemfile

123af9d

update jwt timing

248b799

update course controller

0bb229f

fix the linters error

a1ef8c9

fix linters error

23f538d

fix linters error

a96a849

linters error fixed

fd60c22

update all the files based on code reviewer suggestions

9717f51

Modify database.yml

cf31425

Fix linter errors

8ae1023

Move controller spec files to controller folder

86ff47f

Rename rswag test files to order them in documentation

497f4e5

Modify routes.rb to navigate to api-doc on root path

e325909

Update swagger.yaml file

eef5781

Merge pull request #25 from christianonoh/rswag_doc

5606560

API Documentation Using Rswag

christianonoh mentioned this pull request Aug 30, 2023

vecs-school-v1 smunoz1988/vecs-school-frontend#11

Merged

Meltrust suggested changes Aug 30, 2023

View reviewed changes

christianonoh and others added 5 commits August 30, 2023 12:14

Modify Readme.md file to include seeds and correct testing commands

a637455

Delete redundant test folder

638da95

Fix typo

ea03b95

Update seeds.rb

10c1361

Merge pull request #27 from christianonoh/fix-review-changes

510e188

Fix review changes

Meltrust approved these changes Aug 30, 2023

View reviewed changes

Ellyboi merged commit 6de1fd9 into main Aug 31, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

## Pull Request: Add Initial Backend Features (API v1) for Vecs School #26

## Pull Request: Add Initial Backend Features (API v1) for Vecs School #26

christianonoh commented Aug 30, 2023 •

edited

Loading

Meltrust left a comment •

edited

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading

Ellyboi commented Aug 30, 2023

Meltrust left a comment

## Pull Request: Add Initial Backend Features (API v1) for Vecs School #26

## Pull Request: Add Initial Backend Features (API v1) for Vecs School #26

Conversation

christianonoh commented Aug 30, 2023 • edited Loading

Description:

Link to frontend application - VECS School Frontend

Features Added:

Changes Made:

API Routes (API v1):

Reviewer:

Meltrust left a comment • edited Loading

Choose a reason for hiding this comment

To highlight:

You are really close to finishing the Microverse program!! Keep it up! 👍👍👍

After implementing the requested changes, please submit another review request. ♻️

Meltrust Aug 30, 2023 • edited by christianonoh Loading

Choose a reason for hiding this comment

Meltrust Aug 30, 2023 • edited by christianonoh Loading

Choose a reason for hiding this comment

Meltrust Aug 30, 2023 • edited by christianonoh Loading

Choose a reason for hiding this comment

Ellyboi commented Aug 30, 2023

Meltrust left a comment

Choose a reason for hiding this comment

Hi @christianonoh,

Wow, you did it 🎉

Thank you for the changes implemented 💪 🥇 ㊗️

Unless you want to add more features, go ahead to your final presentation ⏩ ⏩ ⏩

You are about to finish the Microverse program. You have come a long way!!!

Good luck in the software industry!! I'll see you there. ✨

Congratulations!!!!!! 🎉

To highlight

christianonoh commented Aug 30, 2023 •

edited

Loading

Meltrust left a comment •

edited

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading

Meltrust Aug 30, 2023 •

edited by christianonoh

Loading