Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T06:42:20Z

Rnarula2: /* Test Plan */

== Project Overview ==
===Expertiza Background===

Expertiza is an online platform designed to facilitate peer review and submission of various types of academic work, including articles, codes, and websites. The application allows instructors to add assignments, grade them, and assign students to teams based on their topic preferences. The platform also enables students to provide feedback on each other's work through peer reviews, which can be helpful in improving the quality of their projects. Expertiza is backed by the National Science Foundation.

===Problem Statement===
The Team model and TeamsController are responsible for managing teams for users and create a team-based assignment system. In this, the system allows the admin to perform CRUD operations on teams model. An admin can create a new team, edit the name of the team, add a student to them team, remove a student from the team, and delete the team. This functinality has to be thoroughly tested and implemented to make sure the code is error-free. The TeamsController includes methods for creating, reading, updating the team name, and deleting the team naem. The create teams page should display all the exisiting teams, with members and their unity ID.

==Objectives==
1. Write RESTful endpoints of create, show, update, and delete teams.

2. Develop and implement methods in the TeamsController that enable the following functionality: Create teams, show teams, show team members, update team details, delete team, and list all the teams.

3. Implement end-points API checks.

4. Return proper status codes and proper validation for RESTful endpoints.

5. Write models and controllers such that they use modern approaches to writing Ruby code, including utilizing language features and adhering to best practices for object-oriented design.

6. Adding relevant data to populate the tables

7. Write proper Rspec tests for all APIs, models, controllers.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

4. React.js in TypeScript for FrontEnd

== UI ScreenShots ==

'''Overall UI'''

[[ File:TeamsFE.jpeg|800px]]
[[ File:TeamsFE 2.jpeg|800px]]

'''Adding Teams'''

[[ File:CreateTeams.jpeg|800px ]]

'''Adding Users'''

[[File:Add1.jpeg|800px]]
[[File:Add2.jpeg|800px]]

'''Editing Teams'''

[[ File:EditTeamName.jpeg|800px]]
[[File:Editing2.jpeg|800px]]

'''Deleting Users'''

[[File:Deletion1.jpeg|800px]]
[[File:Deletion2.jpeg|800px]]

'''Deleting Team'''

[[File:Deletion1 team.jpeg|800px]]
[[File:Deletion2 team.jpeg|800px]]

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

=== Class Diagram ===

[[File: ERDiagram2363Project4.png|500px|]]

=== UML Diagram ===

[[ File:UML teambackend.png |500px]]

== Development Strategy ==
We have tried to follow a Test Driven Development approach to implement both the Invitation model and the Invitation Controller.
Firstly a failing test case was written and then the code was added such that the test which was failing will pass now.

Also, we have tried to follow the rails philosophy of "Fat models" We have tried to move as much business logic from the controller to the model as possible. This will also help keep the controller code clean and encourage code reusability.

== Functionality ==
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''
This will delete the particular team.

class Api::V1::TeamsController < ApplicationController
before_action :set_team, only: %i[show update destroy add_ta view_tas remove_ta copy ]
rescue_from ActionController::ParameterMissing, with: :parameter_missing

# GET /teams
# List all the teams
def index
teams = Team.order(:id)
render json: teams, status: :ok
end

# GET /teams/1
# Get a team
def show
render json: @team, status: :ok
end

# POST /teams
# Create a team
def create
team = Team.new(team_params)
if team.save
render json: team, status: :created
else
render json: team.errors, status: :unprocessable_entity
end
end

# PATCH/PUT /teams/1
# Update a team
def update
if @team.update(team_params)
render json: @team, status: :ok
else
render json: @team.errors, status: :unprocessable_entity
end
end

# DELETE /teams/1
# Delete a team
def destroy
@team.destroy
render json: { message: "Team with id #{params[:id]}, deleted" }, status: :no_content
end

def set_team
@team = Team.find(params[:id])
puts(@team.name)
end

def team_params
params.require(:team).permit(:name)
end

def parameter_missing
render json: { error: 'Parameter missing' }, status: :unprocessable_entity
end

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

== Swagger UI ==

[[File:Swagger.jpeg||1000px]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test on empty teams list || This test verifies if no teams exist and returns an empty list
|-
| 3 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 4 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 5 || Test to delete a Team || This test verifies if the system can team deletion
|-
| 6 || Test to return message indicating team deletion || This test returns a message when a team is deleted
|-
|}

require 'rails_helper'
RSpec.describe 'Teams API', type: :request do
describe 'GET /teams' do
context 'when teams exist' do
let!(:teams) { create_list(:team, 3) }
it 'returns a list of all teams' do
get '/teams', as: :json
expect(response).to have_http_status(:ok)
expect(response.content_type).to eq('application/json')
parsed_response = JSON.parse(response.body)
expect(parsed_response.length).to eq(teams.length)
team_names = teams.map(&:name)
returned_team_names = parsed_response.map { |team| team['name'] }
expect(returned_team_names).to match_array(team_names)
end
end

context 'when no teams exist' do
it 'returns an empty list' do
get '/teams', as: :json
expect(response).to have_http_status(:ok)
expect(response.content_type).to eq('application/json')
parsed_response = JSON.parse(response.body)
expect(parsed_response).to be_empty
end
end
end

describe 'POST /api/v1/teams' do
context 'with valid parameters' do
it 'creates a new team' do
team_params = {name: 'New Team'}
post '/api/v1/teams', params: { team: team_params }, as: :json
expect(response).to have_http_status(:created)
expect(response.content_type).to eq('application/json')
team = Team.last
expect(JSON.parse(response.body)['id']).to eq(team.id)
end
end
end

describe 'PATCH/PUT /api/v1/teams/:id' do
let(:team) { create(:team, name: 'Old Team Name') }
context 'with valid parameters' do
let(:new_team_name) { 'Updated Team Name' }
it 'updates the team name' do
put "/api/v1/teams/#{team.id}", params: { team: { name: new_team_name } }, as: :json
team.reload
expect(response).to have_http_status(:ok)
expect(response.content_type).to eq('application/json')
expect(JSON.parse(response.body)['id']).to eq(team.id)
expect(team.name).to eq(new_team_name)
end
end
end

describe 'DELETE /api/v1/teams/:id' do
let!(:team) { create(:team) }
it 'deletes a team' do
expect {
delete "/api/v1/teams/#{team.id}"
}.to change(Team, :count).by(-1)
expect(response).to have_http_status(:no_content)
expect(response.body).to be_empty
end
it 'returns a message indicating team deletion' do
delete "/api/v1/teams/#{team.id}"
expect(response).to have_http_status(:no_content)
expect(response.body).to be_empty
# Optionally, you can check the response message
expect(response.body).to eq({ message: "" }.to_json)
end
end
end

[[File:TestsAll.jpeg||1000px]]

== Future Work ==
Currently, Some of the methods were not implemented due to dependency on other models which are not implemented yet. So, the major future work would be to include the complete integration of teams and users with the UI.

Other work would be to modify the UI for the teams page.

== References ==

Video Link [https://youtu.be/hhGueZYezSw]

Github BE Link [https://github.com/expertiza/reimplementation-back-end]

Github FE Link [https://github.com/expertiza/reimplementation-front-end]

Github PR BE Link [https://github.com/expertiza/reimplementation-back-end/pull/61]

Github PR FE Link [https://github.com/expertiza/reimplementation-front-end/pull/19]

Rspec [https://rspec.info/documentation/]

Swagger UI [http://localhost:3002/api-docs]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T06:39:28Z

Rnarula2: /* Functionality */

== Project Overview ==
===Expertiza Background===

Expertiza is an online platform designed to facilitate peer review and submission of various types of academic work, including articles, codes, and websites. The application allows instructors to add assignments, grade them, and assign students to teams based on their topic preferences. The platform also enables students to provide feedback on each other's work through peer reviews, which can be helpful in improving the quality of their projects. Expertiza is backed by the National Science Foundation.

===Problem Statement===
The Team model and TeamsController are responsible for managing teams for users and create a team-based assignment system. In this, the system allows the admin to perform CRUD operations on teams model. An admin can create a new team, edit the name of the team, add a student to them team, remove a student from the team, and delete the team. This functinality has to be thoroughly tested and implemented to make sure the code is error-free. The TeamsController includes methods for creating, reading, updating the team name, and deleting the team naem. The create teams page should display all the exisiting teams, with members and their unity ID.

==Objectives==
1. Write RESTful endpoints of create, show, update, and delete teams.

2. Develop and implement methods in the TeamsController that enable the following functionality: Create teams, show teams, show team members, update team details, delete team, and list all the teams.

3. Implement end-points API checks.

4. Return proper status codes and proper validation for RESTful endpoints.

5. Write models and controllers such that they use modern approaches to writing Ruby code, including utilizing language features and adhering to best practices for object-oriented design.

6. Adding relevant data to populate the tables

7. Write proper Rspec tests for all APIs, models, controllers.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

4. React.js in TypeScript for FrontEnd

== UI ScreenShots ==

'''Overall UI'''

[[ File:TeamsFE.jpeg|800px]]
[[ File:TeamsFE 2.jpeg|800px]]

'''Adding Teams'''

[[ File:CreateTeams.jpeg|800px ]]

'''Adding Users'''

[[File:Add1.jpeg|800px]]
[[File:Add2.jpeg|800px]]

'''Editing Teams'''

[[ File:EditTeamName.jpeg|800px]]
[[File:Editing2.jpeg|800px]]

'''Deleting Users'''

[[File:Deletion1.jpeg|800px]]
[[File:Deletion2.jpeg|800px]]

'''Deleting Team'''

[[File:Deletion1 team.jpeg|800px]]
[[File:Deletion2 team.jpeg|800px]]

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

=== Class Diagram ===

[[File: ERDiagram2363Project4.png|500px|]]

=== UML Diagram ===

[[ File:UML teambackend.png |500px]]

== Development Strategy ==
We have tried to follow a Test Driven Development approach to implement both the Invitation model and the Invitation Controller.
Firstly a failing test case was written and then the code was added such that the test which was failing will pass now.

Also, we have tried to follow the rails philosophy of "Fat models" We have tried to move as much business logic from the controller to the model as possible. This will also help keep the controller code clean and encourage code reusability.

== Functionality ==
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''
This will delete the particular team.

class Api::V1::TeamsController < ApplicationController
before_action :set_team, only: %i[show update destroy add_ta view_tas remove_ta copy ]
rescue_from ActionController::ParameterMissing, with: :parameter_missing

# GET /teams
# List all the teams
def index
teams = Team.order(:id)
render json: teams, status: :ok
end

# GET /teams/1
# Get a team
def show
render json: @team, status: :ok
end

# POST /teams
# Create a team
def create
team = Team.new(team_params)
if team.save
render json: team, status: :created
else
render json: team.errors, status: :unprocessable_entity
end
end

# PATCH/PUT /teams/1
# Update a team
def update
if @team.update(team_params)
render json: @team, status: :ok
else
render json: @team.errors, status: :unprocessable_entity
end
end

# DELETE /teams/1
# Delete a team
def destroy
@team.destroy
render json: { message: "Team with id #{params[:id]}, deleted" }, status: :no_content
end

def set_team
@team = Team.find(params[:id])
puts(@team.name)
end

def team_params
params.require(:team).permit(:name)
end

def parameter_missing
render json: { error: 'Parameter missing' }, status: :unprocessable_entity
end

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

== Swagger UI ==

[[File:Swagger.jpeg||1000px]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test on empty teams list || This test verifies if no teams exist and returns an empty list
|-
| 3 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 4 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 5 || Test to delete a Team || This test verifies if the system can team deletion
|-
| 6 || Test to return message indicating team deletion || This test returns a message when a team is deleted
|-
|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

[[File:TestsAll.jpeg||1000px]]

== Future Work ==
Currently, Some of the methods were not implemented due to dependency on other models which are not implemented yet. So, the major future work would be to include the complete integration of teams and users with the UI.

Other work would be to modify the UI for the teams page.

== References ==

Video Link [https://youtu.be/hhGueZYezSw]

Github BE Link [https://github.com/expertiza/reimplementation-back-end]

Github FE Link [https://github.com/expertiza/reimplementation-front-end]

Github PR BE Link [https://github.com/expertiza/reimplementation-back-end/pull/61]

Github PR FE Link [https://github.com/expertiza/reimplementation-front-end/pull/19]

Rspec [https://rspec.info/documentation/]

Swagger UI [http://localhost:3002/api-docs]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T06:38:21Z

Rnarula2: /* Functionality */

== Project Overview ==
===Expertiza Background===

Expertiza is an online platform designed to facilitate peer review and submission of various types of academic work, including articles, codes, and websites. The application allows instructors to add assignments, grade them, and assign students to teams based on their topic preferences. The platform also enables students to provide feedback on each other's work through peer reviews, which can be helpful in improving the quality of their projects. Expertiza is backed by the National Science Foundation.

===Problem Statement===
The Team model and TeamsController are responsible for managing teams for users and create a team-based assignment system. In this, the system allows the admin to perform CRUD operations on teams model. An admin can create a new team, edit the name of the team, add a student to them team, remove a student from the team, and delete the team. This functinality has to be thoroughly tested and implemented to make sure the code is error-free. The TeamsController includes methods for creating, reading, updating the team name, and deleting the team naem. The create teams page should display all the exisiting teams, with members and their unity ID.

==Objectives==
1. Write RESTful endpoints of create, show, update, and delete teams.

2. Develop and implement methods in the TeamsController that enable the following functionality: Create teams, show teams, show team members, update team details, delete team, and list all the teams.

3. Implement end-points API checks.

4. Return proper status codes and proper validation for RESTful endpoints.

5. Write models and controllers such that they use modern approaches to writing Ruby code, including utilizing language features and adhering to best practices for object-oriented design.

6. Adding relevant data to populate the tables

7. Write proper Rspec tests for all APIs, models, controllers.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

4. React.js in TypeScript for FrontEnd

== UI ScreenShots ==

'''Overall UI'''

[[ File:TeamsFE.jpeg|800px]]
[[ File:TeamsFE 2.jpeg|800px]]

'''Adding Teams'''

[[ File:CreateTeams.jpeg|800px ]]

'''Adding Users'''

[[File:Add1.jpeg|800px]]
[[File:Add2.jpeg|800px]]

'''Editing Teams'''

[[ File:EditTeamName.jpeg|800px]]
[[File:Editing2.jpeg|800px]]

'''Deleting Users'''

[[File:Deletion1.jpeg|800px]]
[[File:Deletion2.jpeg|800px]]

'''Deleting Team'''

[[File:Deletion1 team.jpeg|800px]]
[[File:Deletion2 team.jpeg|800px]]

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

=== Class Diagram ===

[[File: ERDiagram2363Project4.png|500px|]]

=== UML Diagram ===

[[ File:UML teambackend.png |500px]]

== Development Strategy ==
We have tried to follow a Test Driven Development approach to implement both the Invitation model and the Invitation Controller.
Firstly a failing test case was written and then the code was added such that the test which was failing will pass now.

Also, we have tried to follow the rails philosophy of "Fat models" We have tried to move as much business logic from the controller to the model as possible. This will also help keep the controller code clean and encourage code reusability.

== Functionality ==
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''
This will delete the particular team.

```
class Api::V1::TeamsController < ApplicationController
before_action :set_team, only: %i[show update destroy add_ta view_tas remove_ta copy ]
rescue_from ActionController::ParameterMissing, with: :parameter_missing

# GET /teams
# List all the teams
def index
teams = Team.order(:id)
render json: teams, status: :ok
end

# GET /teams/1
# Get a team
def show
render json: @team, status: :ok
end

# POST /teams
# Create a team
def create
team = Team.new(team_params)
if team.save
render json: team, status: :created
else
render json: team.errors, status: :unprocessable_entity
end
end

# PATCH/PUT /teams/1
# Update a team
def update
if @team.update(team_params)
render json: @team, status: :ok
else
render json: @team.errors, status: :unprocessable_entity
end
end

# DELETE /teams/1
# Delete a team
def destroy
@team.destroy
render json: { message: "Team with id #{params[:id]}, deleted" }, status: :no_content
end

def set_team
@team = Team.find(params[:id])
puts(@team.name)
end

def team_params
params.require(:team).permit(:name)
end

def parameter_missing
render json: { error: 'Parameter missing' }, status: :unprocessable_entity
end
end
```

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

== Swagger UI ==

[[File:Swagger.jpeg||1000px]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test on empty teams list || This test verifies if no teams exist and returns an empty list
|-
| 3 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 4 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 5 || Test to delete a Team || This test verifies if the system can team deletion
|-
| 6 || Test to return message indicating team deletion || This test returns a message when a team is deleted
|-
|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

[[File:TestsAll.jpeg||1000px]]

== Future Work ==
Currently, Some of the methods were not implemented due to dependency on other models which are not implemented yet. So, the major future work would be to include the complete integration of teams and users with the UI.

Other work would be to modify the UI for the teams page.

== References ==

Video Link [https://youtu.be/hhGueZYezSw]

Github BE Link [https://github.com/expertiza/reimplementation-back-end]

Github FE Link [https://github.com/expertiza/reimplementation-front-end]

Github PR BE Link [https://github.com/expertiza/reimplementation-back-end/pull/61]

Github PR FE Link [https://github.com/expertiza/reimplementation-front-end/pull/19]

Rspec [https://rspec.info/documentation/]

Swagger UI [http://localhost:3002/api-docs]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T06:35:37Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T06:32:36Z

Rnarula2: /* End point summary */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:53:56Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:53:43Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:49:11Z

Rnarula2: /* Swagger UI */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:48:47Z

Rnarula2: /* References */

File:Swagger.jpeg

2023-12-05T04:48:31Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:46:01Z

Rnarula2: /* End point summary */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:27:42Z

Rnarula2: /* UI ScreenShots */

File:Deletion2 team.jpeg

2023-12-05T04:26:15Z

Rnarula2:

File:Deletion1 team.jpeg

2023-12-05T04:25:54Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:24:57Z

Rnarula2: /* UI ScreenShots */

File:Add2.jpeg

2023-12-05T04:23:02Z

Rnarula2:

File:Add1.jpeg

2023-12-05T04:22:50Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:19:39Z

Rnarula2: /* Changes Made */

File:Editing2.jpeg

2023-12-05T04:18:37Z

Rnarula2:

File:Deletion2.jpeg

2023-12-05T04:15:51Z

Rnarula2:

File:Deletion1.jpeg

2023-12-05T04:13:12Z

Rnarula2:

File:EditTeamName.jpeg

2023-12-05T04:11:31Z

Rnarula2:

File:TeamsFE 2.jpeg

2023-12-05T04:10:12Z

Rnarula2:

File:CreateTeams.jpeg

2023-12-05T04:07:19Z

Rnarula2:

File:TeamsFE.jpeg

2023-12-05T04:04:25Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T04:03:37Z

Rnarula2: /* Technologies Used for the Design */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:30:42Z

Rnarula2: /* Future Work */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:30:00Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:26:26Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:26:02Z

Rnarula2: /* References */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:25:39Z

Rnarula2: /* Test Plan */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T03:23:29Z

Rnarula2: /* Design and Implementation */

File:UML teambackend.png

2023-12-05T03:22:08Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T02:59:59Z

Rnarula2: /* End point summary */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T02:59:30Z

Rnarula2: /* Functionality */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T02:59:13Z

Rnarula2: /* Functinality */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T02:58:59Z

Rnarula2: /* Design and Implementation */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T02:57:31Z

Rnarula2: /* Design and Implementation */

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-05T00:07:11Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg||1000px ]]

[[ File:UpdateTeam.jpeg||1000px]]

[[ File:AllTeams.jpeg||1000px]]

[[ File:AfterCreateTeam.jpeg||1000px ]]

[[File:Image.png||1000px]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

[[File:TestsAll.jpeg]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

File:TestsAll.jpeg

2023-12-05T00:06:55Z

Rnarula2:

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:50:53Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg||1000px ]]

[[ File:UpdateTeam.jpeg||1000px]]

[[ File:AllTeams.jpeg||1000px]]

[[ File:AfterCreateTeam.jpeg||1000px ]]

[[File:Image.png||1000px]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:50:26Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg||1000px ]]

[[ File:UpdateTeam.jpeg||1000px]]

[[ File:AllTeams.jpeg||1000px]]

[[ File:AfterCreateTeam.jpeg||1000px ]]

[[File:Image.png]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

File:Image.png

2023-12-04T23:50:12Z

Rnarula2: Rnarula2 uploaded a new version of File:Image.png

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:48:22Z

Rnarula2: /* End point summary */

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg||1000px ]]

[[ File:UpdateTeam.jpeg||1000px]]

[[ File:AllTeams.jpeg||1000px]]

[[ File:AfterCreateTeam.jpeg||1000px ]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:47:43Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg||500px ]]

[[ File:UpdateTeam.jpeg||500px]]

[[ File:AllTeams.jpeg||500px]]

[[ File:AfterCreateTeam.jpeg||500px ]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:28:23Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File:DeleteTeam.jpeg ]]

[[ File:UpdateTeam.jpeg ]]

[[ File:AllTeams.jpeg ]]

[[ File:AfterCreateTeam.jpeg ]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:27:14Z

Rnarula2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ File DeleteTeam.jpeg ]]

[[ File UpdateTeam.jpeg ]]

[[ File AllTeams.jpeg ]]

[[ File AfterCreateTeam.jpeg ]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

CSC/ECE 517 Fall 2023 - E2387. Reimplement Teams backend (Phase 2)

2023-12-04T23:26:40Z

Rnarula2: /* End point summary */

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project are the frontend React Components of User, Institution and Roles. A fully functional UI for these components will be developed using React for this project.

== Technologies Used for the Design ==

1. Ruby on Rails

2. Rspec (for Testing)

3. Swagger UI

== Changes Made ==
The Teams schema was not properly implemented and we have added more attributes.

[[File:TeamsController_new(present).png]]

Before Schema

Following attributes would be added to the teams table -
1. Name of the Team (Unique)
2. Team ID (Unique)

[[File:Screenshot from 2023-12-04 16-05-49.png]]

Final Schema.
We also added foreign keys in the Users table as one Team can have many Users

[[File:UsersUpdated.png]]

This will delete the team.

== Validations ==
'''Only Admins should be able to access this page.'''

1. Team ID's should be unique.

2. If a team member is already added to another team, it should give appropriate error.

== Design and Implementation ==

[[File: ERDiagram2363Project4.png|500px|]]

''' FUNCTIONALITY '''
We also added new controller (teams_controller.rb) in which we added the following methods.

''' 1. create '''

This will create a new team.

''' 2. index '''

This will list all the teams.

''' 3. update '''

This will update the team's name.

''' 4. destroy '''

== End point summary ==
{| class="wikitable" style="margin-left:40px"
|-
! Sr No !! Method !! Endpoint !! Request Body !! Description
|-
| 1 || create || POST /teams||{ "name": String>} ||Create a new team with given team name.
|-
| 2 || index || GET /teams || ||Get a list of all the teams.
|-
| 3 || show || GET /teams/<team_id> || || Get a particular team with the team_id.
|-
| 4 || update || PATCH /teams/<team_id> || { "name": String>} || Modify the name of the team.
|-
| 5 || destroy || DELETE /teams/<team_id> || || Delete the team.
|-
|}

[[ DeleteTeam.jpeg ]]

[[ UpdateTeam.jpeg ]]

[[ AllTeams.jpeg ]]

[[ AfterCreateTeam.jpeg ]]

== Test Plan ==

We utilized RSpec as the testing framework for our system and the development process followed Test Driven Development. The controller tests were written in a comprehensive way.

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/teams_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test !! Description
|-
| 1 || Test to list all Teams || This test verifies if the system can successfully retrieve a list of all teams available in the system.
|-
| 2 || Test to create a new Team || This test verifies if the system can successfully create a new team with valid parameters such as team name
|-
| 3 || Test to update Team Name || This test verifies if the system can handle updating team name with valid parameters such as team name.
|-
| 4 || Test to delete a Team || This test verifies if the system can team deletion
|-

|}

[[ File:Tests1 team controller.png ]]

[[File:Tests2 team controller.png]]

Github PR Link

[https://github.com/expertiza/reimplementation-back-end/pull/61]

==Team==
=====Mentor=====
* Kartiki Bhandakkar <kbhanda3@ncsu.edu>

=====Members=====
* Raghav Narula <rnarula2@ncsu.edu>
* Mihir Nikam <mvnikam@ncsu.edu>
* Ebani Gogia <egogia@ncsu.edu>

File:AfterCreateTeam.jpeg

2023-12-04T23:26:31Z

Rnarula2:

File:AllTeams.jpeg

2023-12-04T23:26:12Z

Rnarula2: