Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:29:47Z

Tmpandi2: /* Outcome */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

''' Flowchart:'''

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Capybara Tests ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

This method calls the email function to notify the reviewee
[[File:Reviewee2.PNG|center|border]]
 

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:28:54Z

Tmpandi2: /* References */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

''' Flowchart:'''

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

This method calls the email function to notify the reviewee
[[File:Reviewee2.PNG|center|border]]
 

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:26:23Z

Tmpandi2: /* Scenario 2: Resetting Password */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

''' Flowchart:'''

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====

If the email id is not associated with any existing account, then email count will be zero

[[File:Reset negative.PNG|center|border]]

If the email id is associated with an existing account, then email count will be one

[[File:Reset positive.PNG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewee2.PNG|center|border]]
 

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:12:19Z

Tmpandi2: /* IV. Reviewer gets mail when authors resubmit work */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== Scenario 4. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:09:28Z

Tmpandi2: /* III. Authors get mail on receiving review */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Scenario 3. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T06:07:58Z

Tmpandi2: /* II. Resetting Password */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

Instructor creates new user by filling sign-up form
[[File:Instructor create.PNG|center|border]]

*User creation by user request 

Email count should be zero when user requests new account with an invalid email
[[File:User request1.PNG|center|border]]

Email count should be one when user requests new account with a valid email
[[File:User request2.PNG|center|border]]

*User creation by importing csv files 

Import CSV to add participants to assignment
[[File:User request3.PNG|center|border]]

Import CSV from manage users
[[File:User request4.PNG|center|border]]

===Scenario 2: Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
#No e-mail should be sent
*User enters email id that's present in the user database 
The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Capybara Tests ====

We used Capybara to model the scenario with following steps: 
#Visit expertiza home page 
#Click 'Forgot password?' link 
#After rediection to password retrieval page 
#Fill in user email field with 'expertiza@mailinator.com' 
#Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:49:40Z

Tmpandi2: /* I. Creating a new user Account */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== Scenario 1: Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

*By filling a user creation form
An instructor can add a new user to the system by filling up a user creation form

*By importing a CSV file
The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

*By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

*User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 
==== Capybara Tests ====
We used Capybara to model the scenario as follows: 
*''' Create user through instructor filling up the form:''' 
Admin user is created using factory class. 
#Visit expertiza 
#Login_as 'admin_user' 
#Visit list of users 
#Click New User link 
#Fill user_name with 'teststudent' 
#Fill user_fullname with 'test student' 
#Fill user_email with 'test@student.com' 
#Check checkbox to send email to user on review 
#Click 'Create' button. 
 
*''' User requests a new account and account is created upon approval from superadmin''' 
Super admin is created using factory class. 
#Visit expertiza 
#Click Request Account link 
#Select instructor from dropdown 
#Fill user name with 'requester1' 
#Fill user fullname with 'requester1, requester1' 
#Fill user email with 'test.com' 
#Fill user_email with 'test@student.com' 
#Select 'North Carolina State University' from user institution 
#Click 'Create' button. 
#Visit list of pending requests from users 
#Requested user's status is first 'Under Review' 
#Set status as Approved or Rejected 
#Click on 'Submit' button 

==== Code Snippet ====
*User creation by instructor: 

[[File:Instructor create.PNG|center|border]]

*User creation by user request 

[[File:New_user_2.JPG|center|border]]

[[File:New_user_3.JPG|center|border]]

*User creation by importing csv files 

[[File:New_user_assignment.JPG|center|border]]

[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:22:25Z

Tmpandi2: /* Approach Chosen and Why? */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:Instructor create.PNG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:21:36Z

Tmpandi2: /* Problem Statement and Background */

== Problem Statement and Background ==
Expertiza system facilitates sending emails to students and instructors on occurrence of various events or helps in taking actions on the events that occur..

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to be reviewed.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:11:30Z

Tmpandi2: /* Problem Statement */

== Problem Statement and Background ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T05:11:05Z

Tmpandi2: /* Expertiza Background */

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

'''We have implemented tests for the following scenarios:'''

=== I. Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

'''The following features were checked for all cases as part of the email functionality when a new user is created'''
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

'''I. create user through instructor filling up the form:''' 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

'''II. user requests a new account and account is created upon approval from superadmin''' 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

===II. Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== III. Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== IV. Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix_2.JPG|center|border]]
 
[[File:Reviewer_fix.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====
[[File:Reviewer_fix_3.JPG|center|border]]
 
[[File:Reviewer_fix_4.JPG|center|border]]

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:56:11Z

Tmpandi2: /* Author Review */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#An account holder is emailed when a new account is created.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
In this project we have first identified all the set of scenarios where the user of the system will get an email. Each of the four scenarios are identified as mentioned above and has been subdivided into a number of ways in which it can be realized. This will ensure that each of the mailers will be robust to any kind of unexpected changes and that the functionality will not be broken when deployed in production. We have chosen to bring about this robustness of test by writing unit test and functional tests using RSpec and Capybara respectively. Unit Tests will ensure that the particular functionality is being tested in a isolated setup which would even include the edge cases whereas the functional tests will ensure that this mailing feature is in resonance with the other features and works coherently.

== Implementation ==

=== Creating a new user Account===

There are various ways to create a new user account in Expertiza. Irrespective of the user creation method, the newly added user should get notified via email when his account is created in the system. This email states the username and a randomized password to allow the user to login for the first time.
Below given are the ways to create new user to system.

1. By filling a user creation form

An instructor can add a new user to the system by filling up a user creation form

2. By importing a CSV file

The instructor can add new users to the system by importing a CSV file with user information

[[File:Fc-3.PNG|center|border]]

3. By importing a CSV file to add participants to an assignment

Instructor can add participants to an assignment by importing the users from a CSV. If the user listed in the CSV does not already exist in the system, then the a new user account is created and the user is added to the assignment.

[[File:Fc-1.PNG|center|border]]

4. User requests an account

A user can request an account by filling up a form with his details. These details get saved in the requested users table. Also, the super administrator will see these details in his pending requests section. The superadmin can approve/reject such requests.
If the superadmin approves a request, a new user account is created in the system and the user receives an account creation email notification

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====

The following features were checked as part of the email functionality when a new user is created
# Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
# Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
# Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since the default recipient is 'expertiza.development@gmail.com' in test environment. 
# The subject is checked to be equal to 'Your Expertiza account and password has been created' 

We considered the following cases while testing specific to the scenario where user requests an account: 
#No email should be sent if new account requested with invalid email address 
#Super admin should receive email about new account request with a valid email address 
#Email notification should be sent to requester when super admin approves account creation request 
#No email notification should be sent to requester when super admin rejects account creation request 
 

==== Capybara Tests ====
We used Capybara to model the scenario as follows: 

I. create user through instructor filling up the form: 

Admin user is created using factory class. 
1.visit expertiza 

2.login_as 'admin_user' 

3.visit list of users 

4.click New User link 

5.fill user_name with 'teststudent' 

6.fill user_fullname with 'test student' 

7.fill user_email with 'test@student.com' 

8.check checkbox to send email to user on review 

9.click 'Create' button. 

 

II. user requests a new account and account is created upon approval from superadmin 

super admin is created using factory class. 

1.visit expertiza 

2.click Request Account link 

3.select instructor from dropdown 

4.fill user name with 'requester1' 

5.fill user fullname with 'requester1, requester1' 

6.fill user email with 'test.com' 

7.fill user_email with 'test@student.com' 

8.select 'North Carolina State University' from user institution 

9.click 'Create' button. 

10.visit list of pending requests from users 

11.Requested user's status is first 'Under Review' 

12.Set status as Approved or Rejected 

13.click on 'Submit' button 

==== Code Snippet ====
user creation by instructor: 
[[File:New_user.JPG|center|border]]
user creation by user request 
[[File:New_user_2.JPG|center|border]]
[[File:New_user_3.JPG|center|border]]
user creation by importing csv files 
[[File:New_user_assignment.JPG|center|border]]
[[File:New_user_import_file.JPG|center|border]]

=== Resetting Password ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====
*User enters email id which is not associated with any account 
**No e-mail should be sent
*User enters email id that's present in the user database 
**The following features were checked inside 'it blocks' as part of verifying email functionality 
#Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
#The sender mail-id is verified to be 'expertiza.development@gmail.com' 
#Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
#The subject is checked to be equal to 'Expertiza password reset' 
 

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. Visit expertiza home page 
2. Click 'Forgot password?' link 
3. After rediection to password retrieval page 
4. Fill in user email field with 'expertiza@mailinator.com' 
5. Click on 'Request password' button 
 

==== Code Snippet ====
[[File:Reset_password.JPG|center|border]]

=== Authors get mail on receiving review ===

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

=== Reviewer gets mail when authors resubmit work ===
This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

== Fixing out of scope bugs ==
=== Account Creation ===
When student accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password.
However, if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail notification is not being sent.

==== What we fixed ====
The issue here was that an already existing user in the system will not get added as a participant on the assignment.

We fixed the issue by creating a new user if one doesn't exist and we enabling the email functionality by adding the .deliver_now method

This method invokes the mailer to deliver an email immediately.

Now that we have enabled the email functionality irrespective of where a new user is created from, we don't need to explicitly call the mailer from each location where new user is created. The email body was inconsistent across different scenarios. We had fixed this as well.

==== Outcome ====
If the user does not exist in the system, new user account (if there is sufficient information about the user to create a new Expertiza account) is created

If the user already exists as a participant on the assignment, do nothing Add the user to the assignment as a participant; otherwise.

This way, the user(whether newly created or already an Expertiza user) gets added on the assignment as a participant.

==== Code Snippet ====
[[File:Email_fix.JPG]]

[[File:BadgerAddParticipant2.PNG]]

=== Author should receive email notification upon review submission ===
After the reviewer submits the review, the author should get an email notification about this. Also, the instructor should receive an email about the same. This function is not currently working in the beta version.
==== What we fixed====
We have added a new method named send_email_to_reviewee which will trigger an email to the author. The function call to this method is added to the 'update' and 'create' methods of Response Controller that will be called on submission/updation of review
==== Code Snippet ====

[[File:Reviewer_fix.JPG|center|border]]

[[File:Reviewer_fix_2.JPG|center|border]]

[[File:Reviewer_fix_3.JPG|center|border]]

[[File:Reviewer_fix_4.JPG|center|border]]

=== Reviewer will receive an email notification upon resubmission of the work by the author ===
For the assignments which have multiple submission rounds, after review round if the author changes the work, the reviewer should be notified of this change. Also, if at all the author resubmits the work, the reviewer as well as the instructor should get an email about the change that was done. This is not currently functional in expertiza beta. As discussed with our mentor, we have successfully fixed that issue and now in both of the cases as discussed above, the intended users( author in first scenario and reviewer and instructor in second one) are receiving the email notification.

==== What we fixed====
We have added a new method 'email_all_reviewers' to submitted_content_controller which will send an email to all the reviewers of the work.

==== Code Snippet ====

== Our Team ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Demo link

Expertiza on GitHub [https://github.com/expertiza/expertiza click here]

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T04:21:08Z

Tmpandi2: /* Author Review */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:10:03Z

Tmpandi2: /* Outcome */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:09:21Z

Tmpandi2: /* Outcome */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:07:56Z

Tmpandi2: /* Cases Tested */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:04:39Z

Tmpandi2: /* Resetting Password */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:03:20Z

Tmpandi2: /* Cases Tested */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T02:02:39Z

Tmpandi2: /* Cases Tested */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T01:55:50Z

Tmpandi2: /* Scenario 4 */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T01:54:58Z

Tmpandi2: /* Results */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T01:47:48Z

Tmpandi2:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T01:40:25Z

Tmpandi2:

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T00:32:24Z

Tmpandi2: /* Cases Tested */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T00:31:40Z

Tmpandi2: /* Cases Tested */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T00:28:08Z

Tmpandi2: /* Scenario 3 */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T00:04:11Z

Tmpandi2: /* References */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-07T00:01:54Z

Tmpandi2: /* Proposed Approach */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:45:37Z

Tmpandi2: /* Approach Chosen and Why? */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:44:35Z

Tmpandi2: /* Approach Chosen and Why? */

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:06:51Z

Tmpandi2: /* Team */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user in scenario i and scenario ii 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We implemented scenario iii using rspec unit tests: 
1.
2.
3.
4.
 

==== Outcome ====
==== Code Snippet ====

=== Scenario 5 ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====

The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
-- result x test cases passed image --
 

==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Developed By ==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)

== References ==

Expertiza on GitHub

GitHub Pull Request

demo link

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:06:28Z

Tmpandi2: /* Our Team */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user in scenario i and scenario ii 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We implemented scenario iii using rspec unit tests: 
1.
2.
3.
4.
 

==== Outcome ====
==== Code Snippet ====

=== Scenario 5 ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====

The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
-- result x test cases passed image --
 

==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Team ==
-
-
-
-

== References ==

Expertiza on GitHub

GitHub Pull Request

demo link

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:05:15Z

Tmpandi2: /* Problem Statement */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

Our project is to build robust test suite for mailer functionality that is currently implemented in Expertiza. Developing this would ensure that all the mailing features are backed up with a stronger set of test features.

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user in scenario i and scenario ii 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We implemented scenario iii using rspec unit tests: 
1.
2.
3.
4.
 

==== Outcome ====
==== Code Snippet ====

=== Scenario 5 ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====

The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
-- result x test cases passed image --
 

==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Team ==
-
-
-
-

== References ==

Expertiza on GitHub

GitHub Pull Request

demo link

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T23:04:50Z

Tmpandi2: /* Background and Problem Statement */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====

=== Scenario 5 ===
When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

==== Cases Tested ====

The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 

==== Outcome ====

We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
-- result x test cases passed image --
 

==== Code Snippet ====

== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Team ==
-
-
-
-

== References ==

Expertiza on GitHub

GitHub Pull Request

demo link

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T22:54:23Z

Tmpandi2: /* Problem Statement */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==
Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Email notifications are sent out when the following events occur:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 5 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Team ==
== References ==

Expertiza on GitHub

GitHub Pull Request

demo link

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

=='''Background and Problem Statement'''==

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

The target of this project is to develop a complete test-suite for the emailing functionalities across various modules of this system.

 

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T22:53:38Z

Tmpandi2: /* Brief Introduction */

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 5 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====

== Team ==
== References ==
Expertiza on GitHub
GitHub Pull Request
demo link

=='''Background and Problem Statement'''==

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

The target of this project is to develop a complete test-suite for the emailing functionalities across various modules of this system.

 

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T22:47:58Z

Tmpandi2:

==Expertiza Background ==
Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

== Problem Statement ==

== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 5 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
== Fixing out of scope bugs ==
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====
== Team ==
== References ==

=='''Brief Introduction'''==

Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Some scenarios where email notifications are sent out are listed below:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.
 

=='''Background and Problem Statement'''==

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

The target of this project is to develop a complete test-suite for the emailing functionalities across various modules of this system.

 

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-12-06T22:23:59Z

Tmpandi2:

==Expertiza Background ==
== Problem Statement ==
== Approach Chosen and Why?==
== Implementation ==
=== Scenario 1 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 2 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 3 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 4===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
=== Scenario 5 ===
==== Cases Tested ====
==== Outcome ====
==== Code Snippet ====
== Fixing out of scope bugs
=== Account Creation ===
==== What we fixed ====
==== Outcome ====
==== Code Snippet ====
=== Author Review ===
==== What we fixed====
==== Outcome ====
==== Code Snippet ====
== Team ==
== References ==

=='''Brief Introduction'''==

Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Some scenarios where email notifications are sent out are listed below:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.
 

=='''Background and Problem Statement'''==

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

The target of this project is to develop a complete test-suite for the emailing functionalities across various modules of this system.

 

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

==Results==

* 162 issues resolved
* 42 Files changed
* 215 additions
* 163 Deletions
* Travis CI build passed
* No merge conflicts
* coveralls :
* Coverage increased (+10.1%) to 50.97%.
* codeclimate bot
* Code Climate has analyzed commit 050fa7d and detected 0 issues on this pull request.
* The test coverage on the diff in this pull request is 42.3% (50% is the threshold).
* This pull request will bring the total coverage in the repository to 29.0% (-21.9% change).
* travis-ci
* Your changes look good to me! tada
* The Travis CI build passed
 

=='''Implementation'''==
===='''Fixes:''' ====
--the additional fixes-- 
 
===='''Tests:''' ====
The Capybara tests were written to model the interactions of the user on each of the specific scenarios. Rspec scripts were written to test if the mail has been sent 
 

===== User account creation (Scenario 4) Implementation =====
There are 3 ways in which user can be created, which are implemented as 3 different scenarios 
i) instructor filling up the form ii) User requests account iii) by importing CSV file from user page : 

The following features were checked as part of user creating user through all methods 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. Sender email-id is verified. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Your Expertiza account and password has been created' 
 

We considered the following cases as it blocks while testing specific to scenario 2: 
1. no email should be sent if new account requested with invalid email address 
2. super admin should receive email about new account request with a valid email address 
3. email notification should be sent to requester when super admin approves account creation request 
4. email notification should be sent to requester when super admin rejects account creation request 
 

We used Capybara to model the scenario as follows: 
i) create user through instructor filling up the form: 
Admin user is created using factory class. 
1.visit expertiza 
2.login_as 'admin_user' 
3.visit list of users 
4.click New User link 
5.fill user_name with 'teststudent' 
6.fill user_fullname with 'test student' 
7.fill user_email with 'test@student.com' 
8.check checkbox to send email to user on review 
9.click 'Create' button. 
 
ii) create user through instructor filling up the form: 
super admin is created using factory class. 
1.visit expertiza 
2.click Request Account link 
3.select instructor from dropdown 
4.fill user name with 'requester1' 
5.fill user fullname with 'requester1, requester1' 
6.fill user email with 'test.com' 
7.fill user_email with 'test@student.com' 
8.select 'North Carolina State University' from user institution 
9.click 'Create' button. 
10.visit list of pending requests from users 
11.Requested user's status is first 'Under Review' 
12.Set status as Approved or Rejected 
13.click on 'Submit' button 

====='' '''Password Reset (Scenario 5) Implementation''':''=====
The following features were checked inside 'it blocks' as part of verifying email functionality 
1. Mail delivery count increased by 1 after the mail triggered by the scenario is sent 
2. The sender mail-id is verified to be 'expertiza.development@gmail.com' 
3. Receiver email id is checked to be equal to 'expertiza.development@gmail.com' . Since all mails triggered have a record in 'expertiza.development@gmail.com' when executed in test environment. 
4. The subject is checked to be equal to 'Expertiza password reset' 
 
The following cases were considered as 'context blocks' while testing the mailer function when user requests for password: 
1. user enters email id which is not associated with any account 
2. user enters email id that's present in the user database 
 
We used Capybara to model the scenario with following steps: 
1. visit expertiza home page 
2. click 'Forgot password?' link 
3. after rediection to password retrieval page 
4. fill in user email field with 'expertiza@mailinator.com' 
5. click on 'Request password' button 
 
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

View our pull request [https://github.com/expertiza/expertiza/pull/1632 here]

CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality

2019-11-16T01:21:08Z

Tmpandi2: /* Our Team */

=='''Brief Introduction'''==

Expertiza system requires sending emails to students and instructors on occurrence of various events or to facilitate actions further.

Some scenarios where email notifications are sent out are listed below:
#An account holder is emailed when a new account is created.
#The author of a submission gets notified via email when a reviewer has reviewed their work and the feedback is available to view.
#The reviewer receives an email when work has been submitted/resubmitted by an author whose work needs to reviewed.
#A confirmation email is sent to a user of the system when they reset their Expertiza account password
#An instructor may configure a setting for an assignment where an email is sent to all the participants to remind them of an upcoming deadline.
 

=='''Background and Problem Statement'''==

In the current scenario, it has been identified that not all emailing functionalities are working as desired.
Also, presently, there is little evidence to claim that the existing implementation is covering all cases and handling all necessary conditions.

The target of this project is to develop a complete test-suite for the emailing functionalities across various modules of this system.

 

=='''Proposed Approach'''==

We propose to reach our goal in increments of the steps listed below:

*Identify the various scenarios where email functionality is being called
*Check if the email functionality is presently working for each scenario
*Ensure necessary parameters are being passed and received
*Verify if email is being sent out to correct recipient
*Check if email is being sent out when expected to (some functionalities require the email to be sent real-time, as a trigger on an action while some require to monitor activity/follow a pre-defined schedule)

On having fair idea of the all of the above, we aim on building test cases that will perform all these checks automatically, in real time and also test how well these work in conjunction with all other parts of the application as a whole.

The proposed test-suite is a combination of unit tests and integration tests that will check the control flow and correctness concerning emails within the system.

 

=='''Test Plan''' ==

'''Automated Testing using Rspec'''

Listed below are a few scenarios we have identified so far, which need to be tested for correct functioning

====Scenario 1: Deadline reminder emails ====

The system continuously monitors upcoming deadlines of assignments.
If an assignment is configured such that an email reminder must be sent for an approaching deadline, then an email must be sent to all participants of that assignment as scheduled by the instructor.

[[File:Fc-4.PNG|center|border]]

Files associated with this functionality:
#mail_worker.rb
#background_email_reminder.rake

Following tests will be performed to verify whether the functionality is working as desired.
*Check if email notification is being sent to all the participants on the assignment. This can be verified by confirming that the count of emails sent out is equal to the total number of student participants on that assignment
*Check if the deadline type is correct and relevant

====Scenario 2: Author(s) get emailed when a reviewer has reviewed their work====

Whenever someone reviews other student or team’s work, then that student or all the members of that team should get notified through the email stating that new peer review is available for your work.
Even when the reviewer updates the reviews, then also that student or all the team members should get notified that updated comments are present on their submitted work.

[[File:Fc-5.PNG|center|border]]

Files associated with this functionality:
#app/controllers/response_controller.rb
#app/models/review_response_map.rb

Following parameters need to be tested:
*Whenever reviewer reviews some team’s work, in that case all the team members should receive an email. So, number of emails delivered should be number of participants assigned to that work.

====Scenario 3: Reviewer gets notified when an author has submitted/resubmitted work ====

This will be mainly the case when there will be more than one round of the submission. After the first submission, some users will be assigned to review the submitted work. Now, in second round of the submission, whenever author resubmits or edit their work, then in that case all the reviewers assigned to that author should get email notification stating new submission is available for them to review.

Files associated with this functionality:
#app/controllers/submitted_content_controller.rb
#app/helpers/mailer_helper.rb

Following parameters need to be tested:
*Whenever the team or students resubmits their work, all the reviewers assigned to them should get notified. That means number of mails delivered should be equals to the number of reviews assigned to their work.

====Scenario 4: User gets an account creation notification upon account creation with that email id====

There are many ways to create new user account in Expertiza. Irrespective of the method of creating user, that user should get notified via email whenever an account is created stating this is your username and will also provide randomized password to allow them to login for the first time.
Below given are the ways to create new user to system.

1. Instructor can add users to the system by filling the sign-up form for user.

2. Instructor can also import CSV file containing the user information to add user to the system.

[[File:Fc-3.PNG|center|border]]

3. Instructor can add user as the participant of the assignment by importing details through CSV file. While doing that, if there are any user credentials present in the CSV file but is not registered in the system, then in that case new user account will be created.

[[File:Fc-1.PNG|center|border]]

4. There is also way to request user account without any help of the instructor. In that case, actual account will not be created but the details will be stored in the requested users table. Whenever instructor authorizes the requested user, actual user account will be created, and the user of that account should receive email notification stating your account request has been approved.

[[File:Fc-2.PNG|center|border]]

Files associated with this functionality:
#app/mailers/mailer.rb
#app/helper/mailer_helper.rb
#app/models/user.rb
#app/models/assignment_participant.rb
#app/controllers/user_controller.rb

Following parameters must be tested
*Check if the email is being sent to the same user whose account has been newly created
*Verify that only one email is being sent for each corresponding new account

====Scenario 5: User gets password reset link, on request for new password====

When the user tries to login, and the password entered is wrong, the user is redirected to reset password page.
[[File:Forgotpwd.PNG|center|border]]

Here the email-id entered is searched through the database,
If such user account is found: url for reset is generated, with random token set as password is sent to the user.

Files associated with this functionality:
# spec/controllers/PasswordRetrievalController
# app/controllers/PasswordRetrievalController
# app/mailers/mailer.rb
# app/helper/mailer_helper.rb

Flowchart:

[[File:Flow.PNG|center|border]]

Following tests can be performed to verify whether the functionality is working as desired.
When a new user is created :

* Expect mail to be generated and sent to the mail id of the user

* Expect the subject of mail to be "Expertiza password reset"

* The link in email body with token generated in send_password can be checked
 

=='''Our Team'''==
#Mohit Jain(mentor)
#Vishva Shah (vpshah@ncsu.edu)
#Urvish Vasani (uvasani@ncsu.edu)
#Tanvi Pandit(tmpandi2@ncsu.edu)
#Swathi Dinakaran(sdinaka@ncsu.edu)
 

=='''Quick Links'''==

To visit our forked repo, [https://github.com/vishva1001/expertiza click here]

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-07T03:20:30Z

Tmpandi2:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
# validates if the url provided is of a valid format
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

# Calculates the rating of a bookmark when review type is a rubric and not a dropdown
def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

# fetches the previously added responses to rate a bookmark
def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/controllers/bookmarks_controller.rb
# method to check if a dropdown is used for rating bookmarks
def has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
# Saves the responses to the bookmark review questionnaire.
# If a previous response exists it updates it.
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

Rspec testing videos can be found [https://drive.google.com/open?id=1KY2WNfuQB9U99FYhqUE15dnnKDFgTCwb here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==
* Giving credit to the author of the bookmark for his contribution

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T21:05:29Z

Tmpandi2: /* Future Scope */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
# validates if the url provided is of a valid format
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

# Calculates the rating of a bookmark when review type is a rubric and not a dropdown
def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

# fetches the previously added responses to rate a bookmark
def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/models/bookmark_rating_questionnaire.rb
# method to check if a dropdown is used for rating bookmarks
def self.has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
# Saves the responses to the bookmark review questionnaire.
# If a previous response exists it updates it.
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==
*
*

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T20:22:56Z

Tmpandi2: /* Design and Implementation */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
# validates if the url provided is of a valid format
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

# Calculates the rating of a bookmark when review type is a rubric and not a dropdown
def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

# fetches the previously added responses to rate a bookmark
def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/models/bookmark_rating_questionnaire.rb
# method to check if a dropdown is used for rating bookmarks
def self.has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
# Saves the responses to the bookmark review questionnaire.
# If a previous response exists it updates it.
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T20:18:07Z

Tmpandi2:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/models/bookmark_rating_questionnaire.rb
# method to check if a dropdown is used for rating bookmarks
def self.has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T19:53:36Z

Tmpandi2:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<% if @has_dropdown %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
....

<% avg = average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
...
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
....

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T19:01:29Z

Tmpandi2:

'''Peer Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Tasks that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Solutions Implemented ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<% if @has_dropdown %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
....

<% avg = average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
...
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
....

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T18:19:06Z

Tmpandi2:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Tasks that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Solutions Implemented ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Earlier:

Files Changed:
:app/models/bookmark_rating.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<% if @has_dropdown %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
....

<% avg = average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
...
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
....

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

:app/models/questionnaire.rb
The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

'''Peer Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': The error popping 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' when None is selected in Bookmark rating is out of scope of the current project. Although the error pops up, the functionalities are working as it is expected and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T17:50:37Z

Tmpandi2: /* Solutions Implemented */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Tasks that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Solutions Implemented ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Earlier:

Files Changed:
:app/controllers/bookmarks_controller.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end
.
.
.
helper_method :average_based_on_rubric
.
.
end

:app/views/bookmarks/list.html.erb
....
<% if @has_dropdown %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
....

<% avg = average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
...
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
....

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

:app/models/questionnaire.rb
The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

'''Peer Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': The error popping 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' when None is selected in Bookmark rating is out of scope of the current project. Although the error pops up, the functionalities are working as it is expected and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T17:43:13Z

Tmpandi2: /* Solutions Implemented */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Tasks that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Solutions Implemented ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
.
.
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
.
.
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
.
.
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
.
.
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Earlier:

Files Changed:
:app/controllers/bookmarks_controller.rb

def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end
.
.
.
helper_method :average_based_on_rubric
.
.
end

:app/views/bookmarks/list.html.erb
....
<% if @has_dropdown %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
....

<% avg = average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
...
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
....

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

:app/models/questionnaire.rb
The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

'''Peer Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': The error popping 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' when None is selected in Bookmark rating is out of scope of the current project. Although the error pops up, the functionalities are working as it is expected and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T17:24:44Z

Tmpandi2:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Tasks that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Solutions Implemented ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/controllers/sign_up_sheet_controller.rb 
:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

:app/views/bookmarks/new.html.erb 

...
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id , :assignment_id => @topic.assignment_id %></td>


The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for adding bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Earlier:

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
.
.
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
.
.
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
.
.
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
.
.
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Earlier:

Files Changed:
:app/controllers/bookmarks_controller.rb
:app/views/bookmarks/list.html.erb
The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

:app/models/questionnaire.rb
The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

'''Peer Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': The error popping 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' when None is selected in Bookmark rating is out of scope of the current project. Although the error pops up, the functionalities are working as it is expected and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

== Future Scope ==

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T17:12:17Z

Tmpandi2: