Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:56:18Z

Pchheda: /* Manual Testing */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 
 
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

=='''Testing'''==
==='''Manual Testing'''===
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#Click on the reviewer in order to see detailed information of time spent by each reviewer
#Click on alternate view for each entry in order to see link wise time spent in form of a pie chart.

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:56:05Z

Pchheda: /* Testing */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 
 
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

=='''Testing'''==
==='''Manual Testing'''===
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#Click on the reviewer in order to see detailed information of time spent by each reviewer
#Click on alternate view for each entry in order to see link wise time spent in form of a pie chart.

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:55:30Z

Pchheda: /* Test Plan */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 
 
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

=='''Testing'''==
'''Manual testing:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#Click on the reviewer in order to see detailed information of time spent by each reviewer
#Click on alternate view for each entry in order to see link wise time spent in form of a pie chart.

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:53:06Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 
 
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Manual testing:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#Click on the reviewer in order to see detailed information of time spent by each reviewer
#Click on alternate view for each entry in order to see link wise time spent in form of a pie chart.

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:52:44Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Manual testing:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#In order to see detailed information

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:52:24Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".
 
[[File:Pie-chart.png]]
 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Manual testing:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#In order to see detailed information

File:Pie-chart.png

2016-12-03T00:51:52Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:49:10Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken by reviewers in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each team reviewed for this particular assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

Now, we can see that this report is simply an overview. If the instructor wishes to view fine-grained details, he can click on the reviewer link in the report. A popup is then rendered by '''popup/reviewer_details_popup.html.erb'''. This view shows reviewer details and details of time spent per link per round by that particular reviewer. Note - total time represents total time spent by the reviewer over all rounds over all links.
 
If the user clicks on "alternate view" for a particular round, a pie-chart representation of the same data for that round appears above the details table. The user can toggle this view off by clicking "hide details" and "show details".

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Manual testing:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the total time spent by the reviewers for each to be visible
#In order to see detailed information

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:28:49Z

Pchheda: /* What needs to be done */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.
 

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:27:15Z

Pchheda: /* Files modified */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js
 

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:26:57Z

Pchheda: /* Other Edge cases handled : */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:26:42Z

Pchheda: /* Other Edge cases handled : */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review
 

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-03T00:26:19Z

Pchheda: /* Other Edge cases handled : */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
##If the user downloads any submission, the start time will be recorded on click link and end time will get recorded as above or when he submits the review

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:58:31Z

Pchheda: /* Other Edge cases handled : */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session:
##It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time.
##We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission:
#If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:57:55Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]]

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:57:23Z

Pchheda: /* Edge cases */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]] 

==='''Other Edge cases handled :'''===

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:43:11Z

Pchheda: /* Files modified */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:37:32Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:Review_report_view.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

File:Review report view.png

2016-12-02T23:37:14Z

Pchheda:

File:ReviewReport1.png

2016-12-02T23:36:13Z

Pchheda: uploaded a new version of "File:ReviewReport1.png"

File:ReviewReport1.png

2016-12-02T23:35:35Z

Pchheda: uploaded a new version of "File:ReviewReport1.png"

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:25:55Z

Pchheda: /* Viewing the recorded times spent */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the total times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32, 12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:21:54Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:21:24Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
[[File:Popup screenshot.png]]
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:20:11Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
 
[[File:Popup screenshot.png]]
 
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

File:Popup screenshot.png

2016-12-02T23:19:32Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T23:11:38Z

Pchheda: /* Approach and Implementation */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 

==='''Viewing the recorded times spent'''===
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T22:53:46Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.
 
'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T22:52:42Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow_diagram_final.jpg|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

File:Flow diagram final.jpg

2016-12-02T22:52:24Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T22:48:05Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow diagram.jpg|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

File:Flow diagram.jpg

2016-12-02T22:47:33Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T22:05:14Z

Pchheda: /* Purpose */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:40:28Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission.
#As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:31:49Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database.
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database. All these cases are handled with the help of javascript '''onbeforeunload''' property
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:29:06Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the '''start time''' when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save '''end time''' details to database
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:28:03Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the '''response_times table''' gets created) during new review or while editing his saved review. An AJAX call is made from the view to '''ResponseTime''' controller action '''record_start_time''' to save start time details to database
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the cases mentioned below. In this, an AJAX call is made from the view to '''ResponseTime''' controller action '''record_end_time''' to save end time details to database
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:24:47Z

Pchheda: /* How reviewing times get recorded in the database */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review. An AJAX call is made from the view to response_time_controller.rb/record_start_time to save start time details to database
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:21:07Z

Pchheda: /* Approach and Implementation */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:18:27Z

Pchheda: /* Database Design */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response. 
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:17:59Z

Pchheda: /* Database Design */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response.
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:16:32Z

Pchheda: /* Database Design */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response.
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 

[[File:Response_times.png]]
 

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

File:Response times.png

2016-12-02T17:16:01Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-12-02T17:13:39Z

Pchheda: /* Approach and Implementation */

=='''Introduction'''==
==='''Purpose'''===
Expertiza provides the functionality of peer reviews. The best advantage of peer review for the students is that it allows students to learn from each other work.
#It provides a dual benefit for both the reviewer and the writer as they are introduced to a different set of eyes on the code
#It might expose edge cases not previously thought of
#It helps instructors review a project faster
#It emphasizes the importance of writing in such a way that it's easy for a third person to read and understand
In order to assess and analyze how much a student learns from others' work, we want to be able to track the time that students spend observing the the same. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission, which makes it difficult for the system to track the time that the reviewers spend on the submissions. To assess and improve review qualities, the purpose of the project is to be able to successfully track the time that each student spends on peer reviewing the work.

==='''What needs to be done'''===
#Design and implement a solution that handles the use case, where students’ submissions are hosted on an external website e.g. GitHub and Youtube use cases
#Design a database schema for logging the time a reviewer spends on each submission link
#Modify Review report (views/review_mapping/_review_report.html.erb) to display the response time summary report for each reviewer.

=='''Approach and Implementation'''==
==='''Types of submissions'''===

Generally, the submission links can be one of the following:
#GitHub project/repository link , GitHub Pull requests link or Deployment link
#Youtube videos
#Wikipages
#Text document/doc/pdf/ppt
#Images - png/jpg
#Downloadable contents

==='''Database Design'''===
The task is to know how much time a reviewer spent reviewing other teams.
#We earlier thought of having '''response_id''' as one of the fields which could help us identify for which response we are recording reviewing time. But, entry in the''' responses table''' is created only once the response is either saved or submitted. Since we want our response_times entry to be created before that, we did not have any '''response_id''' corresponding to the response.
#We primarily needed reviewer and reviewee specific data. So, another parameter to help us identify this primary information was '''response_map_id''' in the '''response_maps''' table. Once the review is started , we have the '''response_map_id''' from which we can later derive both '''reviewer_id''' and '''reviewee_id'''.There can be separate links uploaded per round, hence '''round''' is also an important parameter to be recorded. We need to record '''start''' and '''end''' time per '''link'''. 
The following table '''response_times''' was created to implement a solution for this project: 
[[File:Database table review submission timing.png]]

==='''How reviewing times get recorded in the database'''===
Start and end time of each link viewed in one session needs to be recorded.

The following are the steps that will be followed to keep track of the time:
#Log the start time when a user clicks on a submitted link (a new entry in the response_times table gets created) during new review or while editing his saved review
#End time of all open links (where end time has not been recorded yet) for that session get recorded in the following cases
##User logged out
##User closed the window
##User clicked on 'save' or 'submit' button
##User switched to some other view other than the page where he is currently writing the review in the same tab. Note - the user is free to switch between tabs. The end time will not get affected in this case
#Next time the reviewer opens the links again to review:
##New entry gets created in the response_times table and start time gets recorded for this new session
##The above procedure for end time remains the same
#In case there is no user activity on the expertiza reviewing page for more than 20 minutes, there will be a pop up asking the user if he is still reviewing the submission. As soon as the pop up is shown, the end times of all open links get updated to this time. The user has two options to cancel or to okay. If the user clicks on 'okay', then the above links for which we just updated the end time, need to be added as new entries again in this new session with start time as the current time.
#This way we have individual entries for each link corresponding to each session with both start and end times recorded in the database.

'''Behaviour Diagram''' : 
[[File:Flow.JPG|center]]
 
Instructor can now view the times taken for reviewers by reviewer in the Review report summary. This report is rendered by partial '''review_mapping/_review_report.html.erb'''. We shall modify this view to record the times spent by the reviewer per review round for each assignment. For example - 15.32/12.67 indicates that reviewer spent 15.32 minutes on round 1 review and 12.67 minutes on round 2 review as shown below.
 
'''Modified View''' : 
[[File:ReviewReport1.png|center]] 

==='''Edge cases'''===

Edge cases that need to be handled :

#What happens when the user clicks on the same link twice in the same session: It may so happen that once the user clicked on a link, by mistake he/she closed it or lost the link and wishes to view it again. If the link is again clicked, a second entry gets created with the current time as start time. We account for the previous entry by updating its end time as current time.
#What happens when the user downloads the submission: If the user downloads any solution and then opens it in his/her local machine, then the time spent on that can't be tracked

==='''Files modified'''===
#response_controller.rb
#response/response.html.erb
#submitted_content/_main.html.erb
#submitted_content/_hyperlink.html.erb
#response/view.html.erb
#review_mapping/_review_report.html.erb
#popup/reviewer_details_popup.html.erb
#helpers/review_mapping_helper.rb (method- get_data_for_review_report)
#config/routes.rb
#application.js

==='''Files added'''===
#response_time_controller.rb
#response_time.rb
#review_mapping/_review_submissions_time_spent.html.erb

==='''Test Plan'''===
'''Functional Testing using RSpec:'''
 
To test if the time spent by the reviewer on the submitted links shows up in the response_report in Instructor View. 
# Login as a reviewer, for example (student5930). Click on the submitted links to start reviewing. Once review is done, the time spent is recorded in the background and saved in our database
# Login as an instructor. Click on assignments tab. Click on 'View Review Report' under actions for the particular assignment. In the view rendered we expect the new content of time spent by the reviewers to be visible
 
'''Manual Testing for Verification:'''
#When user clicks on a submitted link, it opens up in a new window
#To verify if the time displayed in the response_report view matches with the actual time spent by the reviewer for all reviews

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:53:18Z

Pchheda: /* Approach and Implementation */

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:52:47Z

Pchheda: /* Files to be modified/added */

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:52:25Z

Pchheda:

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:51:39Z

Pchheda: /* Approach and Implementation */

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:51:12Z

Pchheda: /* Edge cases */

CSC/ECE 517 Fall 2016/E1705. Tracking the time students look at the others' submissions

2016-11-14T22:50:35Z

Pchheda: /* Approach and Implementation */