Expertiza_Wiki - User contributions [en]

E1875 Revision Planning Tool

2018-12-14T03:32:26Z

Atewari:

== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.

 
== What needs to be done? ==
* Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
** A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
** One or more questions for every proposed improvement. Example:
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission

 
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.

 
== Motivation ==
The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

 
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.

 

=== UI mockups ===
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review. 
[[File:E1875U1_1.jpg]] 
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects. 
[[File:E1875UI_2.jpg]]
 
 

== Files modified ==

==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a7ee7dddd7aedbc0b814d98f0cb34c25 grades_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-b41fa84d1ee0c03c4e301f977fbe453d questionnaires_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7786ab741930f6bace28b7e5da61b8d6 response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-33d668958529875af7029d78e37aff60 submitted_content_controller.rb]

==== Views ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-2213cf9074761b4121a9fb3ddcce6145 questionnaires/_questionnaire.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]

==== Models ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a983bfc492e6d1982c673bc208afe459 answer.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3dffd0131e1a14847e8c98376bae4984 questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-85f51952994f8162980c605efd60db44 revision_review_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c6f2a3b3452f5a9effa4a2b023ed2322 submission_record.rb]

==== Database ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c2ba560985d8d1ea9184e04d71bf2c83 20181123004154_add_submission_record_to_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-1acd2e7e27a227829d5d14a91c863bb6 schema.rb]

==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-ebb9ab8d49abf2b40d4aad426dad68e5 grades_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-df286dc963f50de24c47bacfb0b3a143 questionnaires_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7d95010cdfe370a461e216ba1d724392 assignment_submission_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a68a7982922073b9602c0fd6097e0bd2 answer_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-e162432910d3b3b29b3c9711d6e818bb revision_review_questionnaire_spec.rb]

==== config ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-21497849d8f00507c9c8dcaf6288b136 routes.rb]

== Test Plan and Demo ==

=== Test Plan ===
# Login as 'instructor6' with password 'password'.
# Create 2 new users named 'abc' and 'xyz'.
# Make an assignment with the name 'RPT'. Add abc and xyz as participants to RPT.
# Set 2 rounds of submissions and reviews in RPT.
# impersonate abc.
# submit for round 1.
# move to round 1 review stage.
# impersonate xyz.
# add review as xyz.
# move to round 2 submission stage
# impersonate abc.
# submit a revision plan through the submission page.
# move to round 2 review.
# impersonate xyz.
# verify that revision plan wuestions are added to the review and submit the review.
# impersonate abc.
# verify that review has been received on the revision plan questions.

=== demo video ===
[https://www.youtube.com/watch?v=J1QeUd0b7RQ E1875]

E1875 Revision Planning Tool

2018-12-14T03:31:14Z

Atewari:

E1875 Revision Planning Tool

2018-12-14T03:17:12Z

Atewari:

== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.

 
== What needs to be done? ==
* Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
** A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
** One or more questions for every proposed improvement. Example:
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission

 
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.

 
== Motivation ==
The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

 
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.

 

=== UI mockups ===
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review. 
[[File:E1875U1_1.jpg]] 
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects. 
[[File:E1875UI_2.jpg]]
 
 
=== Test Plan ===
# Authors should be able to add additional review questions to their submission.
# Reviewers should be able to give feedback according to the review question written by the author.
# Authors should be able to view the feedback given on the questions they wrote.
# ''Stretch'': Instructors should be able to set requirements on the number of additional review questions authors are required to add.
 

== Files modified ==

==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a7ee7dddd7aedbc0b814d98f0cb34c25 grades_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-b41fa84d1ee0c03c4e301f977fbe453d questionnaires_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7786ab741930f6bace28b7e5da61b8d6 response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-33d668958529875af7029d78e37aff60 submitted_content_controller.rb]

==== Views ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-2213cf9074761b4121a9fb3ddcce6145 questionnaires/_questionnaire.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]

==== Models ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a983bfc492e6d1982c673bc208afe459 answer.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3dffd0131e1a14847e8c98376bae4984 questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-85f51952994f8162980c605efd60db44 revision_review_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c6f2a3b3452f5a9effa4a2b023ed2322 submission_record.rb]

==== Database ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c2ba560985d8d1ea9184e04d71bf2c83 20181123004154_add_submission_record_to_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-1acd2e7e27a227829d5d14a91c863bb6 schema.rb]

==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-ebb9ab8d49abf2b40d4aad426dad68e5 grades_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-df286dc963f50de24c47bacfb0b3a143 questionnaires_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7d95010cdfe370a461e216ba1d724392 assignment_submission_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a68a7982922073b9602c0fd6097e0bd2 answer_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-e162432910d3b3b29b3c9711d6e818bb revision_review_questionnaire_spec.rb]

==== config ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-21497849d8f00507c9c8dcaf6288b136 routes.rb]

E1875 Revision Planning Tool

2018-12-14T03:16:42Z

Atewari:

== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.

 
== What needs to be done? ==
* Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
** A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
** One or more questions for every proposed improvement. Example:
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission

 
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.

 
== Motivation ==
The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

 
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.

 

=== Files to be modified ===
==== Bookmark Rating Questionnaire ====
Bookmark Rating Questionnaire Controller Code[https://github.com/rahuliyer95/expertiza/blob/157553470c420bafc17413978dfccc0a89790dee/app/controllers/bookmark_rating_questionnaire_controller.rb#L4]

==== Questionnaire ====
* questionnaire_controller.rb
* questionnaire.rb
* author_review_questionnaire.rb ( doesn’t exist, needs to be created and named appropriately )
* questionnaires/*.erb
 
==== Submitted Content ====
* submitted_content_controller.rb
* submission_record.rb
 

=== UI mockups ===
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review. 
[[File:E1875U1_1.jpg]] 
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects. 
[[File:E1875UI_2.jpg]]
 
 
=== Test Plan ===
# Authors should be able to add additional review questions to their submission.
# Reviewers should be able to give feedback according to the review question written by the author.
# Authors should be able to view the feedback given on the questions they wrote.
# ''Stretch'': Instructors should be able to set requirements on the number of additional review questions authors are required to add.
 
== Files modified ==

==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a7ee7dddd7aedbc0b814d98f0cb34c25 grades_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-b41fa84d1ee0c03c4e301f977fbe453d questionnaires_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7786ab741930f6bace28b7e5da61b8d6 response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-33d668958529875af7029d78e37aff60 submitted_content_controller.rb]

==== Views ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-2213cf9074761b4121a9fb3ddcce6145 questionnaires/_questionnaire.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]

==== Models ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a983bfc492e6d1982c673bc208afe459 answer.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3dffd0131e1a14847e8c98376bae4984 questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-85f51952994f8162980c605efd60db44 revision_review_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c6f2a3b3452f5a9effa4a2b023ed2322 submission_record.rb]

==== Database ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c2ba560985d8d1ea9184e04d71bf2c83 20181123004154_add_submission_record_to_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-1acd2e7e27a227829d5d14a91c863bb6 schema.rb]

==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-ebb9ab8d49abf2b40d4aad426dad68e5 grades_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-df286dc963f50de24c47bacfb0b3a143 questionnaires_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7d95010cdfe370a461e216ba1d724392 assignment_submission_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a68a7982922073b9602c0fd6097e0bd2 answer_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-e162432910d3b3b29b3c9711d6e818bb revision_review_questionnaire_spec.rb]

==== config ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-21497849d8f00507c9c8dcaf6288b136 routes.rb]

E1875 Revision Planning Tool

2018-12-14T02:39:28Z

Atewari:

== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.

 
== What needs to be done? ==
* Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
** A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
** One or more questions for every proposed improvement. Example:
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission

 
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.

 
== Motivation ==
The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

 
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.

 
== Implementation Plan ==
[[File:E1875UML.png]]
 
=== Files to be modified ===
==== Bookmark Rating Questionnaire ====
Bookmark Rating Questionnaire Controller Code[https://github.com/rahuliyer95/expertiza/blob/157553470c420bafc17413978dfccc0a89790dee/app/controllers/bookmark_rating_questionnaire_controller.rb#L4]

==== Questionnaire ====
* questionnaire_controller.rb
* questionnaire.rb
* author_review_questionnaire.rb ( doesn’t exist, needs to be created and named appropriately )
* questionnaires/*.erb
 
==== Submitted Content ====
* submitted_content_controller.rb
* submission_record.rb
 

=== UI mockups ===
The first image shows a mockup of what the Author will see on the submission page to submit new additional questions for review. 
[[File:E1875U1_1.jpg]] 
Second is a view of what the reviewer will see. It should blend in with the review questions submitted by the instructor for all similar projects. 
[[File:E1875UI_2.jpg]]
 
 
=== Test Plan ===
# Authors should be able to add additional review questions to their submission.
# Reviewers should be able to give feedback according to the review question written by the author.
# Authors should be able to view the feedback given on the questions they wrote.
# ''Stretch'': Instructors should be able to set requirements on the number of additional review questions authors are required to add.
 
== Files modified ==

==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a7ee7dddd7aedbc0b814d98f0cb34c25 grades_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-b41fa84d1ee0c03c4e301f977fbe453d questionnaires_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7786ab741930f6bace28b7e5da61b8d6 response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-33d668958529875af7029d78e37aff60 submitted_content_controller.rb]

==== Views ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-2213cf9074761b4121a9fb3ddcce6145 questionnaires/_questionnaire.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-6b83ba9473bd5cc58d3b7c620235a6c0 submitted_content/edit.html.erb]

==== Models ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a983bfc492e6d1982c673bc208afe459 answer.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3dffd0131e1a14847e8c98376bae4984 questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-85f51952994f8162980c605efd60db44 revision_review_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c6f2a3b3452f5a9effa4a2b023ed2322 submission_record.rb]

==== Database ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-c2ba560985d8d1ea9184e04d71bf2c83 20181123004154_add_submission_record_to_questionnaire.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-1acd2e7e27a227829d5d14a91c863bb6 schema.rb]

==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-ebb9ab8d49abf2b40d4aad426dad68e5 grades_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-df286dc963f50de24c47bacfb0b3a143 questionnaires_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-7d95010cdfe370a461e216ba1d724392 assignment_submission_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-a68a7982922073b9602c0fd6097e0bd2 answer_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-e162432910d3b3b29b3c9711d6e818bb revision_review_questionnaire_spec.rb]

==== config ====
* [https://github.com/expertiza/expertiza/pull/1302/files#diff-21497849d8f00507c9c8dcaf6288b136 routes.rb]

E1875 Revision Planning Tool

2018-11-13T20:23:06Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T20:22:23Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:50:44Z

Atewari:

== Revision History ==
 

{| class="wikitable"
|-
! Name
! Date
! Reason for change
! Version?
|-
| Amogh, Matt, Barrett, Rahul
| 12th November
| Design Outline, Initial Draft
| 0.1
|-
| Rahul
| 12th November
| Implementation Plan
| 0.2
|-
| Matt
| 13th November
| Edit, Reorganize Doc
| 0.3
|-
| Barret
| 13th November
| UI Mockup
| 0.4
|-
| Amogh
| 13th November
| Wiki Draft
| 0.5
|}

 
== What's it about? ==
In the first round of Expertiza reviews, we ask reviewers to give authors some guidance on how to improve their work. Then in the second round, reviewers rate how well authors have followed their suggestions. We could carry the interaction one step further if we asked authors to make up a revision plan based on the first-round reviews. That is, authors would say what they were planning to do to improve their work. Then second-round reviewers would assess how well they did it. In essence, this means that authors would be adding criteria to the second-round rubric that applied only to their submission. We are interested in having this implemented and used in a class so that we can study its effect.

 
== What needs to be done? ==
* Develop UI for authors to create new questions to add to the second round-rubric. This should be a form that includes the following:
** A description of the revision plan. Eg: We will add feature X to address issues a,b and c. We will modify feature Y and expect it to resolve errors d, c and e.
** One or more questions for every proposed improvement. Example:
*** How effectively did feature X address / solve issues a, b and c?
*** Did modification of feature Y resolve error d?
* Every new question must be linked to the second-round questionnaire.
* Every new question must be linked to the author’s submission

 
== Problem Statement ==
In the 2nd round of reviews, the Author should be able to add a statement to direct towards Author selected improvements from Round 1 to Round 2.

 
== Motivation ==
The OSS and Final projects are different for every team. From a reviewers perspective, not all questions make sense for all projects. The motivation behind this project is:
* Questions unique to each project gives the reviewers a perspective on the author’s objectives.
* Allow the Author to get feedback on whether or not they accomplished their self-directed goal.

 
== Criteria for completion ==
# Direct user to Revision Improvement Questionnaire.
# Create a form for a Assignment Team to add Questions to a Questionnaire that are specific to that Submission.
# Append Revision Improvement Questionnaire to 2nd Round Review Questionnaire.

 
== Implementation Plan ==
 
=== Files to be modified ===
==== Questionnaire ====
* questionnaire_controller.rb
* questionnaire.rb
* author_review_questionnaire.rb ( doesn’t exist, needs to be created and named appropriately )
* questionnaires/*.erb
 
==== Submitted Content ====
* submitted_content_controller.rb
* submission_record.rb
 
==== UI mockups ====
 
 
==== Test Plan ====
# Authors should be able to add additional review questions to their submission.
# Reviewers should be able to give feedback according to the review question written by the author.
# Authors should be able to view the feedback given on the questions they wrote.
# ''Stretch'': Instructors should be able to set requirements on the number of additional review questions authors are required to add.

E1875 Revision Planning Tool

2018-11-13T18:48:31Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:43:31Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:42:45Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:42:14Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:37:17Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:32:54Z

Atewari:

E1875 Revision Planning Tool

2018-11-13T18:32:38Z

Atewari: Created page with "== Revision History == {| class="wikitable" |- ! Name ! Date ! Reason for change ! Version? |- | Amogh, Matt, Barrett, Rahul | 12th November | Design Outline, Initial Draf..."

== Revision History ==


{| class="wikitable"
|-
! Name
! Date
! Reason for change
! Version?
|-
| Amogh, Matt, Barrett, Rahul
| 12th November
| Design Outline, Initial Draft
| 0.1
|-
| Rahul
| 12th November
| Implementation Plan
| 0.2
|-
| Matt
| 13th November
| Edit, Reorganize Doc
| 0.3
|-
| Barret
| 13th November
| UI Mockup
| 0.4
|-
| Amogh
| 13th November
| Wiki Draft
| 0.5
|}

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-09T01:06:38Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-ac62140c4e9c597ea8ac6d51d7f486c0 suggestion_controller_spec.rb]

== Test Plan ==

==== Sending mail to Instructor on creation of a new suggestion ====
 
[[File:Suggestion_controller_spec.jpg]] 
On creation of a new suggestion, a mail should be sent to the instructor. To establish this, we test whether the create suggestion method calls a mail_instructor method. Once the mail_instructor method is called, we test the mail_instructor method to have called the mailer with the correct parameters.

==== Option for instructor to receive copy of all emails ====
1. Create a new account as an instructor on the deployment. 
2. Log in as instructor. 
3. Got to profile page. 
4. Check the box that says 'Send me copies of all the emails'. 
5. Log in as 'student2064' with password 'password'. 
6. Trigger any action that may result in mail being sent to the student. 
7. Log in to instructor's email to check if copy of the same email has been received. 

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.png]] 
invitations_controller.rb

[[File:Karan_8.png]] 
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]] 
_invitation_accepted_html.html.erb 
_invitation_declined_html.html.erb 
_invitation_pending_html.html.erb 

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]] 
profile_controller.rb

[[File:Karan_11.jpg]] 
users_controller.rb

[[File:Karan_12.jpg]] 
delayed_mailer.rb

[[File:Karan_13.jpg]] 
mailer.rb

[[File:Karan_14.jpg]] 
user.rb

[[File:Karan_15.jpg]] 
_prefs.html.erb.rb

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-09T00:54:56Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-ac62140c4e9c597ea8ac6d51d7f486c0 suggestion_controller_spec.rb]

== Test Plan ==

==== Sending mail to Instructor on creation of a new suggestion ====

[[File:Suggestion_controller_spec.jpg]] 
On creation of a new suggestion, a mail should be sent to the instructor. To establish this, we test whether the create suggestion method calls a mail_instructor method. Once the mail_instructor method is called, we test the mail_instructor method to have called the mailer with the correct parameters.

==== Option for instructor to receive copy of all emails ====
1. Create a new account as an instructor on the deployment.
2. Log in as instructor.
3. Got to profile page.
4. Check the box that says 'Send me copies of all the emails'.
5. Log in as 'student2064' with password 'password'.
6. Trigger any action that may result in mail being sent to the student.
7. Log in to instructor's email to check if copy of the same email has been received.

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.png]] 
invitations_controller.rb

[[File:Karan_8.png]] 
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]] 
_invitation_accepted_html.html.erb 
_invitation_declined_html.html.erb 
_invitation_pending_html.html.erb 

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]] 
profile_controller.rb

[[File:Karan_11.jpg]] 
users_controller.rb

[[File:Karan_12.jpg]] 
delayed_mailer.rb

[[File:Karan_13.jpg]] 
mailer.rb

[[File:Karan_14.jpg]] 
user.rb

[[File:Karan_15.jpg]] 
_prefs.html.erb.rb

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-09T00:50:57Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Test Plan ==

==== Sending mail to Instructor on creation of a new suggestion ====

[[File:Suggestion_controller_spec.jpg]] 
On creation of a new suggestion, a mail should be sent to the instructor. To establish this, we test whether the create suggestion method calls a mail_instructor method. Once the mail_instructor method is called, we test the mail_instructor method to have called the mailer with the correct parameters.

==== Option for instructor to receive copy of all emails ====
1. Create a new account as an instructor on the deployment.
2. Log in as instructor.
3. Got to profile page.
4. Check the box that says 'Send me copies of all the emails'.
5. Log in as 'student2064' with password 'password'.
6. Trigger any action that may result in mail being sent to the student.
7. Log in to instructor's email to check if copy of the same email has been received.

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.png]] 
invitations_controller.rb

[[File:Karan_8.png]] 
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]] 
_invitation_accepted_html.html.erb 
_invitation_declined_html.html.erb 
_invitation_pending_html.html.erb 

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]] 
profile_controller.rb

[[File:Karan_11.jpg]] 
users_controller.rb

[[File:Karan_12.jpg]] 
delayed_mailer.rb

[[File:Karan_13.jpg]] 
mailer.rb

[[File:Karan_14.jpg]] 
user.rb

[[File:Karan_15.jpg]] 
_prefs.html.erb.rb

File:Suggestion controller spec.jpg

2018-11-09T00:48:54Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:56:51Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.jpg]] 
invitations_controller.rb

[[File:Karan_8.jpg]] 
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]] 
_invitation_accepted_html.html.erb 
_invitation_declined_html.html.erb 
_invitation_pending_html.html.erb 

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]] 
profile_controller.rb

[[File:Karan_11.jpg]] 
users_controller.rb

[[File:Karan_12.jpg]] 
delayed_mailer.rb

[[File:Karan_13.jpg]] 
mailer.rb

[[File:Karan_14.jpg]] 
user.rb

[[File:Karan_15.jpg]] 
_prefs.html.erb.rb

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:56:37Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.jpg]] 
invitations_controller.rb

[[File:Karan_8.jpg]] 
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]] 
_invitation_accepted_html.html.erb 
_invitation_declined_html.html.erb 
_invitation_pending_html.html.erb 

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]] 
profile_controller.rb

[[File:Karan_11.jpg]] 
users_controller.rb

[[File:Karan_12.jpg]] 
delayed_mailer.rb

[[File:Karan_13.jpg]] 
mailer.rb

[[File:Karan_14.jpg]] 
user.rb

[[File:Karan_15.jpg]] 
_pref.html.erb.rb

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:55:48Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]] 
response.rb

[[File:Karan_6.jpg]] 
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.jpg]]
invitations_controller.rb

[[File:Karan_8.jpg]]
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]]
_invitation_accepted_html.html.erb
_invitation_declined_html.html.erb
_invitation_pending_html.html.erb

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]]
profile_controller.rb

[[File:Karan_11.jpg]]
users_controller.rb

[[File:Karan_12.jpg]]
delayed_mailer.rb

[[File:Karan_13.jpg]]
mailer.rb

[[File:Karan_14.jpg]]
user.rb

[[File:Karan_15.jpg]]
_pref.html.erb.rb

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:55:14Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]]
response.rb

[[File:Karan_6.jpg]]
notify_grade_conflict_message.html.erb

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

[[File:Karan_7.jpg]]
invitations_controller.rb

[[File:Karan_8.jpg]]
mailer_helper.rb

==== Ad responses and invitations reported by e-mail ====
 
When a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. Three new files have been created to send e-mails to both the inviter and the invitee, the three files being accept, decline and pending. These three would be the responses of the invitations to join the team.

[[File:Karan_9.jpg]]
_invitation_accepted_html.html.erb
_invitation_declined_html.html.erb
_invitation_pending_html.html.erb

==== Option for the instructor to get a copy of emails being sent to the student ====
Any activity done on the assignment by a student can be viewed by the instructor. The instructor can make suggestions to the students. An e-mail could be sent by the instructor to the students regarding the activities done on the assignment. Now, the instructor has the option to choose to get all the e-mails that have been sent to the participants (students).

[[File:Karan_10.jpg]]
profile_controller.rb

[[File:Karan_11.jpg]]
users_controller.rb

[[File:Karan_12.jpg]]
delayed_mailer.rb

[[File:Karan_13.jpg]]
mailer.rb

[[File:Karan_14.jpg]]
user.rb

[[File:Karan_15.jpg]]
_pref.html.erb.rb

File:Karan 15.jpg

2018-11-02T21:49:25Z

Atewari:

File:Karan 14.jpg

2018-11-02T21:49:18Z

Atewari:

File:Karan 13.jpg

2018-11-02T21:49:11Z

Atewari:

File:Karan 12.jpg

2018-11-02T21:49:03Z

Atewari:

File:Karan 11.jpg

2018-11-02T21:48:54Z

Atewari:

File:Karan 10.jpg

2018-11-02T21:42:43Z

Atewari:

File:Karan 9.jpg

2018-11-02T21:42:33Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:30:07Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]]

[[File:Karan_6.jpg]]

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:29:49Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]]

[[File:Karan_6.jpg]]

==== E-mail to the invitee to join a team ====
 
Participants would require other participants to team up for a project. In such a case, a participant would invite another participant to join a team. Subsequently, an e-mail should be received to join the team. The e-mail should have the join request with it to join the group. It is important that the e-mail is received by the receiver when a participant student invites him.

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:27:12Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]]

[[File:Karan_5.jpg]]

[[File:Karan_6.jpg]]

==== E-mail to the invitee to join a team ====

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:26:00Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]] 
[[File:Karan_5.jpg]] 
[[File:Karan_6.jpg]]

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:23:07Z

Atewari:

This wiki page is for the description of changes made under E1831 OSS assignment for Fall 2018, CSC 517.

== About Expertiza ==
[https://expertiza.ncsu.edu/ Expertiza] is an open source project based on [https://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== What has been done previously ==
Students and instructors are notified of various events by e-mail, e.g., creation of a new account, submission of a review on their work, or updating of work that they have reviewed. This project is focused on adding new email functionalities.

== Problem Statement ==
* Issue [https://github.com/expertiza/expertiza/issues/296 #296]: Send out an email to the invitee when a participant sends out an invitation to another participant to join a team. The student who issued the invitation should also be e-mailed when the invitee joins the team. And also, when a student responds to a teammate advertisement, the person who created the advertisement must be notified by email. In general, all activity on ad responses and invitations should be reported to the other party by email (unless these emails are turned off in a (new) profile field).
* Notify an instructor by e-mail when a student suggests a topic.
* Issue [https://github.com/expertiza/expertiza/issues/87 #87]: Create an option (in the instructor’s profile) to get a copy of emails being sent to students.

== Files modified under in this project ==
==== Controllers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f186adbcad8c7d0322f09c6448128d3d profile_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4e05ad0d64e6100656b63ad1e78f32c5 users_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3f9708b6695fc195f497d7279229ce58 suggestions_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d4587f69e7597b0876f8bd8620e4b3a invitations_controller.rb]
==== Views ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-618b778ac502cdb33996e09307ea10f5 _invitation_accepted_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4cf05cb698ae8bf7d018d98d32ac91ef _invitation_declined_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-b469a046eb2ce24c8bcebe67e6213ce9 _invitation_pending_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-95a9a005ee228f1bdfa926dd7d2e6ed6 new_suggested_topic.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-a847769ab4f73b3b644c52acd4aa6430 notify_grade_conflict_message.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-589c871157f8b5486be75d6846db3861 _new_submission_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-806051e10c2e890dccd7687300dfddf9 _submission_deadline_test_html.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7ce11a3f8a2df2ad7295382fdd8f7909 _additional_links.html.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-7725211746ade7c4353148f9f91c9170 add.js.erb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-799a00b67bb0213bee389b71adaf4c7c _prefs.html.erb]
==== Mailers ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-6338cac8af5d0dac3dd6cf3183d97ce1 mailer_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9d59b3dd49f673876917117e94433d4e delayed_mailer.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-5354a099931d64748967998ea42d1fc1 mailer.rb]
==== Models ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-f2caf2e29f94ec94cb27bdb86ec85d40 response.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4676c008b11a5480d73d4a6de01e45b9 user.rb]
==== Database Migrations ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-9c48d33153eb16cc236ebf7318e77121 _add_copy_of_all_emails_flag_to_user.rb]
==== Specs ====
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-3a17ddf9d828caa60f11423f20fb88a9 factories.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-da946a02c81d553b070e087bcfb8051b login_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-4d891af414d69728e3576d12df5cfe45 due_date_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-0681f27c5662f797060be86cd862dd1f participant_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1237/files#diff-12b107c16792b9ecba685e51b51826f1 user_spec.rb]

== Solutions Implemented ==

==== Sending mail to Instructor on creation of a new suggestion ====
 

[[File:Mail_instructor_on_new_suggestion_2.jpg]] 
As part of the email that is to be sent to the instructor, an important piece of information is the proposer. When a suggestion is made by a student, they can choose to make the suggestion in anonymous mode. The function set_proposer within suggestions controller determines whether the user has checked anonymous suggestion and then assigns the user_id to the proposer. In case, the student has chosen to make an anonymous suggestion, the proposer variable is set as the string “Anonymous”.
 

[[File:Mail_instructor_on_new_suggestion_3.jpg]] 
To send the email, a mail_instructor function was created. This function requires the suggestion title, proposer, and the email of the receiver.
# The proposer is set using the set_proposer function.
# The suggestion title is passed through @suggestion.
# The assignment to which this suggestion is being made references to the instructor who created the assignment through instructor_id.
This function then calls new_suggested_topic function in the mailer.rb file to send the mail with the information.
 

[[File:Mail_instructor_on_new_suggestion_4.jpg]] 
The mailer.rb file also gets a new function new_suggested_topic referenced above.
 

[[File:Mail_instructor_on_new_suggestion_5.jpg]] 
The last change made to suggestions controller is calling the mail_instructor method in the create suggestion method. If the assignment references an instructor, the mail method is called on any suggestion being saved. The ‘if’ condition here is put in for a test condition where an assignment is created through the factories and this assignment does not reference an instructor.
 

[[File:Mail_instructor_on_new_suggestion_6.jpg]] 
The final change is the addition of a new file which contains the content and formatting of the mail being sent to the instructor.
 

==== Option for instructor to create a participant which does not exist ====
 

[[File:Karan_1.jpg]] 
The precondition here is that there is no participant and the instructor can add a non-existent participant. Further, a flash message is added when instructor adds a new participant. Instructor is forwarded to the user creation page by the corresponding link.
 

[[File:Karan_2.jpg]] 
User should have the provision to review projects. For that, the user needs to access the review page. A link has been added just for this purpose. The link would take the user to the respective review page.
 

[[File:Karan_3.jpg]] 
Link for submission deadline reminder
User should get a deadline reminder in e-mail once a deadline to review is nearing. Once a user gets a deadline reminder e-mail, the user could review a team then. Email should have the link to review a team.
 

==== Modifications made to the email that the instructor receives for contradicting reviews ====
 
More functionalities added to the e-mail that the instructor receives for contradicting reviews. The average scores of the total reviews done previously and the score of the new review are included in this. It looks so much better with the bullet points included, thus increasing the readability.
[[File:Karan_4.jpg]] 
[[File:Karan_5.jpg]] 
[[File:Karan_6.jpg]]

File:Karan 6.jpg

2018-11-02T21:22:59Z

Atewari:

File:Karan 5.jpg

2018-11-02T21:22:51Z

Atewari:

File:Karan 4.jpg

2018-11-02T21:22:43Z

Atewari:

File:Karan 3.jpg

2018-11-02T21:18:45Z

Atewari:

File:Karan 2.jpg

2018-11-02T21:16:46Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:14:15Z

Atewari:

File:Karan 1.jpg

2018-11-02T21:13:31Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T21:03:20Z

Atewari:

File:Mail instructor on new suggestion 6.jpg

2018-11-02T21:03:04Z

Atewari:

File:Mail instructor on new suggestion 5.jpg

2018-11-02T20:59:32Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T04:12:25Z

Atewari:

File:Mail instructor on new suggestion 4.jpg

2018-11-02T04:10:37Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T04:04:47Z

Atewari:

File:Mail instructor on new suggestion 3.jpg

2018-11-02T04:03:15Z

Atewari:

E1831 OSS Project Teal Email Notifications Enhancements

2018-11-02T04:00:44Z

Atewari: