Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-12-02T21:59:11Z

Ldu2: /* Important Links */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

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

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the '''instructor id''', '''assignment id''', '''student id''', '''grade''', '''comment''' and '''timestamp'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

[https://youtu.be/yyxX_kRYxLc Screencast]

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===
 
[[File:E2158_Proposed_Solution_1.png|1100px]]
 
 
[[File:E2158_Proposed_Solution_2.png|1100px]]
 
 
[[File:E2158_Proposed_Solution_3.png|1100px]]
 

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]
==== Review History Flow====
[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

==== Team History Flow====
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

For the feature part, test if the grading history and instructor can be shown in chronological order:

spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

=== Manual UI Tests ===
To start the test, we need to log in as instructor or TA first. These accounts should have access to the assignment. For example: we can use '''intructor6/password''' or '''teaching_assistant8631/password''';

==== Scenario 1: Grading histories of submissions ====
Step 1. Log in as instructor/TA -> Manage -> Assignments -> View submissions
 
[[File:E2158_view_submisson.png|1100px]]
 
 
Step 2. The instructor/TA can assign grades to a team by clicking 'Assign Grade' in the 'Team name' column:
 
[[File:E2158_grading_history_submisson1.png|1100px]]
 
 
Step 3. The instructor/TA can view the grading audit trail by clicking 'Grading History' in the 'History' column, here is the record page:
 
[[File:E2158_grading_history_submisson2.png|1100px]]
 
 
==== Scenario 2: Grading histories of reviews ====
Step 1. Log in as instructor/TA -> Manage -> Assignments -> View Reports
 
[[File:E2158_view_report.png|1100px]]
 
 
Step 2. Select 'Review Report' then click 'View', here is the Review Report page. The instructor/TA can assign grades to a review by inputing 'Grade' and 'Comment' then clicking 'Save' button:
 
[[File:E2158_grading_history_report1.png|1100px]]
 
 
Step 3. The instructor/TA can view the grading audit trail by clicking 'Grading History' as Step 2 figure shows, here is the record page:
 
[[File:E2158_grading_history_report2.png|1100px]]
 
 

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git Repo]
#[https://github.com/expertiza/expertiza/pull/2164 Pull Request]
#[https://www.youtube.com/watch?v=ad4wF6--5dQ Test1]
#[https://youtu.be/8PWD5gNQFog Test2]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2158. Grading audit trail

2021-11-09T08:34:34Z

Ldu2: /* Rspec Unit Tests */

== Problem Definition ==
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. Any instructor can assign/edit a grade freely. There is no way of tracking who did it.

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

The grading audit trail can probably be implemented as the submission records history on Expertiza.
The required page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the '''instructor id''', '''assignment id''', '''student id''', '''grade''', '''comment''' and '''timestamp'''.

== Previous Implementation ==

=== Links ===
[https://expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail Previous Wiki Page]

[https://youtu.be/yyxX_kRYxLc Screencast]

=== Review ===

:1. '''Review grade''' part in the previous implementation served well, we only need to fix some UI issues in the current implementation;
:2. But for '''Submission grade''' part, we need to add a table in order to save submission history including the instructor id, assignment id, student id, grade, comment, and timestamp.

=== Issues with Previous Work ===
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in smaller text below in the “Save” button.

:2. In the view grading record page, remove the receiver column and add it to the title.

:3. Restrict the column width on the grading record page.

:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues.

:5. Revert changes made to list_review_mapping.html.erb.

:6. Remove the review_report-html.erb file.

== Proposed Solution ==
=== Expected View ===

[[File:E2158_Proposed_Solution_1.png|1100px|center]]
[[File:E2158_Proposed_Solution_2.png|1100px|center]]
[[File:E2158_Proposed_Solution_3.png|1100px|center]]

=== History of Comment and Grade for Reviews ===

In this part, we will modify the current view of review page, to add the link "history" to a proper place as the expected design picture shows.

The related table from databases is [https://expertiza.csc.ncsu.edu/index.php/Review_scores review_scores]. The ER table of review_scores is shown as below.

[[File:Review scores imported.png]]
==== Review History Flow====
[[File:reviewhistory.png]]

=== History of Comment and Grade for Submissions===

In Expertiza, we find the fields related to grade and comment are located in the model '''team''', which is only able to be overwritten. Since there is no table to store the history of the comment and score given by instructors and TAs, we need to do:

:1. Review the related implementation of previous work in order to evaluate and understand the process of adding new models.

:2. Implement the related Model, View and Controller:

:* Model: grading_history.rb

:* Controller: grading_history_controller.rb

:* View: related pages.

Because in Expertiza the team ID will be generated for each given assignment, so the original design of grade / comment of team's submission are the field belongs to '''team'''. So our model uses the foreign key to only the team but not the related assignments or submissions.

The expected class of grading history could be shown as:

[[File:GradingHistory.png]]

==== Team History Flow====
[[File:teamhistory.png]]

== Testing Plan ==
=== Rspec Unit Tests ===
==== For History of the Grade of Reviews ====
The history of the grade and comments are related to this controller app/controllers/review_mapping_controller.rb and this view app/views/reports/_review_report.html.erb.

So the related RSpec tests are planned to be executed:

spec/controllers/review_mapping_controller_spec.rb

==== For History of the Grade of Team Submissions ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

spec/models/grading_history.rb
spec/controllers/grading_history_controller.rb

For the feature part, test if the grading history and instructor can be shown in chronological order:

spec/features/grade_histories_spec.rb
spec/features/helpers/grade_histories_helper.rb

=== Manual UI Tests ===
The new features of recording and showing the history of grades and comments of reviews and submissions will be manually tested after we finished the implementation of those functions.

:1. An assignment and a team will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
:2. An assignment and 3 teams will be generated, and at most 3 instructors / TAs will give grades for these situations:
1. For each team: 1 submission, 1 review, 1 grade and comment for submission, 1 grade and comment for review.
2. For each team: 1 submission, 2 review, 2 grade and comment for submission from different graders, 2 grade and comment for review from different graders.
...

We will generate some edge cases to test the robustness of our work.

== Important Links ==
#[https://github.com/duliwencynthia/expertiza/tree/beta Git path]
#[https://github.com/expertiza/expertiza/pull/2130 Pull Request]

== Team ==
'''Mentor:''' Xiao, Kai (yxiao28)

Yao, Kaiyong (kyao)

Hou, Guanyu (ghou3)

Du, Haoze (hdu5)

Du, Liwen (ldu2)

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:17:47Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end
def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end
####
def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end
####
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."
emails.each do |mail|
Rails.logger.info mail
end
Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now
end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments

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

Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.

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

Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment

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

Assign a valid due date and reminder hours

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

Then add the previous user login to it as a participant

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

Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:15:18Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments

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

Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.

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

Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment

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

Assign a valid due date and reminder hours

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

Then add the previous user login to it as a participant

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

Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:13:56Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments

[[File:manage_page.png|hight=250px]]

Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.

[[File:edit_assignment.png|hight=250px]]

Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment

[[File:create_assignment.png|hight=250px]]

Assign a valid due date and reminder hours

[[File:new_date.png|hight=250px]]

Then add the previous user login to it as a participant

[[File:add_participate.png|hight=250px]]

Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:12:01Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments

[[File:manage_page.png|high=50px]]

Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.

[[File:edit_assignment.png|high=50px]]

Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment

[[File:create_assignment.png|high=50px]]

Assign a valid due date and reminder hours

[[File:new_date.png|high=50px]]

Then add the previous user login to it as a participant

[[File:add_participate.png|high=50px]]

Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:11:18Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments

[[File:manage_page.png|high=100px]]

Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.

[[File:edit_assignment.png|high=100px]]

Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment

[[File:create_assignment.png|high=100px]]

Assign a valid due date and reminder hours

[[File:new_date.png|high=100px]]

Then add the previous user login to it as a participant

[[File:add_participate.png|high=100px]]

Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

File:Add participate.png

2021-10-25T02:11:00Z

Ldu2:

File:New date.png

2021-10-25T02:10:00Z

Ldu2:

File:Create assignment.png

2021-10-25T02:09:02Z

Ldu2: Ldu2 uploaded a new version of File:Create assignment.png

File:Edit assignment.png

2021-10-25T02:06:21Z

Ldu2: Ldu2 uploaded a new version of File:Edit assignment.png

File:Edit assignment.png

2021-10-25T02:06:18Z

Ldu2: Ldu2 uploaded a new version of File:Edit assignment.png

File:Edit assignment.png

2021-10-25T02:06:14Z

Ldu2: Ldu2 uploaded a new version of File:Edit assignment.png

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T02:03:38Z

Ldu2: /* Steps to verify Functionality */

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments
[[File:manage_page.png]]
Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.
[[File:2.png]]
Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment
[[File:3.png]]
Assign a valid due date and reminder hours
[[File:4.png]]
Then add the previous user login to it as a participant
[[File:5.png]]
Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

File:Manage page.png

2021-10-25T02:02:47Z

Ldu2:

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-25T01:59:45Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Pre-config==

We use delayed jobs library to deal with the delayed email.
We need run following command in order to install delayed_job binary executable.

rails generate delayed_job

Then we need to run

RAILS_ENV=development bin/delayed_job start

This will start a backend server to deal with the delayed jobs.
If we want to stop, just run following.

RAILS_ENV=development bin/delayed_job stop

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

'''2) Implement code:'''

# TODO E2135. Email notification to reviewers and instructors
def create_mailer_object
Mailer.new
end

def create_mailworker_object
MailWorker.new(self.parent_id, self.deadline_type, self.due_at)
end

# main function to start email reminder
def start_reminder
puts when_to_run_reminder
if self.changed?
@extra_param = self.parent_id.to_s + "," + self.deadline_type_id.to_s
# first deleted existed delayed jobs with same parent_id(which is assignment id actually)
Delayed::Job.where(extra_param: @extra_param).each do |job|
job.delete
end
# add a delayed job to the delayed job queue, the job will run at what when_to_run_reminder return
run_at_time = when_to_run_reminder
if run_at_time >= 0.seconds.from_now
self.delay(run_at: run_at_time, :extra_param => @extra_param).reminder
end
end
end

def reminder
deadline_text = self.deadline_type if %w[submission review].include? self.deadline_type
deadline_text = "Team Review" if self.deadline_type == 'metareview'
mail_worker = create_mailworker_object
email_reminder(mail_worker.find_participant_emails, deadline_text) unless mail_worker.find_participant_emails.empty?
end

def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.parent_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}. \
Deadline is #{self.due_at}.If you have already done the #{deadline_type}, Please ignore this mail."

emails.each do |mail|
Rails.logger.info mail
end

Mailer.delayed_message(bcc: emails, subject: subject, body: body).deliver_now

end

# after duedate - threshold hours, then we can send the reminder email
def when_to_run_reminder
hours_before_deadline = self.threshold.hours
result = (self.due_at.in_time_zone - hours_before_deadline).to_dateti

==Automated Testing using RSPEC==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Steps to verify Functionality==

*Test Email
Email: [expertiza_test123@outlook.com](mailto:expertiza_test123@outlook.com)
Password: password98@

*Test Expertiza account
name/login: Email_Test_ID1
password: password98@

1. Change the existing assignment's due date
First login in as instructor6, and go to Manage → Assignments
[[File:1.png]]
Then click change edit in the right side menu under **Actions**.
Go to Due dates and change the **reminder** and **Due & Time**, and click save.
[[File:2.png]]
Then you should receive email at expertiza_test123@outlook.com in the appropriate time. For this example,16 hours before 2021/10/25 04:08 (US Eastern time zone), the system shall send a reminder email to expertiza_test123@outlook.com.

2. Create a new assignment with valid due date
Create a new Assignment
[[File:3.png]]
Assign a valid due date and reminder hours
[[File:4.png]]
Then add the previous user login to it as a participant
[[File:5.png]]
Because the participants was added later, so we need to change the due date once more in order to trigger the email notification jobs.

==Additional Links==

*Git pull link: https://github.com/CuiJinku/expertiza/tree/beta
*VCL deployment: http://152.7.98.122:8080/

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-20T22:34:55Z

Ldu2:

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-20T22:28:23Z

Ldu2:

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-20T22:23:53Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment: http://152.7.98.122:8080/

==References==
#[ Expertiza on GitHub]
#[ GitHub Project Repository Fork]
#[ The live Expertiza website]
#[ Rspec Documentation]

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment:

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-20T19:35:42Z

Ldu2:

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment:

==References==
#[ Expertiza on GitHub]
#[ GitHub Project Repository Fork]
#[ The live Expertiza website]
#[ Rspec Documentation]

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment:

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

CSC/ECE 517 Fall 2021 - E2135 Email notification to reviewers and instructors

2021-10-20T19:29:26Z

Ldu2: 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 u..."

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment:

==References==
#[ Expertiza on GitHub]
#[ GitHub Project Repository Fork]
#[ The live Expertiza website]
#[ Rspec Documentation]

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]

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 the 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, websites, etc)[1]. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

<li> When an assignment or review approaches its deadline on Expertiza, students initially should receive deadline reminder emails at a specific time before the deadline that the instructor has preconfigured. Lack of this functionality sometimes results in students missing their assignment submission deadlines and thus losing marks. Students should receive this type of deadline reminder email. So this amendment to the project involves adding an asynchronous deadline reminder mailer to the application.

==Modified Files==
* app/models/due_date.rb
* test/models/due_date.rb
* db/migrate/20210319212323_create_delayed_jobs.rb

==Implementation approach==

'''1) Reminder email sent when assignment or review is approaching deadline:'''
In the due_date.rb file, whenever a new due date is created or an existing due date is updated, the 'start_reminder' method will be fired which will eventually be added to the delayed_job queue. This job will be executed at a preconfigured time before deadline, where it will fire the method 'reminder' which will be added to the delayed job queue by the handle_asynchronously method of gem 'delayed_job_active_record'. Inside the reminder method, we will fetch three attributes - assignment_id, deadline_type, due_at. These three attributes will be used to decide the deadline type ( submission or review or teammate review ), fetch the participant email for that assignment, fetch the deadline threshold and at the end send the email reminder at a specified threshold time before the deadline which will contain all the details such as assignment names link to assignment and assignment type ( submission or review or teammate review).

==Testing==

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the mail is enqueued upon the firing of the reminder method.

We have used Rspec for testing the delayed_job functionalities. Using the test-driven development (TDD) approach, we have added a Rspec test which checks whether the call for reminder method is enqueued upon the firing of the start_reminder method, with the proper scheduled execution time.

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

==Additional Links==

*Git pull link:
*VCL deployment:

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

==Team==
[mailto:dli35@ncsu.edu Dong Li] 
[mailto:ldu2@ncsu.edu Liwen Du] 
[mailto:jcui23@ncsu.edu Jinku Cui]