Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-15T00:48:24Z

Apshukla: /* Hide all assignment nodes on tree display */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

=='''Design Pattern'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
'''Model''': send_sync_message method with expertiza_support_helper(new helper class defining the body of email) will be responsible for sending email to expertiza support. 
'''Controller''': Feedback form submission should call MailerHelper’s send_sync_message method with the appropriate parameters specifying that an expertiza user is facing some issue. 
'''View''': A new expertiza contact support form to be created with fields email id, description of issue, captcha and submit button.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
A UI change replacing displaying tree with an icon. On click event will create a pop up panel. User selection will trigger the appropriate action(this functionality will not be changed).

===Hide all assignment nodes on tree display===
A link "Hide" to be added on assignment page. Method for hiding the section to be implemented. Clicking "Hide" link will call this new method.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-15T00:47:28Z

Apshukla: /* Hide all assignment nodes on tree display */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

=='''Design Pattern'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
'''Model''': send_sync_message method with expertiza_support_helper(new helper class defining the body of email) will be responsible for sending email to expertiza support. 
'''Controller''': Feedback form submission should call MailerHelper’s send_sync_message method with the appropriate parameters specifying that an expertiza user is facing some issue. 
'''View''': A new expertiza contact support form to be created with fields email id, description of issue, captcha and submit button.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
A UI change replacing displaying tree with an icon. On click event will create a pop up panel. User selection will trigger the appropriate action(this functionality will not be changed).

===Hide all assignment nodes on tree display===
A link "Hide" to be added on assignment page. Method for hiding the section to be added. Clicking "Hide" link will call this new method.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-15T00:46:25Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

=='''Design Pattern'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
'''Model''': send_sync_message method with expertiza_support_helper(new helper class defining the body of email) will be responsible for sending email to expertiza support. 
'''Controller''': Feedback form submission should call MailerHelper’s send_sync_message method with the appropriate parameters specifying that an expertiza user is facing some issue. 
'''View''': A new expertiza contact support form to be created with fields email id, description of issue, captcha and submit button.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
A UI change replacing displaying tree with an icon. On click event will create a pop up panel. User selection will trigger the appropriate action(this functionality will not be changed).

===Hide all assignment nodes on tree display===
A link "Hide" to be added on assignment page. Method for hiding the section to be added. Clicking "hide" link will call this new method.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-15T00:45:55Z

Apshukla: /* Design Pattern */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

=='''Design Pattern'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
'''Model''': send_sync_message method with expertiza_support_helper(new helper class defining the body of email) will be responsible for sending email to expertiza support.
'''Controller''': Feedback form submission should call MailerHelper’s send_sync_message method with the appropriate parameters specifying that an expertiza user is facing some issue.
'''View''': A new expertiza contact support form to be created with fields email id, description of issue, captcha and submit button.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
A UI change replacing displaying tree with an icon. On click event will create a pop up panel. User selection will trigger the appropriate action(this functionality will not be changed).

===Hide all assignment nodes on tree display===
A link "Hide" to be added on assignment page. Method for hiding the section to be added. Clicking "hide" link will call this new method.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-15T00:21:17Z

Apshukla: /* Use Cases */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

=='''Design Pattern'''==

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-11T03:20:43Z

Apshukla: /* A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 or 4 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-11T03:20:24Z

Apshukla: /* A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer reviewing of team projects and submission of project design documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution to the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
The current implementation of expertiza does not provide any feature for users to send feedback in case they face any problem. This new feature allows a user to send a complaint or feedback to expertiza support via email. Captcha needs to be implemented so as to prevent the abuse of the this feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

[[File:treeDisplay.jpg]]

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and issue description and captcha as input. The email id is auto-filled from the user profile.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support and acknowledgement displayed to user.

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

File:TreeDisplay.jpg

2016-11-11T03:18:26Z

Apshukla:

[[File:treeDisplay.jpg]]

File:TreeDisplay.jpg

2016-11-11T03:17:55Z

Apshukla: tree display

tree display

File:Menu.png

2016-11-11T03:11:11Z

Apshukla:

[[File:menu.jpg]]

File:Menu.png

2016-11-11T03:10:28Z

Apshukla: expertiza tree display

expertiza tree display

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-10T00:05:59Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''Input:''' User clicks on Expertiza Support and provides email id, issue description and captcha as input.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support

[[File:UseCaseDiagram.jpg]]

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-10T00:05:34Z

Apshukla: /* Use Cases */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

[[File:UseCaseDiagram.jpg]]
*'''Input:''' User clicks on Expertiza Support and provides email id, issue description and captcha as input.
*'''Type of Input:''' Feedback Form
*'''Source of Input:''' User interface
*'''Processing:''' Validate input fields and form submit
*'''Outputs:''' Email sent to Expertiza support

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T23:59:22Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
[[File:UseCaseDiagram.jpg]]

The above figure shows the use case diagram for the project.
==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:14:55Z

Apshukla: /* Testing Plan */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===
*'''T.1: ''' Contact Support’ button should be seen to all the users (even unauthenticated).
*'''T.2: ''' For unauthenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with blank email id field, description and captcha
*'''T.3: ''' For authenticated users, clicking on ‘Contact Support’ should redirect to feedback support form page with email id auto-filled with email on their profile, description and captcha.
*'''T.4: ''' Before form submission, none of the fields should be blank. Appropriate blank error message should be shown otherwise.
*'''T.5: ''' Captcha should be random on every page load. Error message saying ‘incorrect captcha’ should be shown in case user fails to provide the same text of captcha.
*'''T.6: ''' Email should be received to Expertiza support “expertiza-support@lists.ncsu.edu” on the form submission and the user should get an acknowledgement of email received.

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:11:55Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users. 
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue. 
4. This form should have field email auto filled with email on user profile if the user has logged in. 
5. This form should provide random captcha to prevent abuse of this feature. 
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”. 
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible. 

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:11:17Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website. 
2. Create a feedback support form page which should be available to all the users including unauthenticated users.
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue.
4. This form should have field email auto filled with email on user profile if the user has logged in.
5. This form should provide random captcha to prevent abuse of this feature.
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”.
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:09:45Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:

1. Provide ‘Contact Support’ button on top of website.
2. Create a feedback support form page which should be available to all the users including unauthenticated users.
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue.
4. This form should have field email auto filled with email on user profile if the user has logged in.
5. This form should provide random captcha to prevent abuse of this feature.
6. Submitting this feedback form page should trigger email to “[[expertiza-support@lists.ncsu.edu]]”.
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:08:46Z

Apshukla: /* Headline text */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:
===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:08:03Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:
== Headline text ==

1. Provide ‘Contact Support’ button on top of website.
2. Create a feedback support form page which should be available to all the users including unauthenticated users.
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue.
4. This form should have field email auto filled with email on user profile if the user has logged in.
5. This form should provide random captcha to prevent abuse of this feature.
6. Submitting this feedback form page should trigger email to “expertiza-support@lists.ncsu.edu”.
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:07:32Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===
This design unit includes following tasks:
1. Provide ‘Contact Support’ button on top of website.
2. Create a feedback support form page which should be available to all the users including unauthenticated users.
3. The form page should have fields for email Id for fetching email id of the user facing issue, a description input box where user can describe the steps for reproducing the issue.
4. This form should have field email auto filled with email on user profile if the user has logged in.
5. This form should provide random captcha to prevent abuse of this feature.
6. Submitting this feedback form page should trigger email to “expertiza-support@lists.ncsu.edu”.
7. The project should provide User with an acknowledgment saying email has been seen and Expertiza Support will try to fix the issue as soon as possible.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:05:50Z

Apshukla: /* Product Requirements */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

=='''Product Requirements'''==

===Provide a new UI which allows users to send emails to expertiza support Background===

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:04:38Z

Apshukla: /* Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

=='''Background'''==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

==Product Requirements==

===Provide a new UI which allows users to send emails to expertiza support Background===

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:04:14Z

Apshukla: /* Provide a new UI which allows users to send emails to expertiza support Background */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

==Background==
===Provide a new UI which allows users to send emails to expertiza support Background===
For understanding Expertiza support feature, reader should be aware of the use of captcha. This needs to be implemented so as to prevent the abuse of the support feature.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

==Product Requirements==

===Provide a new UI which allows users to send emails to expertiza support Background===

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

CSC/ECE 517 Fall 2016/E1688. Send feedback to support + tree display improvement

2016-11-09T20:00:10Z

Apshukla: /* Purpose */

== '''Introduction to Expertiza''' ==

Expertiza is an open source software to create reusable learning objects through peer review supporting team projects and submission of project documents. In the final project, there are two major changes that will help in improving user experience.

=='''Purpose'''==

The purpose of this project is:
===Provide a new UI which allows users to send emails to expertiza support Background===
This feature will help expertiza users to achieve faster resolution for the problems they face. A new UI support needs to be given to enable them to directly send the issues they face to expertiza support through email.

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
The purpose of this enhancement is to reduce the wastage of space on the Manage Assignments page.

===Hide all assignment nodes on tree display===
The purpose of this enhancement is to give a way for the user to hide all assignment nodes on tree display.

==Background==
===Provide a new UI which allows users to send emails to expertiza support Background===

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
Currently the data to be displayed for each assignment takes 2 lines whereas the “actions” icons are taking up 3 lines for display. This is a wastage of space on the screen.

===Hide all assignment nodes on tree display===
When a user clicks on any of the course node in My Courses, it opens up a tree display listing all the assignments available for this particular course node. There doesn’t exist a way to hide the assignment nodes after displaying them.

==Product Requirements==

===Provide a new UI which allows users to send emails to expertiza support Background===

===A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display===
To eliminate the extra space on Manage Assignments page because of less data and more “actions” icons, we will replace all the “actions” icons with a single “actions” icon embedded with a pop up panel. So when a user clicks on this new “actions” icon, it will throw a pop up containing all these previous “actions” icons and the user can select one of them to invoke one of these actions (edit, delete, add participant, create teams, etc...).

===Hide all assignment nodes on tree display===
My courses shows a list of all course nodes. Clicking on one of these nodes opens up a list of assignment nodes related to the course node. This requirement will add the functionality to allow a user to hide this list of assignment nodes after displaying them. So after getting the expanded view of assignment nodes, we will provide an extra functionality to the user to hide these assignment nodes which invokes a hide action on assignment nodes.

=='''Use Cases'''==
==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
Provide a new icon in “actions” on tree display, then when you click on this new icon a new popup appears. This popup has all the previous “actions”
*'''Input:''' User clicks on new icon
*'''Description:''' new popup appears with all actions in it
*'''Type of Input:''' Click on the new icon
*'''Source of Input:''' User interface
*'''Processing:''' Create popup
*'''Outputs:''' Pop up Panel displaying all the previous “actions” icons for the user to choose from.

==='''Hide all assignment nodes on tree display'''===
*'''Input:''' User clicks on Hide link on Course nodes page.
*'''Description''': Hide the expanded view of Assignment nodes on Course nodes page.
*'''Type of Input:''' Click on the Hide link.
*'''Source of Input:''' User interface
*'''Processing:''' Invoke the Hide Assignment nodes action on Course nodes page.
*'''Output:''' Only Course nodes are listed.

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

==='''Provide a new UI which allows users to send emails to expertiza support Background'''===

==='''A single “actions” icon with a pop up panel in place of the currently existing “action” icons on tree display'''===
*'''T.1: ''' Ensure that when a user click on the new “actions” icon, it throws a pop up panel with all the old “actions” icons.
*'''T.2: ''' Ensure that Edit icon redirects the user to edit assignment view.
*'''T.3: ''' Ensure that Delete icon deletes the assignment.
*'''T.4: ''' Ensure that Add TA icon redirects the user to Add TA view.
*'''T.5: ''' Ensure that Add Participant icon redirects the user to Add Participant view.
*'''T.6: ''' Ensure that Create Teams icon redirects the user to Create Teams view.
*'''T.7: ''' Ensure that Create Assignment icon redirects the user to Create Assignment view.
*'''T.8: ''' Ensure that 360 assessment dashboard icon redirect user to One_course_all_assignments page of assessment360 view.
*'''T.9: ''' Ensure that Copy icon redirects user to Edit course page.
*'''T.10: ''' Ensure that Make public icon redirects user to the tree display page.

==='''Hide all assignment nodes on tree display'''===
*'''T.1''' Ensure that when a user clicks on the Hide button/link to hide the assignment nodes, the view only displays course nodes and not the related list of assignment nodes.

User:Cbaruah

2016-10-29T01:07:31Z

Apshukla: /* UI testing of participant addition via CSV file and e-mail delivery check */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

[[Expertiza]] is an open source project based on [[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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* An e-mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, an e-mail is sent to a reviewer saying a new submission is available for a particular review round. Thus, the reviewer will be able to see the review round number.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for response to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response to the advertisement will be sent to the students who created advertisement.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T01:06:59Z

Apshukla: /* UI testing of file submission */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

[[Expertiza]] is an open source project based on [[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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, an e-mail is sent to a reviewer saying a new submission is available for a particular review round. Thus, the reviewer will be able to see the review round number.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for response to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response to the advertisement will be sent to the students who created advertisement.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T01:01:15Z

Apshukla: /* UI testing for responding to an advertisement */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

[[Expertiza]] is an open source project based on [[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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for response to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response to the advertisement will be sent to the students who created advertisement.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T01:00:41Z

Apshukla: /* UI testing for responding to an advertisement */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

[[Expertiza]] is an open source project based on [[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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for responding to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response to the advertisement will be sent to the students who created advertisement.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:57:11Z

Apshukla: /* UI testing for responding to an advertisement */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for responding to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response will be sent to the students who created advertisement.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:56:40Z

Apshukla: /* Testing Details */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password

We would request you to create at least 3-4 users more to test all the functionality pertaining to this project.
This is because teams can be created and all the functionality with respect to email notifications can be tested.

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

==== UI testing for responding to an advertisement ====
* Login as student. Go to assignment page.
* Go to your team and create an advertisement for this assignment.
* Login as some other student who is the participant of the same assignment. Go to assignment page and open sign up sheet.
* For the topic assigned to the student who created advertisement, an icon will appear in advertisement tab.
* Clicking on this icon will redirect the student to page where student can request to join the team of students who created advertisement.
* On click of request button, an e-mail of this response will be sent to the students who created advertisement.

* When a team member responds to an advertisement, the student who hosted it gets an e-mail of this response.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:33:17Z

Apshukla: /* UI testing for sending/accepting invitation to join team */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. An e-mail is getting triggered to that student saying a new invite has been sent.
* When the other student accepts it, another e-mail is triggered back to the invitee saying the invite has been accepted.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:30:25Z

Apshukla: /* Scope for Future Improvement */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned.

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So, this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:21:46Z

Apshukla: /* UI testing of participant addition via CSV file and mail delivery check */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and e-mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant not having expertiza account to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:19:25Z

Apshukla: /* Scope for Future Improvement */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* An e-mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such e-mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:14:56Z

Apshukla: /* Current Implementation */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
# controllers/submitted_content_controller
# helpers/mailer_helper
# app/views/mailer/partials/_file_submission_plain.html.erb
# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
# controllers/invitation_controller
# helpers/participants_helper
# app/views/mailer/partials/_team_join_invite_html.html.erb
# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
# app/views/mailer/partials/_team_accept_invite_html.html.erb
# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
# app/views/mailer/partials/_response_to_advertisement.html.erb
# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:14:14Z

Apshukla: /* Current Implementation */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
# controllers/import_file_controller.rb
*# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
*# controllers/submitted_content_controller
*# helpers/mailer_helper
*# app/views/mailer/partials/_file_submission_plain.html.erb
*# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4.1 E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
*# controllers/invitation_controller
*# helpers/participants_helper
*# app/views/mailer/partials/_team_join_invite_html.html.erb
*# app/views/mailer/partials/_team_join_invite_plain.html.erb

4.2 Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
*# app/views/mailer/partials/_team_accept_invite_html.html.erb
*# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
*# app/views/mailer/partials/_response_to_advertisement.html.erb
*# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:12:44Z

Apshukla: /* Current Implementation */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
*# controllers/import_file_controller.rb
*# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
*# controllers/submitted_content_controller
*# helpers/mailer_helper
*# app/views/mailer/partials/_file_submission_plain.html.erb
*# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.

4. E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
*# controllers/invitation_controller
*# helpers/participants_helper
*# app/views/mailer/partials/_team_join_invite_html.html.erb
*# app/views/mailer/partials/_team_join_invite_plain.html.erb
* Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
*# app/views/mailer/partials/_team_accept_invite_html.html.erb
*# app/views/mailer/partials/_team_accept_invite_plain.html.erb

5. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
*# app/views/mailer/partials/_response_to_advertisement.html.erb
*# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-29T00:11:54Z

Apshukla: /* Current Implementation */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

1. When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So, this issue is fixed by implementing the functionality of sending e-mail when account creation is done in this case. Now, e-mail is getting triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality.
*# controllers/import_file_controller.rb
*# helpers/import_file_helper

2. Evidently, if a file is revised after review, the system e-mails the reviewer saying to revise the review. The method to implement this was in place but wasn't working. This issue is fixed. Note that the e-mail is only triggered for a file submission and there is no mailer functionality in place for URL submission. Also, after the last round of review is completed, e-mail is no longer is getting triggered as desired. The listed files were updated or created to get the functionality working.
*# controllers/submitted_content_controller
*# helpers/mailer_helper
*# app/views/mailer/partials/_file_submission_plain.html.erb
*# app/views/mailer/partials/_file_submission_html.html.erb

3. The message body of the e-mail now includes the round of the review stage for which the review is provided along with a link to the site. Files changed are same as mentioned in second point.
* E-mail is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
*# controllers/invitation_controller
*# helpers/participants_helper
*# app/views/mailer/partials/_team_join_invite_html.html.erb
*# app/views/mailer/partials/_team_join_invite_plain.html.erb
* Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are same as mentioned in the 4th point. New views are created for this functionality
*# app/views/mailer/partials/_team_accept_invite_html.html.erb
*# app/views/mailer/partials/_team_accept_invite_plain.html.erb

4. Mail is also getting triggered when a student responds to a teammate advertisement. The controller and helper class changed are same as mentioned in the 4th point. New views are created for this functionality.
*# app/views/mailer/partials/_response_to_advertisement.html.erb
*# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-28T23:47:41Z

Apshukla: /* Motivation */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails, RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the students on their account creation and to the reviewer when a submission of work is done. The scope of this project is to improve the present email notifications and also plug gaps in some implementations.

===Current Implementation===

* When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So this functionality of account creation was fixed. No mail is triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality
*# controllers/import_file_controller.rb
*# helpers/import_file_helper

* Evidently if a file is revised after review, the system e-mails the reviewer saying to revise the review. This method was provided but wasn't working. This functionality was fixed and successfully implemented(Mail is only triggered for a file submission. For link submission their is no mailer functionalities). Also after the last round of review is over, mail is no longer triggered. The listed files were updated or created to get the functionality working.
*# controllers/submitted_content_controller
*# helpers/mailer_helper
*# app/views/mailer/partials/_file_submission_plain.html.erb
*# app/views/mailer/partials/_file_submission_html.html.erb

* The message body of the mail is fixed to include the round of the review stage for which the review is provided along with a link to the site. Files are same as mentioned in second point.
* Email is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
*# controllers/invitation_controller
*# helpers/participants_helper
*# app/views/mailer/partials/_team_join_invite_html.html.erb
*# app/views/mailer/partials/_team_join_invite_plain.html.erb
* Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are the same as mentioned in the 4th point. Although new views had to be created for this functionality
*# app/views/mailer/partials/_team_accept_invite_html.html.erb
*# app/views/mailer/partials/_team_accept_invite_plain.html.erb
* Mail is also triggered when a student responds to a teammate advertisement. The controller and helper class are the same as mentioned in the 4th point. Although new views had to be created for this functionality.
*# app/views/mailer/partials/_response_to_advertisement.html.erb
*# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]

User:Cbaruah

2016-10-28T23:37:44Z

Apshukla: /* Expertiza Background */

= CSC/ECE 517 Fall 2016 E1655/OSS Improve e-mail notification =

===Peer Review Information===

For users intending to view the deployed Expertiza associated with this assignment, the credentials are as follows:

* Instructor Login: Username: instructor6 , password: password
* Student Login: Username: student5432 , password: password
* Student Login: Username: testing11, password: password
* Student Login: Username: testing12, password: password

===Expertiza Background===

Expertiza is an open source project based on 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 student's submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

Mailers in Expertiza have their association with many other components like Users, Courses, Reviews, Participants and Invitations. The Mailer Helper in specific invokes methods which perform mailer related functions like sending email to newly created user, sending email to reviewer etc.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently, the mailer notifies the participants when a new user is created, to the reviewer when a submission of work is done. The scope of this project is to improve the present mail notifications and also plug gaps in some implementations.

===Current Implementation===

* When students' accounts are created by importing a CSV file on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. So this functionality of account creation was fixed. No mail is triggered to the concerned user whenever their account is created regardless of how their account is created. The listed files were manipulated for updating this functionality
*# controllers/import_file_controller.rb
*# helpers/import_file_helper

* Evidently if a file is revised after review, the system e-mails the reviewer saying to revise the review. This method was provided but wasn't working. This functionality was fixed and successfully implemented(Mail is only triggered for a file submission. For link submission their is no mailer functionalities). Also after the last round of review is over, mail is no longer triggered. The listed files were updated or created to get the functionality working.
*# controllers/submitted_content_controller
*# helpers/mailer_helper
*# app/views/mailer/partials/_file_submission_plain.html.erb
*# app/views/mailer/partials/_file_submission_html.html.erb

* The message body of the mail is fixed to include the round of the review stage for which the review is provided along with a link to the site. Files are same as mentioned in second point.
* Email is triggered to an invitee whenever a participant sends out an invitation to another participant to join a team. The listed files were updated or created to get the functionality working.
*# controllers/invitation_controller
*# helpers/participants_helper
*# app/views/mailer/partials/_team_join_invite_html.html.erb
*# app/views/mailer/partials/_team_join_invite_plain.html.erb
* Whenever the invitee accepts the invitation, the student who issued the invitation gets a mail stating that the invitee has accepted his/her invitation. The controller and helper class are the same as mentioned in the 4th point. Although new views had to be created for this functionality
*# app/views/mailer/partials/_team_accept_invite_html.html.erb
*# app/views/mailer/partials/_team_accept_invite_plain.html.erb
* Mail is also triggered when a student responds to a teammate advertisement. The controller and helper class are the same as mentioned in the 4th point. Although new views had to be created for this functionality.
*# app/views/mailer/partials/_response_to_advertisement.html.erb
*# app/views/mailer/partials/_response_to_advertisement.html.erb

===Files modified in current project===
====Classes====
* controllers/import_file_controller
* controllers/submitted_content_controller
* controllers/invitation_controller
* helpers/import_file_helper
* helpers/participants_helper
* helpers/mailer_helper

====About import_file_controller====

This controller derives from the Application Controller. It states the functionality of importing any kind of file like csv, xls, doc into the application. It defines the import function which takes the 'session' and 'params' as output and provides success message on successful import. It also provides the functionality of specifying the delimiter in the file which is being imported. The ImportFile method defined in the controller reads the file row by row based on the model concerned. The modified code snippet is

====About submitted_content_controller====

This controller also derives from the Application Controller. It states the CRUD operations on submitting the file or hyperlink for assignment. It provides functionality to download, create folder and delete folder after submission. It provides the functionality for submitting links and submitting hyperlinks separately.

prepared_mail = MailerHelper.send_mail_to_reviewer(User.find(participant.user_id), "A new submission is available", "file_submission", "file submission", Assignment.find(participant.parent_id).name)
prepared_mail.deliver

==== About invitation_controller ====
This controller also derives from the Application Controller. It states the CRUD as well as other basic operations when an invitation is sent by an user to any participant to join their team. It provides the functionality to send and accept invitations as well as to reject invitations and leave team.

# To send mail request to invitees to join team
prepared_mail = MailerHelper.send_mail_for_invitation(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About import_file_helper ====
This is a helper file for the '''import_file_controller''' class which stores the attributes from the controller class as well as creates new users when user are created by importing a CSV file.

def self.create_new_user(attributes, session)
user = User.new(attributes)
user.parent_id = (session[:user]).id
user.timezonepref = User.find(user.parent_id).timezonepref
user.save!
prepared_mail = MailerHelper.send_mail_to_user(user, "Your Expertiza account and password have been created.", "user_welcome", user.password)
prepared_mail.deliver
user
end

==== About participants_helper ====
This is a helper file for the '''participants_controller''' class. It provides some of the basic functionalities that is required to create participants that are added to expertiza.

def self.create_new_user(attrs, session)
user = User.new
user.update_attributes attrs
user.parent_id = (session[:user]).id
user.save
password = @user.reset_password
prepared_mail = MailerHelper.send_mail_to_user(@user, "Your Expertiza account and password have been created.", "user_welcome", password)
prepared_mail.deliver
flash[:success] = "A new password has been sent to new user's e-mail address."
user
end

==== About mailer_helper ====
This helper file is for the '''mailer''' class. Its creates the structure of the mail body that is needed by the mailer class to send mails. It also holds all the attributes that are required to send a mail.

def self.send_mail_to_reviewer(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_invitation(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

def self.send_mail_for_advertisement_response(user, subject, partial_name, type, obj_name)
Mailer.sync_message ({
to: user.email,
subject: subject,
body: {
type: type,
obj_name: obj_name,
user: user,
first_name: ApplicationHelper.get_user_first_name(user),
partial_name: partial_name
}
})
end

=== Files created in current project ===
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_team_join_invite_html.html.erb
* app/views/mailer/partials/_team_join_invite_plain.html.erb
* app/views/mailer/partials/_file_submission_html.html.erb
* app/views/mailer/partials/_file_submission_plain.html.erb
* app/views/mailer/partials/_team_accept_invite_html.html.erb
* app/views/mailer/partials/_team_accept_invite_plain.html.erb

===Testing Details===

==== UI testing of participant addition via CSV file and mail delivery check ====
* Login as instructor. Create a new course and assignment.
* Add new participant to an assignment using a import file option.
* A mail is triggered for participant who do not have an expertiza account.

==== UI testing of file submission ====
* Login as student. Go to assignment and open your work page.
* Upload a new file submission. If the submission is made in review stage, a mail is triggered to a reviewer saying a new submission is available for a particular review round.

==== UI testing for sending/accepting invitation to join team ====
* Login as student. Go to assignment and open your team page.
* Search for a student with whom you want to team up and click on send invite. A mail is triggered to that student saying a new invite has been sent.
* When the student accepts it, another mail is triggered back to the invitee saying the invite has been accepted.
* When a team member responds to an advertisement, the student who hosted it gets a mail about that response.

===Scope for Future Improvement===
* A mail is being triggered only when a file is submitted for revision. But on the submission of a link, no such mail is sent. So this is one of the areas which can be improved in the future.

===References===
https://github.com/cbaruah/expertiza.git

https://expertiza.ncsu.edu

http://research.csc.ncsu.edu/efg/expertiza

[https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg YouTube channel]

[https://hub.docker.com/r/winbobob/expertiza-fall2016/ How to install and run image file in docker]