Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-12-03T03:59:12Z

Nsompal:

== About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities. It also allows students to be active on it for completing the assignments and submitting the assignments. Student can view assignments, check the due dates of an assignment, submit an assignment, do peer review, suggest topics, give author feedback and many more in Expertiza.

== Background of the Project==

Through Expertiza students can currently submit their work, review others work, give author feedback , see the deadlines for an assignment. But there is no place that shows the time that a student is submitting an assignment/ work. Every time student wants to check a due date or stage deadline for an assignment, he has to go to that particular page to see it. There is a chance that student might forget to submit for that particular time. So, in order to make it easier for the student, it would be great to implement a timeline that shos deadlines, submitted works etc., with timestamps at one place.

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a '''timeline''', which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

''This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.''

==Design principles followed==
*Dry Principle - We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.
*Polymorphism - We will use polymorphism to provide a single interface to entities of different types.
*MVC - The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
*CSS - As we are using CSS to design timeline we follow proper CSS standards to develop the project.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Student_page.png]]

===Approach to solve the problem===
In this project, a timeline in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
. We will be using HighGraphs to generate the timeline.
We take the data necessary for each stage for the student from the database tables mentioned below and allow them to appear on the timeline with the time stamps.
The database tables we use for fetching the data are :

*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

By fetching the data from the tables necessary regarding the hyperlinks, due dates, review related information and using CSS , High Graphs we mark a timeline in the student Assignment page which would display all the data with a hyperlink to navigate to that page easily.

After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/student_task_controller.rb
*app/models/student_task.rb
*app/views/student_task/_timeline.html.erb
*The database tables involved for the work is due_dates, due_date_type, submission_record, review _mappings, response table

==Databases Involved==
*Due Dates Table
*Due Date Type Table
*Submission Records Table
*Review Mappings Table
*Response Table

*Due Dates table is queried using assignment ID to fetch due date entries and fetch due date type from Due Date Type table which has a foreign key relation with Due Dates table.
*Submission Records table is queried with team ID and assignment ID to fetch all the submission completed by the team.
*Response Map table is queried with participant ID to fetch review mapping ID and reviews are fetched from Review Mapping table

==Implementation==

Timeline feature is used to display timeline with due dates, submitted links, submitted files, self review, reviews performed(multiple rounds) and Author Feedback. The required data is scattered in the data base in different tables. New method '''get_timeline_data''' was added in '''student_task.rd''' model file to consolidate and parse data from different tables and create a list of all the required data points.

'''Note:''' All names displayed on the timeline is directly picked from the database and the string has not been formatted since there is no constants defined in the code and string parsing would add dependency.

[[File:calling_method.png]]

Method '''get_duedate_data''' will fetch all required due date records using assignment ID, prepare a hash of required data points and add the hash to timeline list.

[[File:duedates_method.png]]

Method '''get_submission_data''' will fetch all required submission records using assignment ID and team ID. Parse all the records, prepare a hash of required data points and add the hash to timeline list.

[[File:submitted_data_method.png]]

Method '''get_review_data''' will fetch all required review, feedback record using participant ID. Parse all the records, prepare a hash of required data points and add the hash to timeline list.

[[File:review_data_method.png]]

The modular approach helps with future modifications where new data points can be added to the timeline by creating a parser method and call the parser in get_timeline_data method.

The '''get_duedate_data''' method is called from the '''student_task_controller.rb''' file to fetch the timeline list which is used to display the timeline in '''student_task/_timeline.html.erb''' file.

[[File:Student_Task_Controller.png]]

'''Timeline''' is created using a simple node template, running a loop and displaying each data point in the timeline list.

[[File:_Timeline_html.png]]

==Test Plan==

===Edge Cases===

* When the student doesn't submit the assignment on time , due date passed would be shown in the timeline.
* If the hyperlink submitted by student doesnt get submitted properly, it would not show any link to hyperlink on timeline.
* If the review is not done before the deadline,review link doesn't appear on the timeline and alos shows that due date is passed on timeline.
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.
===== RSpec =====
Since we are following the TDD approach, the test cases where first written and then the code was implemented. Since the task of submitting hyperlink, file and performing review was made into methods as it is being used in multiple testcases.

[[File:testcase_hyperlink_method.png]]

[[File:testcase_file_method.png]]

[[File:testcase_review_method.png]]

'''Testcase 1:''' A hyperlink is submitted and expect to find 'submit Hyperlink' in the student task page.

'''Testcase 2:''' A file is submitted and expect to find 'submit File' in the student task page.

'''Testcase 3:''' A review for the assignment is requested, completed and submitted. Expect to find 'round 1 review' in the student task page.

[[File:Testcase_1.png]]

'''Testcase 4:''' Submit hyperlink, file and perform a review. Check timeline for 'submit Hyperlink', 'submit File' and 'round 1 review'.

[[File:testcases_2.png]]

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

'''Note:''' All names displayed on the timeline is directly picked from the database and the string has not been formatted since there is no constants defined in the code and string parsing would add dependency.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed with only due dates

[[File:rsz_deadlines.png]]

*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp.

[[File:rsz_hyperlink.png]]

*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp.

[[File:rsz_filesubmit.png]]

*'''Step10''' : Submit a review
*'''Step11''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number page.

[[File:rsz_review_round_1.png]]

[[File:rsz_round_2_review.png]]

*'''Step12''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step13''' : Submit an author feedback.
*'''Step14''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp.

[[File:rsz_author_review.png]]

*'''Step15''' : Click on the round review link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:43:50Z

Nsompal: /* Future Work */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Use Case1'''
*Use Case Description: Create an Option to create a participant when he doesn't exist
*Actor: Instructor
*Precondition: Participant does not exist
*Post Condition:Gets option to create participant

*''' Use Case2'''
*Use Case Description: Get an Email once a review is done with a link for the review page
*Actor: Student
*Precondition: Reviews a team
*Post Condition:Reviewed team gets emails with review link. On clicking the link , it should direct to the corresponding review page

*''' Use Case3'''
*Use Case Description: Get an Dead line reminder Email once a deadline to review is approaching
*Actor: Student
*Precondition: Reviews a team
*Post Condition: Gets deadline reminder in email to review a team.Email should have the link to the review page

*''' Use Case4'''
*Use Case Description: Gets email notifications for reviews contradicting by a particular threshold
*Actor: Instructor
*Precondition: Team reviews are done by at least 2 reviewers
*Post Condition: Instructor gets email notifications for reviews contradicting by a particular threshold along with the links the contradicting reviews.

*''' Use Case5'''
*Use Case Description: Email should be sent to the invitee with the team -join request when join request is sent.
*Actor: Student
*Precondition: Invites another participant to join a team
*Post Condition: Email should be sent to the invitee with the team -join request

*''' Use Case6'''
*Use Case Description: All activity Emails should be sent to student
*Actor: Student
*Precondition: Activity is done in expertiza by team members.
*Post Condition: Student Should receive email on all activity on ad responses and invitations performed by other team members.

*''' Use Case7'''
*Use Case Description: Instructor receives an email for the suggestion request by student
*Actor: Student
*Precondition: Suggests a topic
*Post Condition: Instructor receives an email for the suggestion request

*''' Use Case8'''
*Use Case Description: Instructor receives a copy of email for all the mails sent to student on assignment.
*Actor: Instructor
*Precondition: Activity done on assignment.
*Post Condition: Should get a copy of all emails sent to the student regarding the activities done on assignment.

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.
#'''Alternative Approach that can be implemented'''
##All the changes done in view files could be changed to helpers following the OOD coding standards.

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:41:32Z

Nsompal: /* Future Work */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Use Case1'''
*Use Case Description: Create an Option to create a participant when he doesn't exist
*Actor: Instructor
*Precondition: Participant does not exist
*Post Condition:Gets option to create participant

*''' Use Case2'''
*Use Case Description: Get an Email once a review is done with a link for the review page
*Actor: Student
*Precondition: Reviews a team
*Post Condition:Reviewed team gets emails with review link. On clicking the link , it should direct to the corresponding review page

*''' Use Case3'''
*Use Case Description: Get an Dead line reminder Email once a deadline to review is approaching
*Actor: Student
*Precondition: Reviews a team
*Post Condition: Gets deadline reminder in email to review a team.Email should have the link to the review page

*''' Use Case4'''
*Use Case Description: Gets email notifications for reviews contradicting by a particular threshold
*Actor: Instructor
*Precondition: Team reviews are done by at least 2 reviewers
*Post Condition: Instructor gets email notifications for reviews contradicting by a particular threshold along with the links the contradicting reviews.

*''' Use Case5'''
*Use Case Description: Email should be sent to the invitee with the team -join request when join request is sent.
*Actor: Student
*Precondition: Invites another participant to join a team
*Post Condition: Email should be sent to the invitee with the team -join request

*''' Use Case6'''
*Use Case Description: All activity Emails should be sent to student
*Actor: Student
*Precondition: Activity is done in expertiza by team members.
*Post Condition: Student Should receive email on all activity on ad responses and invitations performed by other team members.

*''' Use Case7'''
*Use Case Description: Instructor receives an email for the suggestion request by student
*Actor: Student
*Precondition: Suggests a topic
*Post Condition: Instructor receives an email for the suggestion request

*''' Use Case8'''
*Use Case Description: Instructor receives a copy of email for all the mails sent to student on assignment.
*Actor: Instructor
*Precondition: Activity done on assignment.
*Post Condition: Should get a copy of all emails sent to the student regarding the activities done on assignment.

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.
#'''Alternative Approach that can be implemented'''
##

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:37:13Z

Nsompal: /* UML Case Diagram */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Use Case1'''
*Use Case Description: Create an Option to create a participant when he doesn't exist
*Actor: Instructor
*Precondition: Participant does not exist
*Post Condition:Gets option to create participant

*''' Use Case2'''
*Use Case Description: Get an Email once a review is done with a link for the review page
*Actor: Student
*Precondition: Reviews a team
*Post Condition:Reviewed team gets emails with review link. On clicking the link , it should direct to the corresponding review page

*''' Use Case3'''
*Use Case Description: Get an Dead line reminder Email once a deadline to review is approaching
*Actor: Student
*Precondition: Reviews a team
*Post Condition: Gets deadline reminder in email to review a team.Email should have the link to the review page

*''' Use Case4'''
*Use Case Description: Gets email notifications for reviews contradicting by a particular threshold
*Actor: Instructor
*Precondition: Team reviews are done by at least 2 reviewers
*Post Condition: Instructor gets email notifications for reviews contradicting by a particular threshold along with the links the contradicting reviews.

*''' Use Case5'''
*Use Case Description: Email should be sent to the invitee with the team -join request when join request is sent.
*Actor: Student
*Precondition: Invites another participant to join a team
*Post Condition: Email should be sent to the invitee with the team -join request

*''' Use Case6'''
*Use Case Description: All activity Emails should be sent to student
*Actor: Student
*Precondition: Activity is done in expertiza by team members.
*Post Condition: Student Should receive email on all activity on ad responses and invitations performed by other team members.

*''' Use Case7'''
*Use Case Description: Instructor receives an email for the suggestion request by student
*Actor: Student
*Precondition: Suggests a topic
*Post Condition: Instructor receives an email for the suggestion request

*''' Use Case8'''
*Use Case Description: Instructor receives a copy of email for all the mails sent to student on assignment.
*Actor: Instructor
*Precondition: Activity done on assignment.
*Post Condition: Should get a copy of all emails sent to the student regarding the activities done on assignment.

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:34:28Z

Nsompal: /* UML Case Diagram */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Use Case1'''
*Use Case Description: Create an Option to create a participant when he doesn't exist
*Actor: Instructor
*Precondition: Participant does not exist
*Post Condition:Gets option to create participant

*''' Use Case2'''
*Use Case Description: Get an Email once a review is done with a link for the review page
*Actor: Student
*Precondition: Reviews a team
*Post Condition:Reviewed team gets emails with review link. On clicking the link , it should direct to the corresponding review page

*''' Use Case3'''
*Use Case Description: Get an Dead line reminder Email once a deadline to review is approaching
*Actor: Student
*Precondition: Reviews a team
*Post Condition: Gets deadline reminder in email to review a team.Email should have the link to the review page

*''' Use Case4'''
*Use Case Description: Gets email notifications for reviews contradicting by a particular threshold
*Actor: Instructor
*Precondition: Team reviews are done by at least 2 reviewers
*Post Condition: Instructor gets email notifications for reviews contradicting by a particular threshold along with the links the contradicting reviews.

*''' Use Case5'''
*Use Case Description: Email should be sent to the invitee with the team -join request when join request is sent.
*Actor: Student
*Precondition: Invites another participant to join a team
*Post Condition: Email should be sent to the invitee with the team -join request

*''' Use Case6'''
*Use Case Description: All activity Emails should be sent to student
*Actor: Student
*Precondition: Activity is done in expertiza by team members.
*Post Condition: Student Should receive email on all activity on ad responses and invitations performed by other team members.

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:27:31Z

Nsompal: /* UML Case Diagram */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Use Case1'''
*Use Case Description: Create an Option to create a participant when he doesn't exist
*Actor: Instructor
*Precondition: Participant does not exist
*Post Condition:Gets option to create participant

*''' Use Case2'''
*Use Case Description: Get an Email once a review is done with a link for the review page
*Actor: Student
*Precondition: Reviews a team
*Post Condition:Reviewed team gets emails with review link. On clicking the link , it should direct to the corresponding review page

*''' Use Case3'''
*Use Case Description: Get an Dead line reminder Email once a deadline to review is approaching
*Actor: Student
*Precondition: Reviews a team
*Post Condition: Gets deadline reminder in email to review a team.Email should have the link to the review page

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1780 OSS Project Teal Email Notification Enhancements

2017-11-20T01:19:20Z

Nsompal: /* UML Case Diagram */

This wiki page is for the description of changes made under E1780 OSS Project Teal Email Notification Enhancements.

__TOC__

== About Expertiza ==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities.

== Problem Statement ==
The following tasks were accomplished in this project:
:* Instructor should get an option to create a participant if (s)he does not already exist in the system.
:* E-mails about reviews should direct the user to the page where the review is found.
:* Deadline reminders should include a link on where to go to perform the needed function.
:* Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
:* Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
:* All activity on ad responses and invitations should be reported to the other party by e-mail.
:* Notify an instructor by e-mail when a student suggests a topic.
:* Instructor should get a copy of all emails sent to the student.

== UML Case Diagram ==
[[File:Drawing2.JPG]]

The UML diagram shows the functionality that is being developed in the project.
*''' Case1:'''
*Precondition: Participant does not exist

Gets option to create participant

== Peer Review Information ==
*The CodeClimate build is failed for the files which are already present, and not for the changes made
* For the changes to be tested use Instructor Login: username: instructor6 password: password
*A self explanatory video has been uploaded for the same.
*Design principles are not needed as we mostly modified existing work.
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

== Files changed ==
====Controllers====
::* invitations_controller.rb
::* profile_controller.rb
::* suggestion_controller.rb
::* users_controller.rb
====Helpers====
::* mailer_helper.rb
::* login_helper.rb
====Mailers====
::* delayed_mailer.rb
::* mailer.rb
====Models====
::* response.rb
::* user.rb
====Views====
::* invite_message.html.erb
::* new_topic_suggested_message.html.erb
::* notify_grade_conflict_message.html.erb
::* _invitation_accepted_html.html.erb
::* _invitation_declined_html.html.erb
::* _invitation_pending_html.html.erb
::* _new_submission_html.html.erb
::* _submission_deadline_test_html.html.erb
::* _additional_links.html.erb
::* add.js.erb
::* _prefs.html.erb
====Spec====
::* factories.rb
::* user_spec.rb

== Solutions Implemented ==
====Providing option to instructor to create non-existent participant====
:A flash message was added when the instructor adds a non-existent user as a participant.A new link to redirect the instructor to the user creation page is also added.
:Related code snippet [[File:Additional_add.PNG]]
====Link provided to redirect user to page where review is found====
:A new link was incorporated in the email to redirect the user to the corresponding review page.
:Related code snippet [[File:new_submission.png]]
====Incorporating a link for submission deadline reminder====
:Tests were done for already existing functionality as deadline reminders are not being sent as per the current functionality.
:Related code snippet [[File:submission_Deadline.png]]
====Enhancing the email that the instructor receives for contradicting reviews====
:The email that the instructor receives for contradicting reviews was enhanced by adding the previous average score of the total reviews and the score of the new review. The readability of the email was also increased by adding bullet points wherever necessary.
:Related code snippet [[File:conflict1.png]] [[File:conflict2.png]] [[File:conflict3.png]] 
====Sending email to the invitee to join a team====
:When a particular student invites another student(s) to join a team for a particular assignment, then the invitee(s) should receive an email for the same.
:Related code snippet [[File:invitation_controller25.png]] [[File:mailer_helper.png]] [[File:invite_message.png]]
====All activities on ad responses and invitations should be reported to the other party by e-mail====
:Three new partials have been created to send emails to both inviter and invitee for the responses(accept, decline, pending) of invitations to join a team
:Related code snippet [[File:invitation_controllers26.png]] [[File:inv_acc_dec.png]] 

====Emailing to the instructor when a student suggest a new topic====
:When a new topic is suggested by a student to the instructor , an email is sent to the instructor regarding the same for his decision to approve or decline.
:Related code snippet [[File:sugg_controller.png]] [[File:topic_sugg.png]]
====Instructor should receive copy of emails being sent to the student if (s)he wishes to====
:Instructor can choose to receive all the emails being sent to the students to understand proper functioning of the system.
:Related code snippet [[File:lastreq1.png]] [[File:lastreq2.png]] [[File:lastreq3.png]] [[File:lastreq4.png]] [[File:lastreq5.png]] [[File:lastreq6.png]] [[File:lastreq7.png]] [[File:lastreq8.png]] [[File:lastreq9.png]]

== Testing Details and TestPlan ==
===Testing with UI(Manual Testing)===
====Requirement1====
*If someone attempts to assign a nonexistent user as a participant in an assignment by filling out the form on the Add Participants page, (s)he should be warned that the user does not exist. This is reasonable behaviour because the username may have been mistyped, and you wouldn't want to create a new user account due to a typo.
=====Testing Steps=====
Adding a non-existent user as a participant in an assignment
*Login as an instructor.
*Click on an existing active Assignment .
*Click on Add Participants and add any non-existent user ( any email id ).
*Result : It gives a flash message regarding user does not exist and gives you the link to create a new user.
====Requirement2====
* E-mails about reviews should direct the user to the page where the review is found.
=====Testing Steps=====
*Login as an instructor.
*Click on an existing active assignment.
*Add an existing user as a reviewer and another user as a participant to this assignment.
*Login as the reviewer and submit your review.
*Result: The participant must have received an email on this review submission with a link to the review submitted.
====Requirement3====
* As there are no deadline reminders implement in expertiza currently , we were asked to verify the Rspec test cases which are already present in delayed_mailer_spec.rb for the same . We were asked to fix if any bugs were found in that. But no bugs were found.
=====Testing Steps=====
* Run the Rspec test cases by following a command :
bundle exec rspec delayed_mailer_spec.rb
*Result : See the attachment for the screenshot.
====Requirement4====
*Instructor notifications of where reviews disagree by more than a threshold # of points should point the instructor to the reviews that disagree.
*Put the links in the bulleted list that is easy to read.
*The mail should have the previous average score as well as the new score that is being assigned.
*Any other kind of improvement to increase the readability of the email is welcome
=====Testing Steps=====
*Login as an instructor and create three students.
*Hover over Manage Tab --> click on Assignments --> choose an existing active assignment-->Click on Add Participants section of that assignment.
*Out of the three users that you have created, add two as reviewers and one as participant to that assignment.
*Login as the participant and submit any link as your work .
*After the submission deadline is over, login as each of the reviewers and submit two contradicting reviews of the same assignment. ( Say, one gives all 0s , another gives all 5s).
*Result : This should send an email to the instructor with the below text.
====Requirement5====
*Send out an email to the invitee when a participant sends out an invitation to another participant to join a team.
=====Testing Steps=====
*Login as an instructor --> click on Assignments tab --> Select an existing active assignment .
*Add one user as a participant , login as the participant and invite a student to join the team for the assignment.
*Result: Email has been sent to invitee.
====Requirement6====
*The student who issued the invitation should also be e-mailed when the invitee joins the team. And also when a student responds to a teammate advertisement. In general, all activity on ad responses and invitations should be reported to the other party by e-mail (unless these e-mails are turned off in a (new) profile field).
=====Testing Steps=====
*Continue from Requirement 5.
*Result : Both the inviter and the invitee should get an email as per the requirement specified above.
====Requirement7====
*Notify an instructor by e-mail when a student suggests a topic.
=====Testing Steps=====
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
*Login as an instructor--> Create a user with Student role
*Login as a student--> Click on existing active Assignment .
*Click on suggest a topic handle and suggest any topic and save it
*Result : Instructor is notified when the topic is suggested.
====Requirement8====
*Create an option (in the instructor’s profile) to get a copy of ‘e-mails being sent to students (this is so the instructor can verify correct functioning of the system).
*Modified Requirement : Implemented for one such scenario, can easily be replicated for others.

=====Testing Steps=====
*Login as an existing instructor --> go to profile tab.
*Do not tick the check box mentioning "get copy of all emails" now.
*Go to Manage Users --> Create a student.
*Result 1 (negative testing) : Instructor does not receive an email.

*1. Login as the instructor and go to the Profile tab.
*2. Tick the check box mentioning "get copy of all emails" now and Save.
*3. Perform an event. Here, "Create any other user (may be a Student , Reader ) and Save. While creating the user , please ensure you give an email id that you can access.

*Result2(positive testing) : Both the created user and the instructor receives the email.
*Note : The instructor only receives copy of all emails happening in the system, if the check box is checked. In this case, we have just implemented for one such scenario . This can easily be replicated for the others.

===Automated Testing Scenario(RSpec)===
:The test cases for the complete functionality testing are covered.
:There were existing test cases for the delayed_mailer.rb and the functionality is checked by running those test cases.The snapshot of running the Rspec for the deadline reminder details is given below.
=====Related snippet [[File:rspec421.png]]=====

== Future Work ==
#Reviewer is receiving an email after a submission is revised.
##The above mentioned email should also contain the Review round after which the submission has been revised.
##The above mentioned email must contain a link that redirects the reviewer to the link where the review is found.
#Reviewer does not receive the above mentioned email if the last round of review has been completed.
#Deadline reminder emails should be implemented in the system for both submissions and reviews.
##A link should be provided in that email so that the user knows where to go to perform the needed action.

== References ==
*The Project Demo Video is present at : https://drive.google.com/open?id=0B4GJ154MimyPVGxqOWhZYk1mWFE

*[https://github.com/expertiza/expertiza Expertiza on GitHub]
*[http://expertiza.ncsu.edu/ The live Expertiza website]
*[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:31:10Z

Nsompal:

== About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities. It also allows students to be active on it for completing the assignments and submitting the assignments. Student can view assignments, check the due dates of an assignment, submit an assignment, do peer review, suggest topics, give author feedback and many more in Expertiza.

== Background of the Project==

Through Expertiza students can currently submit their work, review others work, give author feedback , see the deadlines for an assignment. But there is no place that shows the time that a student is submitting an assignment/ work. Every time student wants to check a due date or stage deadline for an assignment, he has to go to that particular page to see it. There is a chance that student might forget to submit for that particular time. So, in order to make it easier for the student, it would be great to implement a timeline that shos deadlines, submitted works etc., with timestamps at one place.

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a '''timeline''', which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

''This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.''

==Design principles followed==
*Dry Principle - We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.
*Polymorphism - We will use polymorphism to provide a single interface to entities of different types.
*MVC - The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
*CSS - As we are using CSS to design timeline we follow proper CSS standards to develop the project.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Student_page.png]]

===Approach to solve the problem===
In this project, a timeline in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
. We will be using HighGraphs to generate the timeline.
We take the data necessary for each stage for the student from the database tables mentioned below and allow them to appear on the timeline with the time stamps.
The database tables we use for fetching the data are :

*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

By fetching the data from the tables necessary regarding the hyperlinks, due dates, review related information and using CSS , High Graphs we mark a timeline in the student Assignment page which would display all the data with a hyperlink to navigate to that page easily.

After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==

===Edge Cases===

* When the student doesn't submit the assignment on time , due date passed would be shown in the timeline.
* If the hyperlink submitted by student doesnt get submitted properly, it would not show any link to hyperlink on timeline.
* If the review is not done before the deadline,review link doesn't appear on the timeline and alos shows that due date is passed on timeline.
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:30:03Z

Nsompal:

== About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities. It also allows students to be active on it for completing the assignments and submitting the assignments. Student can view assignments, check the due dates of an assignment, submit an assignment, do peer review, suggest topics, give author feedback and many more in Expertiza.

== Background of the Project==

Through Expertiza students can currently submit their work, review others work, give author feedback , see the deadlines for an assignment. But there is no place that shows the time that a student is submitting an assignment/ work. Every time student wants to check a due date or stage deadline for an assignment, he has to go to that particular page to see it. There is a chance that student might forget to submit for that particular time. So, in order to make it easier for the student, it would be great to implement a timeline that shos deadlines, submitted works etc., with timestamps at one place.

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a '''timeline''', which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

''This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.''

==Design principles followed==
*Dry Principle - We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.
*Polymorphism - We will use polymorphism to provide a single interface to entities of different types.
*MVC - The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
*CSS - As we are using CSS to design timeline we follow proper CSS standards to develop the project.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Student_page.png]]

===Approach to solve the problem===
In this project, a timeline in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
. We will be using HighGraphs to generate the timeline.
We take the data necessary for each stage for the student from the database tables mentioned below and allow them to appear on the timeline with the time stamps.
The database tables we use for fetching the data are :

*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

By fetching the data from the tables necessary regarding the hyperlinks, due dates, review related information and using CSS , High Graphs we mark a timeline in the student Assignment page which would display all the data with a hyperlink to navigate to that page easily.

After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Edge Cases==

* When the student doesn't submit the assignment on time , due date passed would be shown in the timeline.
* If the hyperlink submitted by student doesnt get submitted properly, it would not show any link to hyperlink on timeline.
* If the review is not done before the deadline,review link doesn't appear on the timeline and alos shows that due date is passed on timeline.

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:19:02Z

Nsompal: /* Approach to solve the problem */

== About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities. It also allows students to be active on it for completing the assignments and submitting the assignments. Student can view assignments, check the due dates of an assignment, submit an assignment, do peer review, suggest topics, give author feedback and many more in Expertiza.

== Background of the Project==

Through Expertiza students can currently submit their work, review others work, give author feedback , see the deadlines for an assignment. But there is no place that shows the time that a student is submitting an assignment/ work. Every time student wants to check a due date or stage deadline for an assignment, he has to go to that particular page to see it. There is a chance that student might forget to submit for that particular time. So, in order to make it easier for the student, it would be great to implement a timeline that shos deadlines, submitted works etc., with timestamps at one place.

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a '''timeline''', which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

''This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.''

==Design principles followed==
*Dry Principle - We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.
*Polymorphism - We will use polymorphism to provide a single interface to entities of different types.
*MVC - The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
*CSS - As we are using CSS to design timeline we follow proper CSS standards to develop the project.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Student_page.png]]

===Approach to solve the problem===
In this project, a timeline in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
. We will be using HighGraphs to generate the timeline.
We take the data necessary for each stage for the student from the database tables mentioned below and allow them to appear on the timeline with the time stamps.
The database tables we use for fetching the data are :

*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

By fetching the data from the tables necessary regarding the hyperlinks, due dates, review related information and using CSS , High Graphs we mark a timeline in the student Assignment page which would display all the data with a hyperlink to navigate to that page easily.

After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:18:03Z

Nsompal: /* Approach to solve the problem */

== About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza also sends automated emails to the instructor, reviewers and participants for most of the above mentioned activities. It also allows students to be active on it for completing the assignments and submitting the assignments. Student can view assignments, check the due dates of an assignment, submit an assignment, do peer review, suggest topics, give author feedback and many more in Expertiza.

== Background of the Project==

Through Expertiza students can currently submit their work, review others work, give author feedback , see the deadlines for an assignment. But there is no place that shows the time that a student is submitting an assignment/ work. Every time student wants to check a due date or stage deadline for an assignment, he has to go to that particular page to see it. There is a chance that student might forget to submit for that particular time. So, in order to make it easier for the student, it would be great to implement a timeline that shos deadlines, submitted works etc., with timestamps at one place.

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a '''timeline''', which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

''This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.''

==Design principles followed==
*Dry Principle - We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.
*Polymorphism - We will use polymorphism to provide a single interface to entities of different types.
*MVC - The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view, and controller, respectively).
*CSS - As we are using CSS to design timeline we follow proper CSS standards to develop the project.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Student_page.png]]

===Approach to solve the problem===
In this project, a timeline in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.
We take the data necessary for each stage for the student from the database tables mentioned below and allow them to appear on the timeline with the time stamps.
The database tables we use for fetching the data are :

*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

By fetching the data from the tables necessary regarding the hyperlinks, due dates, review related information and using CSS , High Graphs we mark a timeline in the student Assignment page which would display all the data with a hyperlink to navigate to that page easily.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:15:49Z

Nsompal: /* Design Analysis */

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:11:25Z

Nsompal: /* Design Analysis */

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:00:53Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T19:00:39Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-16T18:38:58Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-15T23:07:53Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-15T23:07:16Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-15T23:05:05Z

Nsompal:

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-15T23:03:16Z

Nsompal:

== About Expertiza==

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-15T23:02:37Z

Nsompal: /* Objective */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.
To Develop a Timeline to have timestamps for all the submissions made, the files uploaded, due dates etc., for the student to ahve easy access tpo them. Student should be able to navigate to that page through the link provided in timeline.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:34:10Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table

==Databases Involved==
*Review Mappings Table
*Response Table
*Due Dates Table
*Teams Table is used to get data about Files and Hyperlinks submitted
*New Reviews will be looked in from Response table
*Review Mapping table will be used for the review ID
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:30:23Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
Though the instructor can see the submission records of students currently as a table for each assignment, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

This project was earlier rejected as the timeline had to be scrolled to be viewed completely. So, in this project we intend to develop a timeline omitting the need to scroll and being concise.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:27:45Z

Nsompal: /* TDD */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
'''student_submission_timestamps_spec.rb''' would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:27:13Z

Nsompal: /* UI Testing */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
student_submission_timestamps_spec.rb would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

*'''Step1''' : Login to Expertiza as Student
*'''Step2''' : Click the Assignments Tab
*'''Step3''' : Select an Assignment of choice
*'''Step4''' : Select 'Your Work' Link and the Timeline would be displayed
*'''Step5''' : Submit a hyperlink in 'Your Work'
*'''Step6''' : The hyperlink submitted would be refelcted in the Timeline along with the Timestamp
*'''Step7''' : Click on the hyperlink displayed which would redirect to the submitted link page.
*'''Step8''' : Upload a File in 'Your Work'
*'''Step9''' : The uploaded filename would be reflected in the Timeline along with the Timestamp
*'''Step10''' : The displayed file could be downloaded and viewed by the student when clicked on the filename.
*'''Step11''' : Submit a review
*'''Step12''' : The submitted review link would be reflected in the Timeline along with the Timestamp and Round number
*'''Step13''' : Click on the review link displayed to be redirected to the submitted review link page.
*'''Step14''' : Submit an author feedback
*'''Step15''' : The submitted feedback link would be reflected in the Timeline along with the Timestamp
*'''Step16''' : Click on the feedback link displayed to be redirected to the submitted feedback link page.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:16:53Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
*Use case id:2
*Use case description: View due dates only when no submissions have been made
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
*Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
*Use case id:3
*Use case description: View hyperlink with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
*Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
*Use case id:4
*Use case description: View file name with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
*Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
*Use case id:5
*Use case description: View review links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
*Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
*Use case id:6
*Use case description: View author feedback links with timestamp upon submission
*Actor: Student
*Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
*Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
student_submission_timestamps_spec.rb would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.
The time line added should show the deadlines and the recently made changes to the project by reviewer or the author. It should also navigate author to the page he wants through the preview link provided for each stage in timeline.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-13T20:15:34Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Use Case Diagram==

[[File:UML_timeline1.png]]

'''1. Viewing the timeline'''
*Use case id:1
*Use case description: View timeline in 'Your work' page of selected assignment
*Actor: Student
*Precondition: Student should be logged into Expertiza
*Post condition: Student can view the due dates and timestamps of the activities, if any.

'''2. Viewing the due dates'''
Use case id:2
Use case description: View due dates only when no submissions have been made
Actor: Student
Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment
Post condition: Student will view only dues dates in timeline when no submissions are made.

'''3. Viewing hyperlink submissions in timeline'''
Use case id:3
Use case description: View hyperlink with timestamp upon submission
Actor: Student
Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have made a hyperlink submission
Post condition: Student will view hyperlink of the submitted link with timestamp in timeline

'''4. Viewing files uploaded in timeline'''
Use case id:4
Use case description: View file name with timestamp upon submission
Actor: Student
Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a file
Post condition: Student will view file name with timestamp in timeline and would be able to download the file upon clicking on filename.

'''5. Viewing links to submitted reviews with round number'''
Use case id:5
Use case description: View review links with timestamp upon submission
Actor: Student
Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted a review
Post condition: Student will view review link with timestamp and round number in timeline and would be redirected to the review submission upon clicking on the link.

'''6. Viewing links to author feedback'''
Use case id:6
Use case description: View author feedback links with timestamp upon submission
Actor: Student
Precondition: Student should be logged into Expertiza, should be in 'Your work' page of selected assignment, should have submitted an author feedback
Post condition: Student will view author feedback link with timestamp in timeline and would be redirected to the author feedback submission upon clicking on the link.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
student_submission_timestamps_spec.rb would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.
The time line added should show the deadlines and the recently made changes to the project by reviewer or the author. It should also navigate author to the page he wants through the preview link provided for each stage in timeline.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-10T16:02:55Z

Nsompal: /* TDD */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.
student_submission_timestamps_spec.rb would be created and the tests are run.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.
The time line added should show the deadlines and the recently made changes to the project by reviewer or the author. It should also navigate author to the page he wants through the preview link provided for each stage in timeline.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-10T14:59:25Z

Nsompal: /* UI Testing */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.
The time line added should show the deadlines and the recently made changes to the project by reviewer or the author. It should also navigate author to the page he wants through the preview link provided for each stage in timeline.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-10T14:58:02Z

Nsompal: /* TDD */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.
Test cases for the functioning of the timeline would be added before development and would be implemented in the project to make tests pass.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-10T14:52:45Z

Nsompal: /* Design Analysis */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed). We will be using HighGraphs to generate the timeline.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017

2017-11-07T21:56:36Z

Nsompal:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System]]
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas]]
*[[CSC/ECE 517 Fall 2017/M1754_Mutation_Testing]]
*[[CSC/ECE 517 Fall 2017/E1794. Student-generated questions added to rubric]]
*[[CSC/ECE 517 Fall 2017/E17A6. Fix account creation over web to work reasonably]]
*[[CSC/ECE 517 Fall 2017/E1792 OSS Visualizations for instructors]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment_Team34]]
*[[CSC/ECE 517 Fall 2017/E17A7_Allow_Reviewers_to_bid_on_what_to_review]]

'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas API]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017/E17A7 Allow Reviewers to bid on what to review

2017-11-07T21:55:28Z

Nsompal: Created page with "==Page== New page"

==Page==
New page

CSC/ECE 517 Fall 2017

2017-11-07T21:54:37Z

Nsompal:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System]]
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas]]
*[[CSC/ECE 517 Fall 2017/M1754_Mutation_Testing]]
*[[CSC/ECE 517 Fall 2017/E1794. Student-generated questions added to rubric]]
*[[CSC/ECE 517 Fall 2017/E17A6. Fix account creation over web to work reasonably]]
*[[CSC/ECE 517 Fall 2017/E1792 OSS Visualizations for instructors]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment_Team34]]

'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas API]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017

2017-11-07T21:53:42Z

Nsompal:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System]]
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas]]
*[[CSC/ECE 517 Fall 2017/M1754_Mutation_Testing]]
*[[CSC/ECE 517 Fall 2017/E1794. Student-generated questions added to rubric]]
*[[CSC/ECE 517 Fall 2017/E17A6. Fix account creation over web to work reasonably]]
*[[CSC/ECE 517 Fall 2017/E1792 OSS Visualizations for instructors]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment_Team34]]
*[[CSC/ECE 517 Fall 2017/E17A7 Allow reviewers to bid on what to review]]
'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1753_OffscreenCanvas API]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-07T00:11:34Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-07T00:11:13Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-07T00:10:21Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.(Actual visualization of the page might differ from the static page displayed)

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-07T00:06:54Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

[[File:Student_page_after_edit.png]]

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:15:28Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statemen==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:14:45Z

Nsompal:

===Objective===
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

===Problem Statement===
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

===Design Analysis===
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

===Files involved===

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

===Test Plan===
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:14:07Z

Nsompal: /* Test Plan */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

===Test Plan===
====TDD====
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:13:44Z

Nsompal: /* Test Plan */

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
===TDD===
For testing the new functionality TDD approach will be followed.

===UI Testing===
The newly added functionality would be tested manually by the UI testing.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:12:57Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
===TDD===
For testing the new functionality TDD approach will be followed.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:11:50Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Files involved==

*app/controllers/submission_records_controller.rb
*app/models/submission_record.rb
*app/views/student_task/list.html.erb
*The database tables involved for the work is review mappings table, response table, due dates table
*Due Dates will be taken from Due Dates table which has topic Id and assignment Id
*Review Mapping table will be used for the review ID
*Files and the Hyperlinks submitted will be taken from teams table
*New Reviews will be looked in from Response table

==Test Plan==
For testing the new functionality TDD approach will be followed.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T23:02:25Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Login → Assignments → Choose a particular Assignment

[[File:Login_page.png]]

[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline as shown below.

==Test Plan==

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T22:58:44Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Assignments → Choose a particular Assignment
[[File:Login_page.png]]
[[File:Student_page.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T22:57:50Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Assignments → Choose a particular Assignment
[[File:Student_Task.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.
After the addition of the functionality, the student task list page would have the timeline

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T22:46:34Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Assignments → Choose a particular Assignment
[[File:Student_Task.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.

CSC/ECE 517 Fall 2017/E1797 Timestamps for students submissions

2017-11-06T22:46:06Z

Nsompal:

==Objective==
To develop a feature for Expertiza to visualize the timeline using student submission timestamps, thereby enabling the student to navigate to the submissions records easily.

==Problem Statement==
The instructor can see the submission records of students currently as a table for each assignment. But, student can't see the timestamps of submissions and deadlines of the assignment easily. In this project student should be able to visualize the submission records as a timeline, which includes
*Timestamps of hyperlink submission records
*Timestamps of file upload record
*Due Dates
*Peer review link with round number and timestamps
*Author feedback to other’s review link with feedback hyperlink, timestamps
This project proposes a solution to include the timeline with all the hyperlinks necessary.

==Design Analysis==
Currently when a student logs into Expertiza, he could see the student task list page. He could access them by following the path

*Assignments → Choose a particular Assignment
[[File:Student_task.png]]

In this project a time line in the student task list page would be added to navigate student to the due dates and the necessary links easily and keep a track of them.