Expertiza_Wiki - User contributions [en]

E1934 - Grading Audit Trail

2019-04-26T20:12:42Z

Asivaga: /* Files to be Modified */

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We plan to create a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We will also need to modify grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

===Code Changes===

==Files to be Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/reports/_review_report.html.erb
'''
Add code to support view changes for Grade Record
'''

==Files to be Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/CSC/E1869_GRADING_AUDIT_TRAIL Previous Project Documentation]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

E1934 - Grading Audit Trail

2019-04-26T20:12:02Z

Asivaga: /* Previous Work */

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We plan to create a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We will also need to modify grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

===Code Changes===

==Files to be Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record
'''

==Files to be Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/CSC/E1869_GRADING_AUDIT_TRAIL Previous Project Documentation]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

E1934 - Grading Audit Trial

2019-04-07T23:58:43Z

Asivaga: /* Files Modified */

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We will create a database called grading_history in the system contains elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We also need to modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

=='''Actual Implementation'''==
===Actual View===
== The list submission page with the new "grade history" option==
[[File:E1869-Actual-1.JPG]]

== The Review Report page with the new "grade history" option==
[[File:E1869-Actual-3.png]]

== Grade history page for a given team(submission grade history)==
[[File:E1869-Actual-2.JPG]]

== Grade history for a given student(review grade history)==
[[File:E1869-Actual-4.png]]

===Code Changes===

==Files Modified==
*app/controllers/grades_controller.rb
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb
'''
Add code to support view changes for Grade Record
'''

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validaing Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

E1934 - Grading Audit Trial

2019-04-07T23:58:21Z

Asivaga: /* Files Added */

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We will create a database called grading_history in the system contains elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We also need to modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

=='''Actual Implementation'''==
===Actual View===
== The list submission page with the new "grade history" option==
[[File:E1869-Actual-1.JPG]]

== The Review Report page with the new "grade history" option==
[[File:E1869-Actual-3.png]]

== Grade history page for a given team(submission grade history)==
[[File:E1869-Actual-2.JPG]]

== Grade history for a given student(review grade history)==
[[File:E1869-Actual-4.png]]

===Code Changes===

==Files Modified==
*app/controllers/grades_controller.rb https://bit.ly/2Cg9WzR
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb https://bit.ly/2QywzZc
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb https://bit.ly/2UHNRkO
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb https://bit.ly/2GfTqUj
'''
Add code to support view changes for Grade Record
'''

==Files Added==

*app/controllers/grading_histories_controller.rb
'''
Calls the grading history view after validaing Submission and Review Type.

'''

*app/models/grading_history.rb
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

E1934 - Grading Audit Trial

2019-04-07T22:45:38Z

Asivaga: /* Testing Plan */

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We will create a database called grading_history in the system contains elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We also need to modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb

=='''Actual Implementation'''==
===Actual View===
== The list submission page with the new "grade history" option==
[[File:E1869-Actual-1.JPG]]

== The Review Report page with the new "grade history" option==
[[File:E1869-Actual-3.png]]

== Grade history page for a given team(submission grade history)==
[[File:E1869-Actual-2.JPG]]

== Grade history for a given student(review grade history)==
[[File:E1869-Actual-4.png]]

===Code Changes===

==Files Modified==
*app/controllers/grades_controller.rb https://bit.ly/2Cg9WzR
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb https://bit.ly/2QywzZc
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb https://bit.ly/2UHNRkO
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb https://bit.ly/2GfTqUj
'''
Add code to support view changes for Grade Record
'''

==Files Added==

*app/controllers/grading_histories_controller.rb https://bit.ly/2RY5xa6
'''
Calls the grading history view after validaing Submission and Review Type.

'''

*app/models/grading_history.rb https://bit.ly/2PHKNRY
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb https://bit.ly/2SPNR0e
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb https://bit.ly/2S5EI3J
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb https://bit.ly/2rDiZF1

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

E1934 - Grading Audit Trial

2019-04-05T21:05:52Z

Asivaga: Created page with "=='''Introduction'''== ===Problem Statement=== After an instructor gave a grade to an assignment, there is no way to track who gave the grade. A grading audit trail must be crea..."

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We will create a database called grading_history in the system contains elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We also need to modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb https://bit.ly/2EpJaGS

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb https://bit.ly/2LjM4OF

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb https://bit.ly/2PFLknz

=='''Actual Implementation'''==
===Actual View===
== The list submission page with the new "grade history" option==
[[File:E1869-Actual-1.JPG]]

== The Review Report page with the new "grade history" option==
[[File:E1869-Actual-3.png]]

== Grade history page for a given team(submission grade history)==
[[File:E1869-Actual-2.JPG]]

== Grade history for a given student(review grade history)==
[[File:E1869-Actual-4.png]]

===Code Changes===

==Files Modified==
*app/controllers/grades_controller.rb https://bit.ly/2Cg9WzR
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb https://bit.ly/2QywzZc
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb https://bit.ly/2UHNRkO
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb https://bit.ly/2GfTqUj
'''
Add code to support view changes for Grade Record
'''

==Files Added==

*app/controllers/grading_histories_controller.rb https://bit.ly/2RY5xa6
'''
Calls the grading history view after validaing Submission and Review Type.

'''

*app/models/grading_history.rb https://bit.ly/2PHKNRY
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb https://bit.ly/2SPNR0e
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb https://bit.ly/2S5EI3J
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb https://bit.ly/2rDiZF1

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2019

2019-04-05T21:05:44Z

Asivaga:

*[[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1916. Fix Code Climate issues in controllers with names beginning with A through N]]
*[[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]
*[[CSC/ECE 517 Spring 2019 - Project M1901 Implement missing WebAudio automation support]]
*[[CSC/ECE 517 Spring 2019 - Project E1917. Fix Code Climate issues in controllers with names beginning with P through Z]]
*[[CSC/ECE 517 Spring 2019 - Project E1921. Write tests for popup controller.rb]]
*[[CSC/ECE 517 Spring 2019 - M1902 Refactor bluetooth support for better maintainability]]
*[[CSC/ECE 517 Spring 2019 - E1922. Write tests for assessment360 controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1907 Refactor response controller]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1903._Create_quiz_questionnaires_controller.rb]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1913. Refactor_review_mapping_helper.rb]]
*[[CSC/ECE_517_Spring_2019_-_E1919_CodeClimate_Issues]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1912. Export_Tagged_Comments]]
*[[CSC/ECE_517_Spring_2019/E1927_Let_Course_Staff_as_Well_as_Students_Do_Reviews]]
*[[E1911_Refactor_Criterion]]
*[[E1934 - Grading Audit Trial]]

Grading Audit

2019-04-05T21:03:52Z

=='''Introduction'''==

===Problem Statement===
After an instructor gave a grade to an assignment, there is no way to track who gave the grade.
A grading audit trail must be created and the following information needs to be stored:
:1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
:2. Comments previously provided by other instructors must also be preserved.

This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:
:1. '''Review grade''': Log in as instructor -> Manage -> Assignments -> View Review Report
:2. '''Submission grade''': Log in as instructor -> Manage -> Assignments -> View submissions

=='''Proposed Solution'''==

===Design===
We will create a database called grading_history in the system contains elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.

We will use MVC design to create a model, a controller, and a view for both of '''Review Grade''' and '''Submission Grade'''.

:Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
:Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
:View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.

We also need to modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.

===Expected View===

==== The list submission page with the new "grade history" option====
[[Image: E1869-Screenshot-1.jpg|50]]

==== The review report page with the new "grade history" option====
[[File:E1869-Screenshot-2.jpg]]

==== Grade history for a given team====
[[File:E1869-Screenshot-3.jpg]]

===Diagram===
[[File:E1869_Grading_Audit_Trails_UML.jpg]]

=='''Testing Plan'''==

Functional testing:

1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb https://bit.ly/2EpJaGS

2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb https://bit.ly/2LjM4OF

3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb https://bit.ly/2PFLknz

=='''Actual Implementation'''==
===Actual View===
== The list submission page with the new "grade history" option==
[[File:E1869-Actual-1.JPG]]

== The Review Report page with the new "grade history" option==
[[File:E1869-Actual-3.png]]

== Grade history page for a given team(submission grade history)==
[[File:E1869-Actual-2.JPG]]

== Grade history for a given student(review grade history)==
[[File:E1869-Actual-4.png]]

===Code Changes===

==Files Modified==
*app/controllers/grades_controller.rb https://bit.ly/2Cg9WzR
'''
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
'''

*app/controllers/review_mapping_controller.rb https://bit.ly/2QywzZc
'''

Creates a Grading History Record for every Review grade edited by the instructor for a Student.
'''

* app/views/assignments/list_submissions.html.erb https://bit.ly/2UHNRkO
'''
Add code to support view changes for Grade Record
'''

* app/views/review_mapping/_review_report.html.erb https://bit.ly/2GfTqUj
'''
Add code to support view changes for Grade Record
'''

==Files Added==

*app/controllers/grading_histories_controller.rb https://bit.ly/2RY5xa6
'''
Calls the grading history view after validaing Submission and Review Type.

'''

*app/models/grading_history.rb https://bit.ly/2PHKNRY
'''
Model for Grading History.
'''

*app/models/review_grading_history.rb https://bit.ly/2SPNR0e
'''
Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb https://bit.ly/2S5EI3J
'''
Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb https://bit.ly/2rDiZF1

'''
This is a view for grading audit trail, it will display all grading histories of a submission/review
'''

=='''Reference'''==
[https://expertiza.ncsu.edu/ Expertiza]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2019

2019-04-05T21:03:17Z

Asivaga:

E1902 ahp project

2019-04-02T17:06:03Z

Asivaga: /* Additional Links */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

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

==Testing==

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student. We have created a new assignment_particpant_ spec file for the above purpose.The spec uses double and stub features of rspec gem to fake user login. Since the smtp setting are set to test mode all mails go to expertiza.development@gmail.com and not the actual user.Hence when an email is sent the ActionMailer::Base.deliveries list gets updated.The last element in the deliveries list will be the email that was sent when the import method was invoked. Then using expect object we verify whether the email was correctly sent by checking the subject, from and to field.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-31T16:44:05Z

Asivaga: /* Testing */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

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

==Testing==

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student. We have created a new assignment_particpant_ spec file for the above purpose.The spec uses double and stub features of rspec gem to fake user login. Since the smtp setting are set to test mode all mails go to expertiza.development@gmail.com and not the actual user.Hence when an email is sent the ActionMailer::Base.deliveries list gets updated.The last element in the deliveries list will be the email that was sent when the import method was invoked. Then using expect object we verify whether the email was correctly sent by checking the subject, from and to field.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385
*Heroku deployment: yet to be done

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-31T16:41:32Z

Asivaga: /* Implementation approach */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

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

==Testing==

Yet to be done

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385
*Heroku deployment: yet to be done

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-26T23:09:39Z

Asivaga: /* Implementation approach */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :''' - Completed

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

'''2) Sending email to reviewer when new submission is availble:''' Halfway

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

'''3) Including a specific link for the deadline reminders email functionality for reviewers :''' - Halfway

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

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

==Testing==

Yet to be done

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385
*Heroku deployment: yet to be done

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-26T23:08:58Z

Asivaga: /* Implementation approach */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :''' - Completed

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

'''2) Sending email to reviewer when new submission is availble:''' Halfway

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

'''3) Including a specific link for the deadline reminders email functionality for reviewers :''' - Halfway

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

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

==Testing== Yet to be done

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385
*Heroku deployment: yet to be done

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-26T01:15:03Z

Asivaga: /* Implementation approach */

E1902 ahp project

2019-03-26T01:14:15Z

Asivaga: /* Implementation approach */

E1902 ahp project

2019-03-26T01:08:52Z

Asivaga:

E1902 ahp project

2019-03-25T18:58:07Z

Asivaga: /* Additional Links */

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

https://github.com/expertiza/expertiza/commit/c17bb25827e43940cc9f253c04ee7343878298df

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

https://github.com/expertiza/expertiza/commit/e09761b7d8746f26485f264c7fd7936b8d956326#diff-ab934619c8e13cc78f27fbc38461a25b

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

https://github.com/expertiza/expertiza/commit/e9de954591975724e3dc549144185c00c7e5b0dd#diff-33d668958529875af7029d78e37aff60

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-a0169176ac373c3a8222d8cba5acdac0

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

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1385
*Heroku deployment: yet to be done

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-25T18:56:38Z

Asivaga:

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

https://github.com/expertiza/expertiza/commit/c17bb25827e43940cc9f253c04ee7343878298df

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

https://github.com/expertiza/expertiza/commit/e09761b7d8746f26485f264c7fd7936b8d956326#diff-ab934619c8e13cc78f27fbc38461a25b

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

https://github.com/expertiza/expertiza/commit/e9de954591975724e3dc549144185c00c7e5b0dd#diff-33d668958529875af7029d78e37aff60

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-a0169176ac373c3a8222d8cba5acdac0

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

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1253
*VCL deployment: http://152.46.18.165:8080/

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-23T15:29:16Z

Asivaga:

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

https://github.com/expertiza/expertiza/commit/c17bb25827e43940cc9f253c04ee7343878298df

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

https://github.com/expertiza/expertiza/commit/e09761b7d8746f26485f264c7fd7936b8d956326#diff-ab934619c8e13cc78f27fbc38461a25b

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

https://github.com/expertiza/expertiza/commit/e9de954591975724e3dc549144185c00c7e5b0dd#diff-33d668958529875af7029d78e37aff60

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-a0169176ac373c3a8222d8cba5acdac0

==Testing==

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

We have created a new assignment_particpant_ spec file for the above purpose.The spec uses double and stub features of rspec gem to fake user login.
Since the smtp setting are set to test mode all mails go to expertiza.development@gmail.com and not the actual user.Hence when an email is sent the
ActionMailer::Base.deliveries list gets updated.The last element in the deliveries list will be the email that was sent when the import method was invoked.
Then using expect object we verify whether the email was correctly sent by checking the subject, from and to field.

https://github.com/expertiza/expertiza/commit/3c17dd70fcdc39e0600ad01a5953bb8adf007ffd#diff-33bbfe50bc35527232a815c6492d8fb4

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

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1253
*VCL deployment: http://152.46.18.165:8080/

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-18T21:49:00Z

Asivaga:

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

https://github.com/expertiza/expertiza/commit/c17bb25827e43940cc9f253c04ee7343878298df

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

https://github.com/expertiza/expertiza/commit/e09761b7d8746f26485f264c7fd7936b8d956326#diff-ab934619c8e13cc78f27fbc38461a25b

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

https://github.com/expertiza/expertiza/commit/e9de954591975724e3dc549144185c00c7e5b0dd#diff-33d668958529875af7029d78e37aff60

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-a0169176ac373c3a8222d8cba5acdac0

'''Bonus Functionality Implemented below:-'''

'''4) Including a specific link for the deadline reminders email functionality for submissions :'''

Added a submission_reminder_email method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the submission.
Prepared a hash named emails in the function find_team_members_email using the email and team_member_id, for each participant who is a team member.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e submission), we fetch the participant_id of the same and add it as the suffix in the URL to be visited by the team member.

https://github.com/pratik-abhyankar/expertiza/commit/0a2af1a67eea4717e0e10974fba0df134aa67bf1#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
for the assign_type="submission", we fetch the assign.id which is to be passed as the suffix to the url to be sent in the mail for submission reminder.
The team members can click on this link in the email and get redirected to the submission page of the particular asssignment.

https://github.com/pratik-abhyankar/expertiza/commit/0a2af1a67eea4717e0e10974fba0df134aa67bf1#diff-a0169176ac373c3a8222d8cba5acdac0

==Testing==

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

We have created a new assignment_particpant_ spec file for the above purpose.The spec uses double and stub features of rspec gem to fake user login.
Since the smtp setting are set to test mode all mails go to expertiza.development@gmail.com and not the actual user.Hence when an email is sent the
ActionMailer::Base.deliveries list gets updated.The last element in the deliveries list will be the email that was sent when the import method was invoked.
Then using expect object we verify whether the email was correctly sent by checking the subject, from and to field.

https://github.com/expertiza/expertiza/commit/3c17dd70fcdc39e0600ad01a5953bb8adf007ffd#diff-33bbfe50bc35527232a815c6492d8fb4

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

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1253
*VCL deployment: http://152.46.18.165:8080/

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:asivaga@ncsu.edu Arjun Sivagaminathan Mathan Kumar] 
[mailto:hbbadiya@ncsu.edu Harshit Badiyani] 
[mailto:panumul@ncsu.edu Pranav Reddy Anumula]

E1902 ahp project

2019-03-18T21:46:02Z

Asivaga: Created page with "This page provides a description of the Expertiza based OSS project. __TOC__ ==About Expertiza== [http://expertiza.ncsu.edu/ Expertiza] is an open source project developed usin..."

This page provides a description of the Expertiza based OSS project.
__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using Ruby on Rails framework.Expertiza allows the instructor to create new assignments and customize new or existing assignments.The application allows students to submit and peer-review learning objects (articles, code, web sites, etc)[1].Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

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

==Modified Files==
* app/models/assignment_participant.rb
* app/models/assignment.rb
* app/models/course_participant.rb
* app/controllers/submitted_content_controller.rb
* app/mailers/delayed_mailer.rb
* lib/tasks/background_email_reminder.rake
* spec/models/assignment_particpant_spec.rb

==Implementation approach==

'''1) Email sent when user is added as a participant to assignment :'''

When students' accounts are created by importing a CSV file on the Users page,they receive e-mails but not when user was added as a participant to the assignment. We added a method in the assignment_participant.rb file (model) to send mails when a participant is added to an assignment on the assignment page by importing a CSV file. We have also added a method in the course_participant.rb file(model), to send the mail when a Course participant is added by importing a CSV file. Both functionalities are implemented using the method from the MailerHelper class i.e send_mail_to_user().

https://github.com/expertiza/expertiza/commit/c17bb25827e43940cc9f253c04ee7343878298df

'''2) Sending email to reviewer when new submission is availble:'''

Added functionality to send email to the reviewer when new submission is available by making changes in the submitted_content_controller and assignment_participant model.The method handled boundary constraints like checking whether the round was valid and disabling email notification after the last round of review.

Code to check if it was the valid round

In the assignment_participant.rb,
Firstly, fetched the topic_id from the SignedUpTeam class and got the next due date using the DueDate model
Finally compared the round of the Due date with the number of review rounds of the assignments, to verify if its the final round.

https://github.com/expertiza/expertiza/commit/e09761b7d8746f26485f264c7fd7936b8d956326#diff-ab934619c8e13cc78f27fbc38461a25b

Extra functionality of specifying the current review round and providing the direct link to reviewer in the mail itself also implemented in the submitted_content controller using the ReviewResponseMap and Response class.

In the submitted_content_controller.rb,
We mapped the reviewer_id and reviewee_id, fetched from participants, using the ReviewResponseMap class.
For all such mappings retrieved, we are fetching the last response id, which is then passed as the URL suffix to redirect the reviewer to the appropriate page.

https://github.com/expertiza/expertiza/commit/e9de954591975724e3dc549144185c00c7e5b0dd#diff-33d668958529875af7029d78e37aff60

'''3) Including a specific link for the deadline reminders email functionality for reviewers :'''

Added a review_reminder_email method and mail_reviewers method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the specific task.
Prepared a hash named email_list using the email and participant_id, for each participant who is a reviewer.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e reviewer), we fetch the participant id of the same and add it as the suffix in the URL to be visited by the reviewer.
Also, the logic of the copy of mail to the instructor is also taken care.
Notice that the link in the instructor's email will contain the '?id=' field of the last participant fetched.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
Earlier only the emails for the participants were fetched, but now we are fetching the hash containing the email and response_id. The response_id field was fetched as per the below order in the code-
participants.review_mappings -> allresponsemaps -> eachresponsemap -> response.
For the reviewer assign_type, we have defined a separate method send_reminder_emails(), wherein we pass the response_id of the email_list hash, and add it as a suffix in the URL which will be accessed by the reviewer.

https://github.com/expertiza/expertiza/commit/95476252c1e44f7262ba76993414bdb3ab76c64a#diff-a0169176ac373c3a8222d8cba5acdac0

'''Bonus Functionality Implemented below:-'''

'''4) Including a specific link for the deadline reminders email functionality for submissions :'''

Added a submission_reminder_email method in the delayed_mailer.rb file which implemented the functionality for sending deadline reminder mails which includes a link on where to go and perform the submission.
Prepared a hash named emails in the function find_team_members_email using the email and team_member_id, for each participant who is a team member.
Using this hash, we are calling the review_reminder_email function.
In this function, based on the due date for the deadline_type(i.e submission), we fetch the participant_id of the same and add it as the suffix in the URL to be visited by the team member.

https://github.com/pratik-abhyankar/expertiza/commit/0a2af1a67eea4717e0e10974fba0df134aa67bf1#diff-9d59b3dd49f673876917117e94433d4e

In the background_email_reminder.rake file,
for the assign_type="submission", we fetch the assign.id which is to be passed as the suffix to the url to be sent in the mail for submission reminder.
The team members can click on this link in the email and get redirected to the submission page of the particular asssignment.

https://github.com/pratik-abhyankar/expertiza/commit/0a2af1a67eea4717e0e10974fba0df134aa67bf1#diff-a0169176ac373c3a8222d8cba5acdac0

==Testing==

We have used Rspec for testing the email functionalities.Using the test driven development(TDD) approach, we have added an Rspec test which checks whether the mail is delivered to the expected receiver upon creation of the account for the student.

We have created a new assignment_particpant_ spec file for the above purpose.The spec uses double and stub features of rspec gem to fake user login.
Since the smtp setting are set to test mode all mails go to expertiza.development@gmail.com and not the actual user.Hence when an email is sent the
ActionMailer::Base.deliveries list gets updated.The last element in the deliveries list will be the email that was sent when the import method was invoked.
Then using expect object we verify whether the email was correctly sent by checking the subject, from and to field.

https://github.com/expertiza/expertiza/commit/3c17dd70fcdc39e0600ad01a5953bb8adf007ffd#diff-33bbfe50bc35527232a815c6492d8fb4

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

==Additional Links==

*Git pull link: https://github.com/expertiza/expertiza/pull/1253
*VCL deployment: http://152.46.18.165:8080/

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://relishapp.com/rspec Rspec Documentation]

==Team==
[mailto:ahshah4@ncsu.edu Aditya Shah] 
[mailto:ananava@ncsu.edu Ankit Nanavaty] 
[mailto:paabhyan@ncsu.edu Pratik Abhyankar]