Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-12T03:58:15Z

Pmgandh2: /* Problem Statement */

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accepts your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page. You could invite students to your team by clicking invitation links. If s/he accepts your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered cases enlisted below for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We have written automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn't have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

Horn icon appearing in correct column in signup sheet table.

[[File:A_after.png|frame|upright|center]]

All students whose teams are not complete would see list of other students without teams on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-12T03:57:53Z

Pmgandh2: /* Change Request 2 */

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page. You could invite students to your team by clicking invitation links. If s/he accepts your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered cases enlisted below for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We have written automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn't have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

Horn icon appearing in correct column in signup sheet table.

[[File:A_after.png|frame|upright|center]]

All students whose teams are not complete would see list of other students without teams on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-12T03:57:12Z

Pmgandh2: /* Change Request 2 */

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page
You could invite students to your team by clicking invitation links. If s/he accepts your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered cases enlisted below for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We have written automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn't have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

Horn icon appearing in correct column in signup sheet table.

[[File:A_after.png|frame|upright|center]]

All students whose teams are not complete would see list of other students without teams on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-12T03:56:35Z

Pmgandh2:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page
○ You could invite students to your team by clicking invitation links. If s/he accepts your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered cases enlisted below for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We have written automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn't have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

Horn icon appearing in correct column in signup sheet table.

[[File:A_after.png|frame|upright|center]]

All students whose teams are not complete would see list of other students without teams on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

File:Uml.jpg

2017-11-15T01:50:06Z

Pmgandh2: uploaded a new version of "File:Uml.jpg"

File:Uml.jpg

2017-11-15T01:48:06Z

Pmgandh2:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-15T00:51:34Z

Pmgandh2:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join in a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

Sending invitation to a particular student using their unity id as per below.

[[File:Invite_unity_id_before.png|frame|upright|center]]

Creating advertisements for joining a team (this is available only after signing up a topic).

[[File:A_by_teammate_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students who do not have a team yet or whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

== Test Plan ==

=== Edge cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios

*If the team is full, the person who received an invitation link would not be able to accept that.
*If a student leaves a team, then he is able to see his previous teammates in the available list of students that do not have a complete team and have not created an invitation link.
*Student sees a horn icon in the last column if any of the students have created an advertisement for that topic.
*The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*A student can create an invitation link only if his team is not yet full.
*The same student who accepted the invitation link actually gets added to the team.
*A student won't be able to send the invitation to himself as he is already a member of that team.
*An instructor sees only the list of the students who do not have teams with invitation link.
*If a student joins a team using an invitation link, then he gets all the rights that a team member of that team has. Ex: Now, he will be able to approve a team join request and then correspondingly send the invitation for joining the group to that student.

== Visual representation of planned changes ==

Inviting students by creating an advertisement.

Once a student creates an advertisement, it would appear in the sign up sheet as below.
It would be visible to all other students visiting sign up sheet.

[[File:A_after.png|frame|upright|center]]

Once a student decides to respond to the advertisement, he clicks on the icon corresponding to the team and topic. He sees the description of the advertisement and a link to respond to it.

[[File:A_request_invitation_after.png|frame|upright|center]]

The student would be presented by a form as below once he/she chooses to request for an invitation.

[[File:A_response.png|frame|upright|center]]

Student would respond by completing the form and clicking on create. His request would be confirmed by showing a screen as below:

[[File:Join_request_after.png|frame|upright|center]]

Team receiving the request would see the incoming request on his "your team" view, from where he could send invites for joining the team.

*Note - this approach was considered to avoid random assignment of student into a team.
A student could chose more than 1 team to respond to their advertisements. In that case, the team accepting 1st would get the student into their team and it would be complex to handle the other invitations as the student who has sent the invitation would be juggling around or may not be able to choose the best fit.

*Our take - Each student may choose to respond to more than 1 advertisements but also should have choice of selecting teams as per their comfort.

When a student respond to an advertisement, the team receiving it should send an invitation if they find the student matching the criteria and the student then choose to accept one out of all the invitation he receives.

Below screenshots shows the steps:

The team who has got a response on their advertisement would see the incoming request, which they can accept or decline.

[[File:Received_request_after.png|frame|upright|center]]

Once the team accepts the invitation, an invite would be sent to the student to join the team. The team could see their sent invitation as below:

[[File:Sent_invitation_after.png|frame|upright|center]]

The student sees the invitation on his/her "your team" view as below:

[[File:Received_invitation_after.png|frame|upright|center]]

Once the student chooses to accept the invitation, he/she could click on the accept link, upon which the user would be presented with a prompt dialog to confirm the acceptance
as the student would be removed from the current team and placed into the team whose invitation he/she would accept.

[[File:Accept_invitation_after.png|frame|upright|center]]

Upon successful acceptance, he/she becomes a member of the team.

[[File:Accepted_request_after.png|frame|upright|center]]

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1758 Improve e-mail notifications

2017-11-07T00:13:40Z

Pmgandh2: /* Testing */

=='''Introduction'''==

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1][2]. It is an open source project and it's codebase is maintained in GitHub. We are contributing to Expertiza as a part of our Object-Oriented Design and Development's Open-Source Software (OSS) Project. Our goal in this project is to fix various issues related to staggered deadlines for assignments. A staggered-deadline assignment is an assignment in which different topics have different deadlines. In this Wiki Page, we will explain the changes that we have made for the same.

=='''Changes To Be Implemented'''==
*'''What’s wrong:'''

<li>When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created. So this involves adding a call to the e-mailer … or, perhaps, moving an email call from the Users controller to the point where an account is actually created.
<li> Second, evidently if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review is in progress.The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed. It would also be nice to fix the message so it tells which review (Review 1, Review 2, etc.) has been revised, and gives the reviewer a link directly to it.

*'''There are also other circumstances when it would be helpful to send mail.'''

<li>Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
<li>The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
<li>Notify an instructor by e-mail when a student suggests a topic.

=='''Modified Files'''==

*app/controllers/invitations_controller.rb
*app/controllers/submitted_content_controller.rb
*app/controllers/suggestion_controller.rb
*app/mailers/mailer.rb
*app/models/assignment.rb
*app/models/assignment_participant.rb
*app/models/course_participant.rb

=='''Added Files'''==

*app/views/mailer/partials/_user_invite_html.html.erb
*app/views/mailer/partials/_user_invite_plain.html.erb
*app/views/mailer/partials/_user_welcome_html.html.erb
*app/views/mailer/partials/_user_welcome_plain.html.erb
*app/views/mailer/send_mail_to_instructor.html.erb
*app/views/mailer/send_mail_to_instructor.text.erb

*app/views/mailer/partials/_user_accept_html.html.erb
*app/views/mailer/partials/_user_accept_plain.html.erb
*app/views/mailer/partials/_user_decline_html.html.erb
*app/views/mailer/partials/_user_decline_plain.html.erb

=='''Approach Taken To Implement Changes'''==

NOTE: All the mails except the ones for the reviewer which are sent to mailinator , are sent to expertiza.development@gmail.com ,as this is already set in the development environment.

1) Initially the email were being sent to users when they were added using a CSV file on the users page only . Now we added a method in the assignment_participant.rb model to send mails when a participant is added to an assignment on the assignment page through a CSV file.

def self.import(row, _row_header = nil, session, id)
raise ArgumentError, "No user id has been specified." if row.empty?
user = User.find_by_name(row[0])
if user.nil?
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
end
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)
new_part.set_handle
# E1758 Fall17
password = "password"#user.password
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
end
end

Also we added a method in the course_participant.rb file to send the mails when the user is added on the course page using a CSV file.

def self.import(row, _row_header = nil, session, id)
raise ArgumentError, "No user id has been specified." if row.empty?
user = User.find_by_name(row[0])
if user.nil?
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
end
course = Course.find(id)
if course.nil?
raise ImportError, "The course with the id \"" + id.to_s + "\" was not found."
end
unless CourseParticipant.exists?(user_id: user.id, parent_id: course.id)
CourseParticipant.create(user_id: user.id, parent_id: course.id)
# E1758 Fall 17
password = "password"#user.password
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
end
end

2) Initially whenever a submission was being revised ,a mail was being sent to the the reviewer to revise the review. We needed to make sure that mail should not go when it is the last phase of review.

We put a check on the condition that if it is the last round of review then mail should not be sent to the reviewer for revision of his review.
for that we created a method review_deadline in the assignment.rb file to check if the next due date round is equal to number of review rounds or not.
# E1758 Fall 17
def review_deadline(topic_id = nil, num_review_rounds)
return false if topic_id.nil? and self.staggered_deadline?
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return !(next_due_date.round == num_review_rounds && next_due_date.deadline_type_id == 2)
end

We also created a method in the assignment_participant.rb file to check if the round is valid for mail.

# E1758 Fall 17
def is_round_valid_for_mail?
topic_id = SignedUpTeam.topic_id(self.parent_id, self.user_id)
return assignment.review_deadline(topic_id, assignment.num_review_rounds)
end
end

In the submitted_content_controller.rb we created a check

# E1758 Fall 17
if participant.is_round_valid_for_mail?
reviewers = []
participant.reviewers.each do |reviewer|
reviewers << User.find(reviewer.user_id).email
end
Mailer.delayed_message(bcc: reviewers, subject: "You have a new submission to be review", body: "Please visit http://expertiza.ncsu.edu and proceed to peer reviews.").deliver_now
# participant.assignment.email(participant.id) rescue nil
end
end
redirect_to action: 'edit', id: @participant.id
end

3) Initially no mail was going to the reciever when a participant was sending an invitation to another participant. We have edited the create method to put the mail functionality in invitations controller

def create
# check if the invited user is already invited (i.e. awaiting reply)
if Invitation.is_invited?(@student.user_id, @user.id, @student.parent_id)
create_utility
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(@user, "You have been invited to join a team", "user_invite").deliver
#password = "password"
#prepared_mail = MailerHelper.send_mail_to_user(@user, "You have been invited to join a team", "user_welcome", password)
#prepared_mail.deliver
else
flash[:note] = "You have already sent an invitation to \"#{@user.name}\"."
end

update_join_team_request @user, @student

redirect_to view_student_teams_path student_id: @student.id
end

we also created two partials for the respective view namely.
*app/views/mailer/partials/_user_invite_html.html.erb
*app/views/mailer/partials/_user_invite_plain.html.erb

4) As there was no mailing method for invitation there was also no method to notify the sender of invitation about the acceptance of his invitation. For this we made changes in the accept and decline methods of the invitations controller.

def accept
# Accept the invite and check whether the add was successful
@inv = Invitation.find(params[:inv_id])
sender_student = @inv.from_user
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(sender_student, "Invitation accepted.", "user_invite_accept").deliver
unless Invitation.accept_invite(params[:team_id], @inv.from_id, @inv.to_id, @student.parent_id)
flash[:error] = 'The system failed to add you to the team that invited you.'
end

redirect_to view_student_teams_path student_id: params[:student_id]
end

def decline
@inv = Invitation.find(params[:inv_id])
# Status code D for declined
@inv.reply_status = 'D'
@inv.save
student = Participant.find(params[:student_id])
sender_student = @inv.from_user
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(sender_student, "Invitation declined.", "user_invite_decline").deliver
redirect_to view_student_teams_path student_id: student.id
end

Apart from that we created four partials for the respective changes,namely:

*app/views/mailer/partials/_user_accept_html.html.erb
*app/views/mailer/partials/_user_accept_plain.html.erb
*app/views/mailer/partials/_user_decline_html.html.erb
*app/views/mailer/partials/_user_decline_plain.html.erb

5) When a student suggests a topic initially the instructor was not notified. We created a method send_mail_to_instructor() to send mails in the mailer.rb.

# E1758 Fall 17
def send_mail_to_instructor()
#just for development purpose, else parameters can be passed accordingly
mail(to:'expertiza.development@gmail.com',subject: "A new topic suggestion by student")
end

We called the above defined method in the suggestion_controller.

# E1758 Fall 17
Mailer.send_mail_to_instructor().deliver_now
redirect_to action: 'new', id: @suggestion.assignment_id

Now the instructor is recieving mail when a student is suggesting a topic.

We also added two views which consist of the respective mail content.

*app/views/mailer/send_mail_to_instructor.html.erb
*app/views/mailer/send_mail_to_instructor.text.erb

==Testing==
Our project requirements do not include designing automated test cases and writing tests so we have done manual testing to make sure that it works well. The manual testing is shown in the video.The description for the manual testing is given below:

To test the functionality regarding the first requirement we imported a csv file named test.csv , which contained the details of a student, from the course_participant page. With this import the student was added as a course participant and the mail was successfully sent to expertiza.development@gmail.com. Then we repeated the same procedure from assignment_participant page and this time also the added mailing functionality worked well.

To check the email functionality for invitations we logged in as student5001 and sent an invite request to student5002 for program 1 and the invitation mail was successfully sent to expertiza.development@gmail.com. Then we logged in as student5002 and declined the invite request and mail stating a decline was successfully sent to the expertiza.development@gmail.com. We repeated the process of sending mail from student5001 but this time we accepted the invitation when logged in as student5002. This time also the invitation accepted mail was sent successfully.

To check the deadline functionality :
Testing this functionality was the most challenging part amongst other parts of testing and usually used to take around 15 to 20 minutes, and if any not successful, we had to repeat. Every time, we logged in as an instructor and then set the due dates in such a way that we could wait and perform the intermediate steps from student's part, say keep 2 minutes gap among each of the stages of the assignment. After the due dates were set up, we login from a student id and then upload link in the submission phase. We see that the reviewer gets the email as soon as review phase starts, and reviewer's email was set to expertiza@mailinator.com for development and testing purposes. Again, when submission phase starts, student uploads other link or upload a file, after it the reviewer gets the email. But if the student submits another link in the last review phase (we had set the assignment to have 2 submission rounds and 2 review rounds), then this time the reviewer does not get an email, and this is how it was expected to be.

To check the email on submission functionality we logged in as student5001 and suggested a topic test1. As we submitted the suggestion the mail was successfully sent to the instructor.

So our manual testing covers all the requirements and all the functionality works fine.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1048
*Git compare link: https://github.com/expertiza/expertiza/compare/master...pmg007:pmg?expand=1

==References==
[https://expertiza.ncsu.edu/ Expertiza NCSU]
==Team==
[mailto:pmgandh2@ncsu.edu pragam gandhi] 
[mailto:kchopra@ncsu.edu kapil chopra] 
[mailto:ksharma5@ncsu.edu kamal sharma]

CSC/ECE 517 Fall 2017/E1758 Improve e-mail notifications

2017-11-07T00:08:48Z

Pmgandh2: /* Testing */

=='''Introduction'''==

Expertiza is a web application developed using Ruby on Rails that serves as a peer-review system. The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1][2]. It is an open source project and it's codebase is maintained in GitHub. We are contributing to Expertiza as a part of our Object-Oriented Design and Development's Open-Source Software (OSS) Project. Our goal in this project is to fix various issues related to staggered deadlines for assignments. A staggered-deadline assignment is an assignment in which different topics have different deadlines. In this Wiki Page, we will explain the changes that we have made for the same.

=='''Changes To Be Implemented'''==
*'''What’s wrong:'''

<li>When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created. So this involves adding a call to the e-mailer … or, perhaps, moving an email call from the Users controller to the point where an account is actually created.
<li> Second, evidently if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review is in progress.The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed. It would also be nice to fix the message so it tells which review (Review 1, Review 2, etc.) has been revised, and gives the reviewer a link directly to it.

*'''There are also other circumstances when it would be helpful to send mail.'''

<li>Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
<li>The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
<li>Notify an instructor by e-mail when a student suggests a topic.

=='''Modified Files'''==

*app/controllers/invitations_controller.rb
*app/controllers/submitted_content_controller.rb
*app/controllers/suggestion_controller.rb
*app/mailers/mailer.rb
*app/models/assignment.rb
*app/models/assignment_participant.rb
*app/models/course_participant.rb

=='''Added Files'''==

*app/views/mailer/partials/_user_invite_html.html.erb
*app/views/mailer/partials/_user_invite_plain.html.erb
*app/views/mailer/partials/_user_welcome_html.html.erb
*app/views/mailer/partials/_user_welcome_plain.html.erb
*app/views/mailer/send_mail_to_instructor.html.erb
*app/views/mailer/send_mail_to_instructor.text.erb

*app/views/mailer/partials/_user_accept_html.html.erb
*app/views/mailer/partials/_user_accept_plain.html.erb
*app/views/mailer/partials/_user_decline_html.html.erb
*app/views/mailer/partials/_user_decline_plain.html.erb

=='''Approach Taken To Implement Changes'''==

NOTE: All the mails except the ones for the reviewer which are sent to mailinator , are sent to expertiza.development@gmail.com ,as this is already set in the development environment.

1) Initially the email were being sent to users when they were added using a CSV file on the users page only . Now we added a method in the assignment_participant.rb model to send mails when a participant is added to an assignment on the assignment page through a CSV file.

def self.import(row, _row_header = nil, session, id)
raise ArgumentError, "No user id has been specified." if row.empty?
user = User.find_by_name(row[0])
if user.nil?
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
end
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)
new_part.set_handle
# E1758 Fall17
password = "password"#user.password
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
end
end

Also we added a method in the course_participant.rb file to send the mails when the user is added on the course page using a CSV file.

def self.import(row, _row_header = nil, session, id)
raise ArgumentError, "No user id has been specified." if row.empty?
user = User.find_by_name(row[0])
if user.nil?
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
end
course = Course.find(id)
if course.nil?
raise ImportError, "The course with the id \"" + id.to_s + "\" was not found."
end
unless CourseParticipant.exists?(user_id: user.id, parent_id: course.id)
CourseParticipant.create(user_id: user.id, parent_id: course.id)
# E1758 Fall 17
password = "password"#user.password
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
end
end

2) Initially whenever a submission was being revised ,a mail was being sent to the the reviewer to revise the review. We needed to make sure that mail should not go when it is the last phase of review.

We put a check on the condition that if it is the last round of review then mail should not be sent to the reviewer for revision of his review.
for that we created a method review_deadline in the assignment.rb file to check if the next due date round is equal to number of review rounds or not.
# E1758 Fall 17
def review_deadline(topic_id = nil, num_review_rounds)
return false if topic_id.nil? and self.staggered_deadline?
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return !(next_due_date.round == num_review_rounds && next_due_date.deadline_type_id == 2)
end

We also created a method in the assignment_participant.rb file to check if the round is valid for mail.

# E1758 Fall 17
def is_round_valid_for_mail?
topic_id = SignedUpTeam.topic_id(self.parent_id, self.user_id)
return assignment.review_deadline(topic_id, assignment.num_review_rounds)
end
end

In the submitted_content_controller.rb we created a check

# E1758 Fall 17
if participant.is_round_valid_for_mail?
reviewers = []
participant.reviewers.each do |reviewer|
reviewers << User.find(reviewer.user_id).email
end
Mailer.delayed_message(bcc: reviewers, subject: "You have a new submission to be review", body: "Please visit http://expertiza.ncsu.edu and proceed to peer reviews.").deliver_now
# participant.assignment.email(participant.id) rescue nil
end
end
redirect_to action: 'edit', id: @participant.id
end

3) Initially no mail was going to the reciever when a participant was sending an invitation to another participant. We have edited the create method to put the mail functionality in invitations controller

def create
# check if the invited user is already invited (i.e. awaiting reply)
if Invitation.is_invited?(@student.user_id, @user.id, @student.parent_id)
create_utility
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(@user, "You have been invited to join a team", "user_invite").deliver
#password = "password"
#prepared_mail = MailerHelper.send_mail_to_user(@user, "You have been invited to join a team", "user_welcome", password)
#prepared_mail.deliver
else
flash[:note] = "You have already sent an invitation to \"#{@user.name}\"."
end

update_join_team_request @user, @student

redirect_to view_student_teams_path student_id: @student.id
end

we also created two partials for the respective view namely.
*app/views/mailer/partials/_user_invite_html.html.erb
*app/views/mailer/partials/_user_invite_plain.html.erb

4) As there was no mailing method for invitation there was also no method to notify the sender of invitation about the acceptance of his invitation. For this we made changes in the accept and decline methods of the invitations controller.

def accept
# Accept the invite and check whether the add was successful
@inv = Invitation.find(params[:inv_id])
sender_student = @inv.from_user
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(sender_student, "Invitation accepted.", "user_invite_accept").deliver
unless Invitation.accept_invite(params[:team_id], @inv.from_id, @inv.to_id, @student.parent_id)
flash[:error] = 'The system failed to add you to the team that invited you.'
end

redirect_to view_student_teams_path student_id: params[:student_id]
end

def decline
@inv = Invitation.find(params[:inv_id])
# Status code D for declined
@inv.reply_status = 'D'
@inv.save
student = Participant.find(params[:student_id])
sender_student = @inv.from_user
# E1758 Fall 17
MailerHelper.send_mail_to_invitee(sender_student, "Invitation declined.", "user_invite_decline").deliver
redirect_to view_student_teams_path student_id: student.id
end

Apart from that we created four partials for the respective changes,namely:

*app/views/mailer/partials/_user_accept_html.html.erb
*app/views/mailer/partials/_user_accept_plain.html.erb
*app/views/mailer/partials/_user_decline_html.html.erb
*app/views/mailer/partials/_user_decline_plain.html.erb

5) When a student suggests a topic initially the instructor was not notified. We created a method send_mail_to_instructor() to send mails in the mailer.rb.

# E1758 Fall 17
def send_mail_to_instructor()
#just for development purpose, else parameters can be passed accordingly
mail(to:'expertiza.development@gmail.com',subject: "A new topic suggestion by student")
end

We called the above defined method in the suggestion_controller.

# E1758 Fall 17
Mailer.send_mail_to_instructor().deliver_now
redirect_to action: 'new', id: @suggestion.assignment_id

Now the instructor is recieving mail when a student is suggesting a topic.

We also added two views which consist of the respective mail content.

*app/views/mailer/send_mail_to_instructor.html.erb
*app/views/mailer/send_mail_to_instructor.text.erb

==Testing==
Our project requirements do not include designing automated test cases so we have done manual testing to make sure that it works well. The manual testing is shown in the video.The description for the manual testing is given below:

To test the functionality regarding the first requirement we imported a csv file named test.csv , which contained the details of a student, from the course_participant page. With this import the student was added as a course participant and the mail was successfully sent to expertiza.development@gmail.com. Then we repeated the same procedure from assignment_participant page and this time also the added mailing functionality worked well.

To check the email functionality for invitations we logged in as student5001 and sent an invite request to student5002 for program 1 and the invitation mail was successfully sent to expertiza.development@gmail.com. Then we logged in as student5002 and declined the invite request and mail stating a decline was successfully sent to the expertiza.development@gmail.com. We repeated the process of sending mail from student5001 but this time we accepted the invitation when logged in as student5002. This time also the invitation accepted mail was sent successfully.

To check the deadline functionality :
Testing this functionality was the most challenging part amongst other parts of testing and usually used to take around 15 to 20 minutes, and if any not successful, we had to repeat. Every time, we logged in as an instructor and then set the due dates in such a way that we could wait and perform the intermediate steps from student's part, say keep 2 minutes gap among each of the stages of the assignment. After the due dates were set up, we login from a student id and then upload link in the submission phase. We see that the reviewer gets the email as soon as review phase starts, and reviewer's email was set to expertiza@mailinator.com for development and testing purposes. Again, when submission phase starts, student uploads other link or upload a file, after it the reviewer gets the email. But if the student submits another link in the last review phase (we had set the assignment to have 2 submission rounds and 2 review rounds), then this time the reviewer does not get an email, and this is how it was expected to be.

To check the email on submission functionality we logged in as student5001 and suggested a topic test1. As we submitted the suggestion the mail was successfully sent to the instructor.

So our manual testing covers all the requirements and all the functionality works fine.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1048
*Git compare link: https://github.com/expertiza/expertiza/compare/master...pmg007:pmg?expand=1

==References==
[https://expertiza.ncsu.edu/ Expertiza NCSU]
==Team==
[mailto:pmgandh2@ncsu.edu pragam gandhi] 
[mailto:kchopra@ncsu.edu kapil chopra] 
[mailto:ksharma5@ncsu.edu kamal sharma]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T01:17:25Z

Pmgandh2:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T01:17:07Z

Pmgandh2: Created page with " == About Expertiza == Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching as..."

CSC/ECE 517 Fall 2017

2017-11-06T00:16:33Z

Pmgandh2:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]