Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016/E1698. Instructor/student control of anonymity + group-based reviewing

2016-11-11T19:17:28Z

Cbaruah: /* ScreenShots of pages to be modified */

=Introduction=
==Purpose==
'''Scenario:''' An instructor using Expertiza wants to do an experiment comparing anonymous review with identified (non-anonymous) review. And in general, there is quite a bit of research interest in the implications of anonymity in student interactions. In this experiment,

Approx ½ the class will conduct two rounds of formative reviews in small groups (4-5 students/group). The groups will stay the same for both rounds. The students in the groups should be able to see who they are reviewing and who is reviewing them.
For the non-anonymous groups, I'd like the students to be able to request group members, so I would want to be able to have some control, perhaps with an option to use random assignment to groups if they had no preference for group members.
Approx ½ the class will conduct two rounds of formative reviews anonymously (using the normal method we used this fall)

'''What needs to be done''': The Review Strategy tab of assignment creation needs have a new checkbox for anonymous reviews, which would be checked by default. If it is checked, student views would be the same as at present. If it is not checked, students would see their reviewers and grades in the same way as the instructor now sees them; thus, instead of seeing “Reviewer 1”, “Reviewer 2”, the student might see, “Anthony Adams”, “Bessie Brown”, etc.

The code for displaying names obviously already exists, because it is used in the instructor views. Implement the changes in an elegant way; for example, instead of checking multiple times in the view to determine whether the reviewer’s (or author’s) real name is to be displayed, try to send a message to a model class that will “do the right thing.” This may involve creating separate model classes for anonymous and identified review, so that messages could be sent polymorphically. It’s hard for me to know, without studying the code, whether this would simplify the code or clutter it, but please give some thought to what is the clearest and most robust way to code both anonymous & identified reviews, from the student’s and the instructor’s perspective.

The other piece of the project is to enable review within groups, which means that every student in a group will review every other student in the group (but no students outside the group). This can be configured on the Review Strategy tab when the review strategy is set to “Instructor-Selected”. Under the “Set number of reviews done by each student” box, there could be another one, “Review done in groups of [ ] students”, where “[ ]” is a small text box. There should also be an information button describing how group-based review works.

==Scope==
The project provides instructor a functionality to make assignment reviews to be anonymous or non-anonymous. In addition, instructors have authority to create and assign review groups (students assigned same review group will review each others work) randomly.This scenario will be valid for individual assignments only. Also, anonymity is taken care from the perspective of reviewer as well as the reviewee. In case of non-anonymous groups, students may have the option to invite other students to join their group provided group size is not exceeding the maximum limit.

==Background==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types as well as URLs for assignments.

=Design=

'''Assignment Creation:'''

Providing a checkbox in "review strategy tab" to mark an assignment to have anonymous or non-anonymous reviews. By default, every assignment will be having anonymous reviews but an instructor can change it by unchecking the checkbox.

'''Group Formation:'''

The instructor has the authority to create and assign groups randomly. In this case, students can not drop the group they have been assigned and only an instructor can change their group if needed.
In case, a group has not been assigned by an instructor, students will have the functionality to invite other students to join their group. This functionality is analogous to the invite members to join their team.
Students in the same group can review work of their group members only.

For this, we will be creating a separate model for groups and will store all the group information into the corresponding database table. In order to follow the DRY principle, we will try to integrate the group code with the code written for teams.

'''Non Anonymous Reviews'''

In the case of non-anonymous reviews, students will be able to see the names of all the group members who have graded their individual work. In addition, students can also see whose work they are going to grade so that the non-anonymity is maintained from both sides.

=Files to be Considered=
*reveiw_mapping_controller.rb

*teams_controller.rb

*team.rb

*views/assignments/edit/_review_strategy.html.erb

*views/grades/_reviews.html.erb

=Key People=
===Developers===
*Bhavesh Kasliwal
*Bhavya Bansal
*Chinmoy Baruah
*Rishabh Sinha

===Mentor===
*Ed Gehringer

File:ViewToBeChanged1.png

2016-11-11T19:09:00Z

Cbaruah:

CSC/ECE 517 Fall 2016/E1698. Instructor/student control of anonymity + group-based reviewing

2016-11-11T05:43:12Z

Cbaruah: /* ScreenShots of pages to be modified */

=Introduction=
==Purpose==
'''Scenario:''' An instructor using Expertiza wants to do an experiment comparing anonymous review with identified (non-anonymous) review. And in general, there is quite a bit of research interest in the implications of anonymity in student interactions. In this experiment,

Approx ½ the class will conduct two rounds of formative reviews in small groups (4-5 students/group). The groups will stay the same for both rounds. The students in the groups should be able to see who they are reviewing and who is reviewing them.
For the non-anonymous groups, I'd like the students to be able to request group members, so I would want to be able to have some control, perhaps with an option to use random assignment to groups if they had no preference for group members.
Approx ½ the class will conduct two rounds of formative reviews anonymously (using the normal method we used this fall)

'''What needs to be done''': The Review Strategy tab of assignment creation needs have a new checkbox for anonymous reviews, which would be checked by default. If it is checked, student views would be the same as at present. If it is not checked, students would see their reviewers and grades in the same way as the instructor now sees them; thus, instead of seeing “Reviewer 1”, “Reviewer 2”, the student might see, “Anthony Adams”, “Bessie Brown”, etc.

The code for displaying names obviously already exists, because it is used in the instructor views. Implement the changes in an elegant way; for example, instead of checking multiple times in the view to determine whether the reviewer’s (or author’s) real name is to be displayed, try to send a message to a model class that will “do the right thing.” This may involve creating separate model classes for anonymous and identified review, so that messages could be sent polymorphically. It’s hard for me to know, without studying the code, whether this would simplify the code or clutter it, but please give some thought to what is the clearest and most robust way to code both anonymous & identified reviews, from the student’s and the instructor’s perspective.

The other piece of the project is to enable review within groups, which means that every student in a group will review every other student in the group (but no students outside the group). This can be configured on the Review Strategy tab when the review strategy is set to “Instructor-Selected”. Under the “Set number of reviews done by each student” box, there could be another one, “Review done in groups of [ ] students”, where “[ ]” is a small text box. There should also be an information button describing how group-based review works.

==Scope==
The project provides instructor a functionality to make assignment reviews to be anonymous or non-anonymous. In addition, instructors have authority to create and assign review groups (students assigned same review group will review each others work) randomly.This scenario will be valid for individual assignments only. Also, anonymity is taken care from the perspective of reviewer as well as the reviewee. In case of non-anonymous groups, students may have the option to invite other students to join their group provided group size is not exceeding the maximum limit.

==Background==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types as well as URLs for assignments.

=Design=

'''Assignment Creation:'''

Providing a checkbox in "review strategy tab" to mark an assignment to have anonymous or non-anonymous reviews. By default, every assignment will be having anonymous reviews but an instructor can change it by unchecking the checkbox.

'''Group Formation:'''

The instructor has the authority to create and assign groups randomly. In this case, students can not drop the group they have been assigned and only an instructor can change their group if needed.
In case, a group has not been assigned by an instructor, students will have the functionality to invite other students to join their group. This functionality is analogous to the invite members to join their team.
Students in the same group can review work of their group members only.

For this, we will be creating a separate model for groups and will store all the group information into the corresponding database table. In order to follow the DRY principle, we will try to integrate the group code with the code written for teams.

'''Non Anonymous Reviews'''

In the case of non-anonymous reviews, students will be able to see the names of all the group members who have graded their individual work. In addition, students can also see whose work they are going to grade so that the non-anonymity is maintained from both sides.

=Files to be Considered=
*reveiw_mapping_controller.rb

*teams_controller.rb

*team.rb

*views/assignments/edit/_review_strategy.html.erb

*views/grades/_reviews.html.erb

=ScreenShots of pages to be modified=
[[File:InstructorPage.jpg]]

=Key People=
===Developers===
*Bhavesh Kasliwal
*Bhavya Bansal
*Chinmoy Baruah
*Rishabh Sinha

===Mentor===
*Ed Gehringer

CSC/ECE 517 Fall 2016/E1698. Instructor/student control of anonymity + group-based reviewing

2016-11-11T05:39:37Z

Cbaruah: Screenshots

=Introduction=
==Purpose==
'''Scenario:''' An instructor using Expertiza wants to do an experiment comparing anonymous review with identified (non-anonymous) review. And in general, there is quite a bit of research interest in the implications of anonymity in student interactions. In this experiment,

Approx ½ the class will conduct two rounds of formative reviews in small groups (4-5 students/group). The groups will stay the same for both rounds. The students in the groups should be able to see who they are reviewing and who is reviewing them.
For the non-anonymous groups, I'd like the students to be able to request group members, so I would want to be able to have some control, perhaps with an option to use random assignment to groups if they had no preference for group members.
Approx ½ the class will conduct two rounds of formative reviews anonymously (using the normal method we used this fall)

'''What needs to be done''': The Review Strategy tab of assignment creation needs have a new checkbox for anonymous reviews, which would be checked by default. If it is checked, student views would be the same as at present. If it is not checked, students would see their reviewers and grades in the same way as the instructor now sees them; thus, instead of seeing “Reviewer 1”, “Reviewer 2”, the student might see, “Anthony Adams”, “Bessie Brown”, etc.

The code for displaying names obviously already exists, because it is used in the instructor views. Implement the changes in an elegant way; for example, instead of checking multiple times in the view to determine whether the reviewer’s (or author’s) real name is to be displayed, try to send a message to a model class that will “do the right thing.” This may involve creating separate model classes for anonymous and identified review, so that messages could be sent polymorphically. It’s hard for me to know, without studying the code, whether this would simplify the code or clutter it, but please give some thought to what is the clearest and most robust way to code both anonymous & identified reviews, from the student’s and the instructor’s perspective.

The other piece of the project is to enable review within groups, which means that every student in a group will review every other student in the group (but no students outside the group). This can be configured on the Review Strategy tab when the review strategy is set to “Instructor-Selected”. Under the “Set number of reviews done by each student” box, there could be another one, “Review done in groups of [ ] students”, where “[ ]” is a small text box. There should also be an information button describing how group-based review works.

==Scope==
The project provides instructor a functionality to make assignment reviews to be anonymous or non-anonymous. In addition, instructors have authority to create and assign review groups (students assigned same review group will review each others work) randomly.This scenario will be valid for individual assignments only. Also, anonymity is taken care from the perspective of reviewer as well as the reviewee. In case of non-anonymous groups, students may have the option to invite other students to join their group provided group size is not exceeding the maximum limit.

==Background==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types as well as URLs for assignments.

=Design=

'''Assignment Creation:'''

Providing a checkbox in "review strategy tab" to mark an assignment to have anonymous or non-anonymous reviews. By default, every assignment will be having anonymous reviews but an instructor can change it by unchecking the checkbox.

'''Group Formation:'''

The instructor has the authority to create and assign groups randomly. In this case, students can not drop the group they have been assigned and only an instructor can change their group if needed.
In case, a group has not been assigned by an instructor, students will have the functionality to invite other students to join their group. This functionality is analogous to the invite members to join their team.
Students in the same group can review work of their group members only.

For this, we will be creating a separate model for groups and will store all the group information into the corresponding database table. In order to follow the DRY principle, we will try to integrate the group code with the code written for teams.

'''Non Anonymous Reviews'''

In the case of non-anonymous reviews, students will be able to see the names of all the group members who have graded their individual work. In addition, students can also see whose work they are going to grade so that the non-anonymity is maintained from both sides.

=Files to be Considered=
*reveiw_mapping_controller.rb

*teams_controller.rb

*team.rb

*views/assignments/edit/_review_strategy.html.erb

*views/grades/_reviews.html.erb

=ScreenShots of pages to be modified=
[[File:/home/chinmoy/Pictures/InstructorPage]]

=Key People=
===Developers===
*Bhavesh Kasliwal
*Bhavya Bansal
*Chinmoy Baruah
*Rishabh Sinha

===Mentor===
*Ed Gehringer

User:Cbaruah

2016-11-03T05:11:00Z

Cbaruah: about join_team_request_controller

= 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 and customize new or existing assignments and courses. It also allows the instructor to create a list of topics the students can sign up for, add users, add reviewers, add teams. 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.
# controllers/join_team_request_controller
# 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_sync_message(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_sync_message(user, "Invitation to join team", "team_join_invite", "invitation to join", student.name)
prepared_mail.deliver

==== About join_team_request_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 for advertisment
prepared_mail = MailerHelper.send_sync_message(user, "Response for Team Advertisement", "response_to_advertisement", "request to join team", participant.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_sync_message(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-11-03T05:05:57Z

Cbaruah: /* 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

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 and customize new or existing assignments and courses. It also allows the instructor to create a list of topics the students can sign up for, add users, add reviewers, add teams. 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.
# controllers/join_team_request_controller
# 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_sync_message(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_sync_message(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_sync_message(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-11-03T05:02:57Z

Cbaruah: /* About invitation_controller */

= 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 and customize new or existing assignments and courses. It also allows the instructor to create a list of topics the students can sign up for, add users, add reviewers, add teams. 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_sync_message(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_sync_message(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_sync_message(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-11-03T05:02:36Z

Cbaruah: /* About submitted_content_controller */

= 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 and customize new or existing assignments and courses. It also allows the instructor to create a list of topics the students can sign up for, add users, add reviewers, add teams. 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_sync_message(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_sync_message(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-11-03T05:01:48Z

Cbaruah: /* About mailer_helper */

= 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 and customize new or existing assignments and courses. It also allows the instructor to create a list of topics the students can sign up for, add users, add reviewers, add teams. 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_sync_message(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-29T00:22:36Z

Cbaruah: /* About import_file_controller */

= 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-28T23:27:59Z

Cbaruah: /* References */

= 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 students' 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 mail to newly created user, sending mail 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]

User:Cbaruah

2016-10-28T23:18:43Z

Cbaruah: /* Files modified in current project */

= 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 students' 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 mail to newly created user, sending mail 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===

User:Cbaruah

2016-10-28T23:18:05Z

Cbaruah: /* 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 students' 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 mail to newly created user, sending mail 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.

====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.

==== 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.

==== 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.

==== 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.

==== 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.

=== 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===

User:Cbaruah

2016-10-28T23:17:31Z

Cbaruah: /* 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
* 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 students' 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 mail to newly created user, sending mail 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.

====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.

==== 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.

==== 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.

==== 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.

==== 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.

=== 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===

===References===

User:Cbaruah

2016-10-28T23:17:06Z

Cbaruah: /* Drawbacks and Solutions */

User:Cbaruah

2016-10-28T19:26:11Z

Cbaruah: /* Current Implementation */

User:Cbaruah

2016-10-28T18:55:29Z

Cbaruah: Created page with " = 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 assignmen..."