Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T21:15:22Z

Hbharat: /* View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
email_author_reviewers(subject, body, email) will be added which can be used in both the workflows to send an Email.
 
From the Reviewer's perspective, the following files will be updated and a new view will be created.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.

[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
We modified the view to add a link that redirects the author to the form.

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

To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
We modified the view to add a link that redirects the reviewer to the form.

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

To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Future Scope==

1. Currently, only a subject and a text message are provided to send an Email, in future the above functionality can be extended to include attachments in the Email. For example, Reviewer can send an image/screenshot for a failure they have come across to the Author.

2. New functionality to send messages within expertiza

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T21:15:07Z

Hbharat: /* View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
email_author_reviewers(subject, body, email) will be added which can be used in both the workflows to send an Email.
 
From the Reviewer's perspective, the following files will be updated and a new view will be created.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.

[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
We modified the view to add a link that redirects the author to the form.

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

To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
We modified the view to add a link that redirects the reviewer to the form.

[[File:Send_email_to_reviewers.png|800px]] 

To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Future Scope==

1. Currently, only a subject and a text message are provided to send an Email, in future the above functionality can be extended to include attachments in the Email. For example, Reviewer can send an image/screenshot for a failure they have come across to the Author.

2. New functionality to send messages within expertiza

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T21:14:37Z

Hbharat:

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
email_author_reviewers(subject, body, email) will be added which can be used in both the workflows to send an Email.
 
From the Reviewer's perspective, the following files will be updated and a new view will be created.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.

[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
We modified the view to add a link that redirects the author to the form.

[[File:Email_the_author_link.png|800px]] 

To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
We modified the view to add a link that redirects the reviewer to the form.

[[File:Send_email_to_reviewers.png|800px]] 

To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Future Scope==

1. Currently, only a subject and a text message are provided to send an Email, in future the above functionality can be extended to include attachments in the Email. For example, Reviewer can send an image/screenshot for a failure they have come across to the Author.

2. New functionality to send messages within expertiza

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Send email to reviewers.png

2022-05-01T21:13:53Z

Hbharat:

File:Email the author link.png

2022-05-01T21:12:50Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:35:53Z

Hbharat: /* Send Email Method in MailerHelper */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.

[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:35:40Z

Hbharat: /* Send Email Method in MailerHelper */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.
[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Email method.png

2022-05-01T20:35:29Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:35:02Z

Hbharat: /* Implememtation */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Send Email Method in MailerHelper===
We created a new method called send_mail_to_author_reviewers(subject, body, email), which accepts 3 parameters; subject, body and email. We used the same method for both sending emails to authors and reviewers.
[[File:Email_method.png|800px]] 

===Email from Reviewer to Author===
====View====
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:28:32Z

Hbharat: /* Email from Reviewer to Author */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Email from Reviewer to Author===
====View====
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

====Controller====
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:28:07Z

Hbharat: /* Reviewer View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Email from Reviewer to Author===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Email from Author to Reviewers===
====View====
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

====Controller====
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:27:26Z

Hbharat: /* Author View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Email from Reviewer to Author===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Reviewer View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:26:06Z

Hbharat: /* Author View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

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

===Reviewer View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:25:51Z

Hbharat: /* Reviewer View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

[[File:Send_email_author.png|800px]] 

===Reviewer View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

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

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:25:29Z

Hbharat: /* Reviewer View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

[[File:Send_email_author.png|800px]] 

===Reviewer View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

[[File:Send_email_reviewer.png|900px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:25:02Z

Hbharat: /* Review View */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

[[File:Send_email_author.png|800px]] 

===Reviewer View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.

[[File:Send_email_reviewer.png|800px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:24:20Z

Hbharat: /* Implememtation */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 
We created a method called send_email in the response_controller which handles the functionality for sending an email. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we pass the subject, body, and email from the view to the controller and send them to a method called send_mail_to_author_reviewers which is a part of MailerHelper. This method is responsible for sending emails to the author.

[[File:Send_email_author.png|800px]] 

===Review View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 
To send an email to all the reviewers, we created a method called send_email in the student_task_controller. The method also contains validations that throw an error if the user is trying to submit the form without filling out the subject or body. If there are no validation errors, we go ahead and pass the parameters; subject, body, and reviewer.email to the send_mail_to_author_reviewers method from MailerHelper.
[[File:Send_email_reviewer.png|800px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-05-01T20:11:51Z

Hbharat:

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Implememtation==

The following are the screenshots of the changes that we made in the codebase.

===Author View===
To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter the subject and body.
[[File:Author_view.png|800px]] 

===Review View===
To create the reviewer view, we created a new view called email_reviewers.html.erb where we created a form that asks the user to enter the subject and body of the email.
[[File:Author_view.png|800px]] 

==Implememtation==The following are the screenshots of the changes that we made in the codebase. ===Author View===To create the author view, we created a new view called author.html.erb and created a form in that file, which asks the user to enter email and subject.

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Send email reviewer.png

2022-05-01T20:03:00Z

Hbharat:

File:Send email author.png

2022-05-01T20:02:39Z

Hbharat:

File:Reviewer view.png

2022-05-01T20:02:15Z

Hbharat:

File:Author view.png

2022-05-01T20:01:39Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-11T21:53:28Z

Hbharat: /* UI */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==UML Diagrams==

==='''Reviewers use case'''===

:: [[File:Reviewer_usecase.png|300px]] 

==='''Author's use case'''===

:: [[File:Author_usecase.png|300px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'''def send_mail_to_user(user, subject, partial_name, password)''' can be used to send the email to an another from reviewer and
'''def send_mail_to_assigned_reviewers''' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/response/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/response_controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/response/email_author.html.erb :''' This is the new UI page. A mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. '''app/views/student_task/view.html.erb :''' link to the new view will be added to this file. 
2. '''app/controllers/student_task controller.rb :''' implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. '''app/views/student_task/email_reviewers.html.erb :''' This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Assignment_page.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the response_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

We will be implementing the decorator design pattern in our code. The decorator pattern is used to add/extend existing functionality without modifying the existing code. Our code is also going to follow the open-closed principle.

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Assignment page.png

2022-04-11T21:52:35Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-11T21:04:34Z

Hbharat: /* UI */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'def send_mail_to_user(user, subject, partial_name, password)' can be used to send the email to an another from reviewer and
'def send_mail_to_assigned_reviewers' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. app/views/student_review/list.html.erb : link to the new view will be added to this file. 
2. app/controllers/student_review_controller.rb : implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. app/views/student_review/email_author.html.erb ( new partial) : This is the new UI page. Mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. App/views/student_task/list.html.erb : link to the new view will be added to this file. 
2. app/controllers/student_task controller.rb : implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. app/views/student_review/email_reviwers.html.erb ( new partial): This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Email-R.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_SS.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the student_review_controller.rb and student_task controller.rb.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

We will be implementing the decorator design pattern in our code. The decorator pattern is used to add/extend existing functionality without modifying the existing code. Our code is also going to follow the open-closed principle.

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Author SS.png

2022-04-11T21:03:20Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-11T21:00:36Z

Hbharat: /* UI */

==Introduction==

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Flowchart==

'''Author's View''' : The flow for authors to email reviewers regarding the work they have been reviewed for:

[[File:Author's view flowchart.jpg|1000px]] 

'''Reviewer's View''' : The flow for reviewers to email authors whose work they have reviewed:

[[File:Reviewers_View_Flowchart.jpg|1000px]] 

==Proposed Changes==
===Code Implementation===

Expertiza code base already contains a module 'MailerHelper' which makes use of ActionMailer and contains methods to send emails to different users.
'def send_mail_to_user(user, subject, partial_name, password)' can be used to send the email to an another from reviewer and
'def send_mail_to_assigned_reviewers' can be used to send emails to all reviewers from an author.
 
From the Reviewer's perspective, the following files will be updated and a new partial will be created to render the new view.

1. app/views/student_review/list.html.erb : link to the new view will be added to this file. 
2. app/controllers/student_review_controller.rb : implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. app/views/student_review/email_author.html.erb ( new partial) : This is the new UI page. Mock up for the view is presented in the UI section. 
 

From Author's perspective, the following files will be updated and a new partial will be created to render the new view.

1. App/views/student_task/list.html.erb : link to the new view will be added to this file. 
2. app/controllers/student_task controller.rb : implementation of the action method for the send button will be added here. Methods from MailerHelper will be used here. 
3. app/views/student_review/email_reviwers.html.erb ( new partial): This is the new UI page. A mockup for the view is presented in the UI section. 

===UI===
As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Email-R.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Author_Screenshot.png|800px]] 

[[File:Msg-to-A.png|800px]] 

==Testing==

===RSPEC Testing===

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the MailHelper class method.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

We are planning to cover the following test cases:

1. Author View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to reviewers",
the author must be redirected to email_reviewers_view.
2. Check if the recipients of the email are indeed the reviewers of the authors' work.

2. Reviewer View:

1. Upon Clicking on the link which is placed on the right corner of the page called "send email to author",
the reviewer must be redirected to email_authors_view.
2. Check if the recipients of the email are indeed the authors of the reviewed work.

We will also be checking the below two edge cases:

1. Author View:
1. Once the email is sent, the author should be redirected to the assignment page with the corresponding success
or failure message
2. Reviewer View:
2. Once the email is sent, the author should be redirected to the "others work" page with the corresponding success
or failure message

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

We will be implementing the decorator design pattern in our code. The decorator pattern is used to add/extend existing functionality without modifying the existing code. Our code is also going to follow the open-closed principle.

==Team Members==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek Arvindkumar Upadhyay (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Author Screenshot.png

2022-04-11T20:59:45Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-04T21:44:35Z

Hbharat: /* Manual Testing */

==Introduction==

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Proposed Changes==

As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Email-R.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Email-to-A.png|800px]] 

[[File:Msg-to-A.png|800px]] 

===Flowchart===

'''The flow for authors to email reviewers regarding the work they have been reviewed for:'''

[[File:Author's view flowchart.jpg|800px]] 

'''The flow for reviewers to email authors whose work they have reviewed:'''

[[File:Reviewers_View_Flowchart.jpg|800px]] 

==Testing==

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the MailHelper class method.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

2. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

We will be implementing the decorator design pattern in our code. The decorator pattern is used to add/extend existing functionality without modifying the existing code. Our code is also going to follow the open-closed principle.

== Team Members ==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-04T21:44:11Z

Hbharat: /* Manual Testing */

==Introduction==

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

This project adds a new feature which will enable a reviewer to send an Email to authors from inside Expertiza or for the author to email all those reviewing them. Often when reviewing another team’s submissions, a reviewer might notice that their deployment link is broken or there is some other issue. Currently, there is no way to email the authors. This features is proposed to solve this issue.

==Scope of the Feature==

- The feature allows authors to send a common Email to all the reviewers to report any issues or updates to their project to be reviewed. 
- It can allow a reviewer to send an email to a particular author if the reviewer wants to convey any issues found with that particular project. 
- Reviewers will be anonymous to authors. 

==Proposed Changes==

As depicted below, Authors will be given a link on their main Assignment page “Send Email to Reviewers” which will take them to a new page where they are given a text box for typing and sending an email to all their reviewers. 

[[File:Email-R.png|800px]] 

[[File:Message-to-R.png|800px]] 

Reviewers will be given a similar text box link on their “Other’s Work” page next to each review that they are doing. 

[[File:Email-to-A.png|800px]] 

[[File:Msg-to-A.png|800px]] 

===Flowchart===

'''The flow for authors to email reviewers regarding the work they have been reviewed for:'''

[[File:Author's view flowchart.jpg|800px]] 

'''The flow for reviewers to email authors whose work they have reviewed:'''

[[File:Reviewers_View_Flowchart.jpg|800px]] 

==Testing==

Since this is a new Feature, Rspec test cases will be added for all the new methods introduced in the MailHelper class method.

===Manual Testing===

For testing purposes, we are using the 'expertiza.debugging@gmail.com' as both author and reviewer.
There are two views that need to be tested manually.

1. Author View:

The author must follow the following steps:
1. Go to the Assignments page.
2. Click on the link which is placed on the right corner of the page called "send email to reviewers".
3. On clicking the above link, the author must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

1. Reviewer View:

The reviewer must follow the following steps:
1. Go to the other's work page.
2. Click on the link which is placed on the right corner of the page called "send email to author".
3. On clicking the above link, the reviewer must be redirected to a page with an email text box.
4. Type the email message and click on send.
5. Log in to the email to check if the message is received.

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

We will be implementing the decorator design pattern in our code. The decorator pattern is used to add/extend existing functionality without modifying the existing code. Our code is also going to follow the open-closed principle.

== Team Members ==

Ashritha Bommagani (abommag@ncsu.edu)

Abhishek (aaupadhy@ncsu.edu)

Harini Bharata (hbharat@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2246: Email your authors/reviewers, with complete tests

2022-04-04T21:26:22Z

Hbharat: /* Design Pattern */

CSC/ECE 517 Spring 2022 - E2224: Refactor review mapping controller

2022-03-28T02:40:53Z

Hbharat: /* review_mapping_controller_spec.rb */

This wiki page is for the description of changes made under E2224 OSS assignment for Spring 2022, CSC/ECE 517.
== Expertiza Background==

Expertiza is an open source project which is developed and maintained by NCSU faculty and students. It is based on Ruby on Rails framework and has many features supporting instructor-student activities. Instructors can create assignments and review student's work. Students can form groups, submit assignments and review peer's work.

== Description of the project ==
The project aims to refactor a controller - review_mapping_controller. It is a long and a complex file and most of the methods do not include comments. The goal is to better re-structure it without modifying its original functionality and improving readability by using meaningful variable names and adding more comments. 
[https://github.com/expertiza/expertiza/pull/2303 Link to the Pull Request Submitted] 
[http://152.7.98.87:8080/ Link to the deployed project] 
[https://github.com/SriPallaviDamuluri/expertiza Link to the Repository] 

== Functionality of review_mapping_controller ==
The functionality of review_mapping_controller is to provide mapping for reviewer and assignment. Basically, the controller handles assignment of reviews to different teams or single student user, such as the event of peer review and self review. Also, this controller is responsible to respond student user request for extra bonus reviews based on assignment policy.

== Problem Statement ==

The review_mapping_controller is a long and complex file. Most of the methods are sparsely commented on. Some methods are way too long to understand, please break them down into pieces for better understanding. Also, the few instances of code duplication that exist should also be removed.

== Tasks ==
-Refactor the long methods in review_mapping_controller.rb 
-Rename variable names such as student_review_num, submission_review_num, calibrated_artifacts_num, participants_hash to convey what they are actually used for 
-Replace switch statements with subclasses methods 
-Create models for the subclasses 
-Remove hardcoded parameters 

== Design Pattern ==

We followed several design patterns while refactoring our code. One of the most common ones is the “Extract Method.” There were several instances where the method was too long and complex. We moved some of the functionality to a different method to make it more readable. This way, it became easier and clearer to understand what the method achieved.
Another issue we observed with the code was that it had too many conditional statements. We used the “Refactoring conditionals” design pattern, which aims to place the block of code in the conditional statement in a different method and call that method. This improves the readability of our code.

== Files modified/created in the current project ==

=== review_mapping_controller.rb ===

=== review_mapping_controller_spec.rb ===

=== _calibration.html.erb ===

== Details of the changes made==

=== review_mapping_controller.rb ===

This controller will map the submissions made by the teams to the students for facilitating peer-reviewing. The following methods which were originally long and complex were broken down into simpler methods.
We have added comments for every new method that was added and updated existing comments where ever required.

(i) '''peer_review_strategy''': 

The above method assigns reviews evenly among the participants for each team. It doesn't allow the participant to review his/her own work. Initially, this method was almost 80 lines long containing multiply nested if statements and it was a conglomeration of various functionalities required to achieve the strategy. It was broken down meaningfully into 4 different functions to handle different functionalities. The DRY principle is followed. 
peer_review_strategy() is divided into even_out_reviews_among_teams(), modify_selected_participants_to_review(), remove_students_with_enough_reviews(), get_random_participant_index() as the core functionality blocks. 
[[File: Peer review 1.png|700px]]
[[File: Even out reviews.png|700px]]
[[File: Other methods.png|700px]]

:'''even_out_reviews_among_teams''' - This method is used to even out the # of reviews among teams for the specified assignment ID 
:'''modify_selected_participants_to_review''' - This method is used to update the selected participants corresponding to a team to review 
:'''remove_students_with_enough_reviews''' - This method is used to remove students who have already been assigned enough num of reviews out of participants array 
:'''get_random_participant_index''' - This method is used to get random index to select a random participant for assigning a review 

(ii) '''assign_reviewer_dynamically''': 
[[File: Assign rev dynamically1.png|700px]]
[[File: Assign rev dynamically2.png|700px]]

The above method is used to assign submissions of students for peer reviews. It also makes sure that a reviewer can do only a certain number of reviews based on the assignment policy. We broke this method down by adding the assign_on_topic_availability method, which makes assignments based on the availability of the topic. It makes an assignment for both the cases where the topic is available and the topic is not available.

(iii) '''automatic_review_mapping''': 

The above method was also long and contained multiples tasks that can be separated into different methods. We have introduced the following methods: 
:'''create_team''' - creates teams for individual assignments
[[File: Create team.png|700px]]

:'''mapping_strategy_without_artifacts'''- checks for pre-conditions when there are no artifacts and applies review strategy method
[[File: Mapping strategy without artifacts.png|700px]]

:'''mapping_strategy_on_artifacts'''- applies review mapping strategy based on calibrated and un-calibrated artifacts
[[File: Mapping strategy on artifacts.png|700px]]

(iv) '''add_reviewer''' : 
[[File: Add reviewer.png|700px]]
[[File: Add reviewer to another team.png|700px]]

The above method adds a reviewer to a student's work. Initially, the method checks whether the student is being assigned to review the work of his/her teammates and displays an error. If not, the student is assigned to review the work of students from a different team. The logic which handles the assignment of work from another team is moved to a separate method named as ''''add_reviewer_to_another_team''''. 

(v) '''add_instructor_to_do_standard_peer_review''' : 
[[File: Add instructor to do standard peer review.png|700px]]

The above method name was changed to add_instructor_to_do_standard_peer_review from add_calibration. The method add_instructor_to_do_standard_peer_review gets called when the instructor of this assignment wants to do the expert peer-review. It checks if a participant is an instructor of this assignment in corresponding views and in this function it checks with certain user_id exists in the AssignmentParticipant map. If it's not able to find it, it'll create one.

We found that the functionality of both the delete_metareview method and delete_metareviewer method were of the same and hence we have removed the delete_metareview method to avoid code duplication.

We have modified variable names throughout all the methods to make them more readable.

=== review_mapping_controller_spec.rb ===

Updated following params variable names for better readability: 
'''max_team_size'''
'''num_reviews_per_student''' 
'''num_reviews_per_submission''' 
'''num_calibrated_artifacts''' 
'''num_uncalibrated_artifacts''' 

[[File:Rspec2png.png|700px]]

== Test Plan ==

==== Manual UI Testing ====

According to the introduction, the modification of this project is about review_mapping_controller.rb. The main job of this controller is to correctly assign the review to each student who is requesting them for a certain assignment. Unfortunately, the deployed project database is not complete, and student accounts cannot be created. Therefore, we cannot use the deployed project to give a complete UI test plan.

In fact, due to system reasons, the internal logic of these controllers cannot be tested using UI tests because they are work flow and logic that have nothing to do with the UI. (The work flow can be found here [https://expertiza.csc.ncsu.edu/index.php/Review_mappings]) So we will re-introduce and emphasis the tests in Rspec unit test section to explain why the project is still complete after modification.

==== Rspec Unit Tests ====

As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
rspec spec/controllers/review_mapping_controller_spec.rb

Refactoring changes did not break any functionality. All the existing test cases passed successfully.
Adding new testcases is not in the scope of this project since its a refactoring project.

[[File:Rspec-rmc.png|700px]]

=== Capybara Integration and Functional Tests ===

Our project passed the Travis CI build test.

[[File:Travis-rmc.png|700px]]

== Project Mentor ==

Naman Shrimali (nshrima@ncsu.edu)

== Team Members ==

Harini Bharata (hbharat@ncsu.edu)

Sravanth Reddy Bommana (sbomman@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Rspec2png.png

2022-03-28T02:38:20Z

Hbharat:

CSC/ECE 517 Spring 2022 - E2224: Refactor review mapping controller

2022-03-28T02:34:13Z

Hbharat:

This wiki page is for the description of changes made under E2224 OSS assignment for Spring 2022, CSC/ECE 517.
== Expertiza Background==

Expertiza is an open source project which is developed and maintained by NCSU faculty and students. It is based on Ruby on Rails framework and has many features supporting instructor-student activities. Instructors can create assignments and review student's work. Students can form groups, submit assignments and review peer's work.

== Description of the project ==
The project aims to refactor a controller - review_mapping_controller. It is a long and a complex file and most of the methods do not include comments. The goal is to better re-structure it without modifying its original functionality and improving readability by using meaningful variable names and adding more comments. 
[https://github.com/expertiza/expertiza/pull/2303 Link to the Pull Request Submitted] 
[http://152.7.98.87:8080/ Link to the deployed project] 
[https://github.com/SriPallaviDamuluri/expertiza Link to the Repository] 

== Functionality of review_mapping_controller ==
The functionality of review_mapping_controller is to provide mapping for reviewer and assignment. Basically, the controller handles assignment of reviews to different teams or single student user, such as the event of peer review and self review. Also, this controller is responsible to respond student user request for extra bonus reviews based on assignment policy.

== Problem Statement ==

The review_mapping_controller is a long and complex file. Most of the methods are sparsely commented on. Some methods are way too long to understand, please break them down into pieces for better understanding. Also, the few instances of code duplication that exist should also be removed.

== Tasks ==
-Refactor the long methods in review_mapping_controller.rb 
-Rename variable names such as student_review_num, submission_review_num, calibrated_artifacts_num, participants_hash to convey what they are actually used for 
-Replace switch statements with subclasses methods 
-Create models for the subclasses 
-Remove hardcoded parameters 

== Design Pattern ==

We followed several design patterns while refactoring our code. One of the most common ones is the “Extract Method.” There were several instances where the method was too long and complex. We moved some of the functionality to a different method to make it more readable. This way, it became easier and clearer to understand what the method achieved.
Another issue we observed with the code was that it had too many conditional statements. We used the “Refactoring conditionals” design pattern, which aims to place the block of code in the conditional statement in a different method and call that method. This improves the readability of our code.

== Files modified/created in the current project ==

=== review_mapping_controller.rb ===

=== review_mapping_controller_spec.rb ===

=== _calibration.html.erb ===

== Details of the changes made==

=== review_mapping_controller.rb ===

This controller will map the submissions made by the teams to the students for facilitating peer-reviewing. The following methods which were originally long and complex were broken down into simpler methods.
We have added comments for every new method that was added and updated existing comments where ever required.

(i) '''peer_review_strategy''': 

The above method assigns reviews evenly among the participants for each team. It doesn't allow the participant to review his/her own work. Initially, this method was almost 80 lines long containing multiply nested if statements and it was a conglomeration of various functionalities required to achieve the strategy. It was broken down meaningfully into 4 different functions to handle different functionalities. The DRY principle is followed. 
peer_review_strategy() is divided into even_out_reviews_among_teams(), modify_selected_participants_to_review(), remove_students_with_enough_reviews(), get_random_participant_index() as the core functionality blocks. 
[[File: Peer review 1.png|700px]]
[[File: Even out reviews.png|700px]]
[[File: Other methods.png|700px]]

:'''even_out_reviews_among_teams''' - This method is used to even out the # of reviews among teams for the specified assignment ID 
:'''modify_selected_participants_to_review''' - This method is used to update the selected participants corresponding to a team to review 
:'''remove_students_with_enough_reviews''' - This method is used to remove students who have already been assigned enough num of reviews out of participants array 
:'''get_random_participant_index''' - This method is used to get random index to select a random participant for assigning a review 

(ii) '''assign_reviewer_dynamically''': 
[[File: Assign rev dynamically1.png|700px]]
[[File: Assign rev dynamically2.png|700px]]

The above method is used to assign submissions of students for peer reviews. It also makes sure that a reviewer can do only a certain number of reviews based on the assignment policy. We broke this method down by adding the assign_on_topic_availability method, which makes assignments based on the availability of the topic. It makes an assignment for both the cases where the topic is available and the topic is not available.

(iii) '''automatic_review_mapping''': 

The above method was also long and contained multiples tasks that can be separated into different methods. We have introduced the following methods: 
:'''create_team''' - creates teams for individual assignments
[[File: Create team.png|700px]]

:'''mapping_strategy_without_artifacts'''- checks for pre-conditions when there are no artifacts and applies review strategy method
[[File: Mapping strategy without artifacts.png|700px]]

:'''mapping_strategy_on_artifacts'''- applies review mapping strategy based on calibrated and un-calibrated artifacts
[[File: Mapping strategy on artifacts.png|700px]]

(iv) '''add_reviewer''' : 
[[File: Add reviewer.png|700px]]
[[File: Add reviewer to another team.png|700px]]

The above method adds a reviewer to a student's work. Initially, the method checks whether the student is being assigned to review the work of his/her teammates and displays an error. If not, the student is assigned to review the work of students from a different team. The logic which handles the assignment of work from another team is moved to a separate method named as ''''add_reviewer_to_another_team''''. 

(v) '''add_instructor_to_do_standard_peer_review''' : 
[[File: Add instructor to do standard peer review.png|700px]]

The above method name was changed to add_instructor_to_do_standard_peer_review from add_calibration. The method add_instructor_to_do_standard_peer_review gets called when the instructor of this assignment wants to do the expert peer-review. It checks if a participant is an instructor of this assignment in corresponding views and in this function it checks with certain user_id exists in the AssignmentParticipant map. If it's not able to find it, it'll create one.

We found that the functionality of both the delete_metareview method and delete_metareviewer method were of the same and hence we have removed the delete_metareview method to avoid code duplication.

We have modified variable names throughout all the methods to make them more readable.

=== review_mapping_controller_spec.rb ===

Updated following params variable names for better readability: 
'''max_team_size'''
'''num_reviews_per_student''' 
'''num_reviews_per_submission''' 
'''num_calibrated_artifacts''' 
'''num_uncalibrated_artifacts''' 

== Test Plan ==

==== Manual UI Testing ====

According to the introduction, the modification of this project is about review_mapping_controller.rb. The main job of this controller is to correctly assign the review to each student who is requesting them for a certain assignment. Unfortunately, the deployed project database is not complete, and student accounts cannot be created. Therefore, we cannot use the deployed project to give a complete UI test plan.

In fact, due to system reasons, the internal logic of these controllers cannot be tested using UI tests because they are work flow and logic that have nothing to do with the UI. (The work flow can be found here [https://expertiza.csc.ncsu.edu/index.php/Review_mappings]) So we will re-introduce and emphasis the tests in Rspec unit test section to explain why the project is still complete after modification.

==== Rspec Unit Tests ====

As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
rspec spec/controllers/review_mapping_controller_spec.rb

Refactoring changes did not break any functionality. All the existing test cases passed successfully.
Adding new testcases is not in the scope of this project since its a refactoring project.

[[File:Rspec-rmc.png|700px]]

=== Capybara Integration and Functional Tests ===

Our project passed the Travis CI build test.

[[File:Travis-rmc.png|700px]]

== Project Mentor ==

Naman Shrimali (nshrima@ncsu.edu)

== Team Members ==

Harini Bharata (hbharat@ncsu.edu)

Sravanth Reddy Bommana (sbomman@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2224: Refactor review mapping controller

2022-03-28T02:31:54Z

Hbharat:

This wiki page is for the description of changes made under E2224 OSS assignment for Spring 2022, CSC/ECE 517.
== Expertiza Background==

Expertiza is an open source project which is developed and maintained by NCSU faculty and students. It is based on Ruby on Rails framework and has many features supporting instructor-student activities. Instructors can create assignments and review student's work. Students can form groups, submit assignments and review peer's work.

== Description of the project ==
The project aims to refactor a controller - review_mapping_controller. It is a long and a complex file and most of the methods do not include comments. The goal is to better re-structure it without modifying its original functionality and improving readability by using meaningful variable names and adding more comments. 
[https://github.com/expertiza/expertiza/pull/2303 Link to the Pull Request Submitted] 
[http://152.7.98.87:8080/ Link to the deployed project] 
[https://github.com/SriPallaviDamuluri/expertiza Link to the Repository] 

== Functionality of review_mapping_controller ==
The functionality of review_mapping_controller is to provide mapping for reviewer and assignment. Basically, the controller handles assignment of reviews to different teams or single student user, such as the event of peer review and self review. Also, this controller is responsible to respond student user request for extra bonus reviews based on assignment policy.

== Problem Statement ==

The review_mapping_controller is a long and complex file. Most of the methods are sparsely commented on. Some methods are way too long to understand, please break them down into pieces for better understanding. Also, the few instances of code duplication that exist should also be removed.

== Tasks ==
-Refactor the long methods in review_mapping_controller.rb 
-Rename variable names such as student_review_num, submission_review_num, calibrated_artifacts_num, participants_hash to convey what they are actually used for 
-Replace switch statements with subclasses methods 
-Create models for the subclasses 
-Remove hardcoded parameters 

== Design Pattern ==

We followed several design patterns while refactoring our code. One of the most common ones is the “Extract Method.” There were several instances where the method was too long and complex. We moved some of the functionality to a different method to make it more readable. This way, it became easier and clearer to understand what the method achieved.
Another issue we observed with the code was that it had too many conditional statements. We used the “Refactoring conditionals” design pattern, which aims to place the block of code in the conditional statement in a different method and call that method. This improves the readability of our code.

== Files modified/created in the current project ==

=== review_mapping_controller.rb ===

=== review_mapping_controller_spec.rb ===

=== _calibration.html.erb ===

== Details of the changes made==

=== review_mapping_controller.rb ===

This controller will map the submissions made by the teams to the students for facilitating peer-reviewing. The following methods which were originally long and complex were broken down into simpler methods.
We have added comments for every new method that was added and updated existing comments where ever required.

(i) '''peer_review_strategy''': 

The above method assigns reviews evenly among the participants for each team. It doesn't allow the participant to review his/her own work. Initially, this method was almost 80 lines long containing multiply nested if statements and it was a conglomeration of various functionalities required to achieve the strategy. It was broken down meaningfully into 4 different functions to handle different functionalities. The DRY principle is followed. 
peer_review_strategy() is divided into even_out_reviews_among_teams(), modify_selected_participants_to_review(), remove_students_with_enough_reviews(), get_random_participant_index() as the core functionality blocks. 
[[File: Peer review 1.png|500px]]
[[File: Even out reviews.png|500px]]
[[File: Other methods.png|500px]]

:'''even_out_reviews_among_teams''' - This method is used to even out the # of reviews among teams for the specified assignment ID 
:'''modify_selected_participants_to_review''' - This method is used to update the selected participants corresponding to a team to review 
:'''remove_students_with_enough_reviews''' - This method is used to remove students who have already been assigned enough num of reviews out of participants array 
:'''get_random_participant_index''' - This method is used to get random index to select a random participant for assigning a review 

(ii) '''assign_reviewer_dynamically''': 
[[File: Assign rev dynamically1.png|500px]]
[[File: Assign rev dynamically2.png|500px]]

The above method is used to assign submissions of students for peer reviews. It also makes sure that a reviewer can do only a certain number of reviews based on the assignment policy. We broke this method down by adding the assign_on_topic_availability method, which makes assignments based on the availability of the topic. It makes an assignment for both the cases where the topic is available and the topic is not available.

(iii) '''automatic_review_mapping''': 

The above method was also long and contained multiples tasks that can be separated into different methods. We have introduced the following methods: 
:'''create_team''' - creates teams for individual assignments
[[File: Create team.png|500px]]

:'''mapping_strategy_without_artifacts'''- checks for pre-conditions when there are no artifacts and applies review strategy method
[[File: Mapping strategy without artifacts.png]]

:'''mapping_strategy_on_artifacts'''- applies review mapping strategy based on calibrated and un-calibrated artifacts
[[File: Mapping strategy on artifacts.png]]

(iv) '''add_reviewer''' : 
[[File: Add reviewer.png|500px]]
[[File: Add reviewer to another team.png|500px]]

The above method adds a reviewer to a student's work. Initially, the method checks whether the student is being assigned to review the work of his/her teammates and displays an error. If not, the student is assigned to review the work of students from a different team. The logic which handles the assignment of work from another team is moved to a separate method named as ''''add_reviewer_to_another_team''''. 

(v) '''add_instructor_to_do_standard_peer_review''' : 
[[File: Add instructor to do standard peer review.png|500px]]

The above method name was changed to add_instructor_to_do_standard_peer_review from add_calibration. The method add_instructor_to_do_standard_peer_review gets called when the instructor of this assignment wants to do the expert peer-review. It checks if a participant is an instructor of this assignment in corresponding views and in this function it checks with certain user_id exists in the AssignmentParticipant map. If it's not able to find it, it'll create one.

We found that the functionality of both the delete_metareview method and delete_metareviewer method were of the same and hence we have removed the delete_metareview method to avoid code duplication.

We have modified variable names throughout all the methods to make them more readable.

=== review_mapping_controller_spec.rb ===

Updated following params variable names for better readability: 
'''max_team_size'''
'''num_reviews_per_student''' 
'''num_reviews_per_submission''' 
'''num_calibrated_artifacts''' 
'''num_uncalibrated_artifacts''' 

== Test Plan ==

==== Manual UI Testing ====

According to the introduction, the modification of this project is about review_mapping_controller.rb. The main job of this controller is to correctly assign the review to each student who is requesting them for a certain assignment. Unfortunately, the deployed project database is not complete, and student accounts cannot be created. Therefore, we cannot use the deployed project to give a complete UI test plan.

In fact, due to system reasons, the internal logic of these controllers cannot be tested using UI tests because they are work flow and logic that have nothing to do with the UI. (The work flow can be found here [https://expertiza.csc.ncsu.edu/index.php/Review_mappings]) So we will re-introduce and emphasis the tests in Rspec unit test section to explain why the project is still complete after modification.

==== Rspec Unit Tests ====

As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
rspec spec/controllers/review_mapping_controller_spec.rb

Refactoring changes did not break any functionality. All the existing test cases passed successfully.
Adding new testcases is not in the scope of this project since its a refactoring project.

[[File:Rspec-rmc.png|700px]]

=== Capybara Integration and Functional Tests ===

Our project passed the Travis CI build test.

[[File:Travis-rmc.png|700px]]

== Project Mentor ==

Naman Shrimali (nshrima@ncsu.edu)

== Team Members ==

Harini Bharata (hbharat@ncsu.edu)

Sravanth Reddy Bommana (sbomman@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

CSC/ECE 517 Spring 2022 - E2224: Refactor review mapping controller

2022-03-28T02:29:44Z

Hbharat: /* review_mapping_controller.rb */

This wiki page is for the description of changes made under E2224 OSS assignment for Spring 2022, CSC/ECE 517.
== Expertiza Background==

Expertiza is an open source project which is developed and maintained by NCSU faculty and students. It is based on Ruby on Rails framework and has many features supporting instructor-student activities. Instructors can create assignments and review student's work. Students can form groups, submit assignments and review peer's work.

== Description of the project ==
The project aims to refactor a controller - review_mapping_controller. It is a long and a complex file and most of the methods do not include comments. The goal is to better re-structure it without modifying its original functionality and improving readability by using meaningful variable names and adding more comments. 
[https://github.com/expertiza/expertiza/pull/2303 Link to the Pull Request Submitted] 
[http://152.7.98.87:8080/ Link to the deployed project] 
[https://github.com/SriPallaviDamuluri/expertiza Link to the Repository] 

== Functionality of review_mapping_controller ==
The functionality of review_mapping_controller is to provide mapping for reviewer and assignment. Basically, the controller handles assignment of reviews to different teams or single student user, such as the event of peer review and self review. Also, this controller is responsible to respond student user request for extra bonus reviews based on assignment policy.

== Problem Statement ==

The review_mapping_controller is a long and complex file. Most of the methods are sparsely commented on. Some methods are way too long to understand, please break them down into pieces for better understanding. Also, the few instances of code duplication that exist should also be removed.

== Tasks ==
-Refactor the long methods in review_mapping_controller.rb 
-Rename variable names such as student_review_num, submission_review_num, calibrated_artifacts_num, participants_hash to convey what they are actually used for 
-Replace switch statements with subclasses methods 
-Create models for the subclasses 
-Remove hardcoded parameters 

== Design Pattern ==

We followed several design patterns while refactoring our code. One of the most common ones is the “Extract Method.” There were several instances where the method was too long and complex. We moved some of the functionality to a different method to make it more readable. This way, it became easier and clearer to understand what the method achieved.
Another issue we observed with the code was that it had too many conditional statements. We used the “Refactoring conditionals” design pattern, which aims to place the block of code in the conditional statement in a different method and call that method. This improves the readability of our code.

== Files modified/created in the current project ==

=== review_mapping_controller.rb ===

=== review_mapping_controller_spec.rb ===

=== _calibration.html.erb ===

== Details of the changes made==

=== review_mapping_controller.rb ===

This controller will map the submissions made by the teams to the students for facilitating peer-reviewing. The following methods which were originally long and complex were broken down into simpler methods.
We have added comments for every new method that was added and updated existing comments where ever required.

(i) '''peer_review_strategy''': 

The above method assigns reviews evenly among the participants for each team. It doesn't allow the participant to review his/her own work. Initially, this method was almost 80 lines long containing multiply nested if statements and it was a conglomeration of various functionalities required to achieve the strategy. It was broken down meaningfully into 4 different functions to handle different functionalities. The DRY principle is followed. 
peer_review_strategy() is divided into even_out_reviews_among_teams(), modify_selected_participants_to_review(), remove_students_with_enough_reviews(), get_random_participant_index() as the core functionality blocks. 
[[File: Peer review 1.png]]
[[File: Even out reviews.png]]
[[File: Other methods.png]]

:'''even_out_reviews_among_teams''' - This method is used to even out the # of reviews among teams for the specified assignment ID 
:'''modify_selected_participants_to_review''' - This method is used to update the selected participants corresponding to a team to review 
:'''remove_students_with_enough_reviews''' - This method is used to remove students who have already been assigned enough num of reviews out of participants array 
:'''get_random_participant_index''' - This method is used to get random index to select a random participant for assigning a review 

(ii) '''assign_reviewer_dynamically''': 
[[File: Assign rev dynamically1.png]]
[[File: Assign rev dynamically2.png]]

The above method is used to assign submissions of students for peer reviews. It also makes sure that a reviewer can do only a certain number of reviews based on the assignment policy. We broke this method down by adding the assign_on_topic_availability method, which makes assignments based on the availability of the topic. It makes an assignment for both the cases where the topic is available and the topic is not available.

(iii) '''automatic_review_mapping''': 

The above method was also long and contained multiples tasks that can be separated into different methods. We have introduced the following methods: 
:'''create_team''' - creates teams for individual assignments
[[File: Create team.png]]

:'''mapping_strategy_without_artifacts'''- checks for pre-conditions when there are no artifacts and applies review strategy method
[[File: Mapping strategy without artifacts.png]]

:'''mapping_strategy_on_artifacts'''- applies review mapping strategy based on calibrated and un-calibrated artifacts
[[File: Mapping strategy on artifacts.png]]

(iv) '''add_reviewer''' : 
[[File: Add reviewer.png]]
[[File: Add reviewer to another team.png ]]

The above method adds a reviewer to a student's work. Initially, the method checks whether the student is being assigned to review the work of his/her teammates and displays an error. If not, the student is assigned to review the work of students from a different team. The logic which handles the assignment of work from another team is moved to a separate method named as ''''add_reviewer_to_another_team''''. 

(v) '''add_instructor_to_do_standard_peer_review''' : 
[[File: Add instructor to do standard peer review.png]]

The above method name was changed to add_instructor_to_do_standard_peer_review from add_calibration. The method add_instructor_to_do_standard_peer_review gets called when the instructor of this assignment wants to do the expert peer-review. It checks if a participant is an instructor of this assignment in corresponding views and in this function it checks with certain user_id exists in the AssignmentParticipant map. If it's not able to find it, it'll create one.

We found that the functionality of both the delete_metareview method and delete_metareviewer method were of the same and hence we have removed the delete_metareview method to avoid code duplication.

We have modified variable names throughout all the methods to make them more readable.

=== review_mapping_controller_spec.rb ===

Updated following params variable names for better readability: 
'''max_team_size'''
'''num_reviews_per_student''' 
'''num_reviews_per_submission''' 
'''num_calibrated_artifacts''' 
'''num_uncalibrated_artifacts''' 

== Test Plan ==

==== Manual UI Testing ====

According to the introduction, the modification of this project is about review_mapping_controller.rb. The main job of this controller is to correctly assign the review to each student who is requesting them for a certain assignment. Unfortunately, the deployed project database is not complete, and student accounts cannot be created. Therefore, we cannot use the deployed project to give a complete UI test plan.

In fact, due to system reasons, the internal logic of these controllers cannot be tested using UI tests because they are work flow and logic that have nothing to do with the UI. (The work flow can be found here [https://expertiza.csc.ncsu.edu/index.php/Review_mappings]) So we will re-introduce and emphasis the tests in Rspec unit test section to explain why the project is still complete after modification.

==== Rspec Unit Tests ====

As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
rspec spec/controllers/review_mapping_controller_spec.rb

Refactoring changes did not break any functionality. All the existing test cases passed successfully.
Adding new testcases is not in the scope of this project since its a refactoring project.

[[File:Rspec-rmc.png|700px]]

=== Capybara Integration and Functional Tests ===

Our project passed the Travis CI build test.

[[File:Travis-rmc.png|700px]]

== Project Mentor ==

Naman Shrimali (nshrima@ncsu.edu)

== Team Members ==

Harini Bharata (hbharat@ncsu.edu)

Sravanth Reddy Bommana (sbomman@ncsu.edu)

Sri Pallavi Damuluri (sdamulu@ncsu.edu)

File:Peer review 1.png

2022-03-28T02:12:06Z

Hbharat:

File:Other methods.png

2022-03-28T01:54:55Z

Hbharat:

File:Mapping strategy without artifacts.png

2022-03-28T01:54:25Z

Hbharat:

File:Mapping strategy on artifacts.png

2022-03-28T01:53:58Z

Hbharat:

File:Even out reviews.png

2022-03-28T01:53:38Z

Hbharat:

File:Create team.png

2022-03-28T01:53:20Z

Hbharat:

File:Assign rev dynamically2.png

2022-03-28T01:52:49Z

Hbharat:

File:Assign rev dynamically1.png

2022-03-28T01:52:26Z

Hbharat:

File:Add reviewer to another team.png

2022-03-28T01:51:34Z

Hbharat:

File:Add reviewer.png

2022-03-28T01:51:13Z

Hbharat:

File:Add instructor to do standard peer review.png

2022-03-28T01:50:29Z

Hbharat: