Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2020-03-13T08:58:42Z

Gsingh23: /* Problem Statement */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

===Pull Request===
https://github.com/expertiza/expertiza/pull/1649

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and adding submissions to the assignment. Creation of new account will not require approval from instructor/admin. Joining URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases based on whether author has expertiza account or not.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author's expertiza account already exists, then he or she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

2. If Co-Author's expertiza does not exists then he/she will receive an email with username and password and expertiza link on his/her email, that was given by author to invite the co-author. When co-author logs in with same email id or password, he/she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

3. After that co-author can accept or reject the team invite and proceed with assignment submission.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====spec/controllers/invitations_controller_spec.rb====
This spec would test the following scenarios when an author is inviting co-authors to join his/her team

1) When the co-author does not have an expertiza account:
It is expected that invitation creation should increase the User count by one and Invitations count by one

2) When the co-author already has an expertiza account:
It is expected that invitation creation should increase only the Invitations count by one as user is already existing

3) When email entered by the author is in wrong format and co-author does not exist already:
It is expected that no new invitation should be created.

4) (Regression) for a normal assignment, if author tries to add a teammate who does not have an expertiza account
It is expected that no new invitation or user should be created.

====spec/controllers/users_controller_spec.rb====
This spec would test the following scenarios when an author is joining the conference assignment as a participant

1) When the author does not have an expertiza account:
It is expected that User count should be increased by one and participants count should increase by one

2) When the author already has an expertiza account but is logged out:
It is expected that only participants count should increase by one

3) When the author already has an expertiza account and is logged in:
It is expected that only participants count should increase by one

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-17T07:04:35Z

Gsingh23: /* RSpec Tests */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and adding submissions to the assignment. Creation of new account will not require approval from instructor/admin. Joining URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases based on whether author has expertiza account or not.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author's expertiza account already exists, then he or she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

2. If Co-Author's expertiza does not exists then he/she will receive an email with username and password and expertiza link on his/her email, that was given by author to invite the co-author. When co-author logs in with same email id or password, he/she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

3. After that co-author can accept or reject the team invite and proceed with assignment submission.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====spec/controllers/invitations_controller_spec.rb====
This spec would test the following scenarios when an author is inviting co-authors to join his/her team

1) When the co-author does not have an expertiza account:
It is expected that invitation creation should increase the User count by one and Invitations count by one

2) When the co-author already has an expertiza account:
It is expected that invitation creation should increase only the Invitations count by one as user is already existing

3) When email entered by the author is in wrong format and co-author does not exist already:
It is expected that no new invitation should be created.

4) (Regression) for a normal assignment, if author tries to add a teammate who does not have an expertiza account
It is expected that no new invitation or user should be created.

====spec/controllers/users_controller_spec.rb====
This spec would test the following scenarios when an author is joining the conference assignment as a participant

1) When the author does not have an expertiza account:
It is expected that User count should be increased by one and participants count should increase by one

2) When the author already has an expertiza account but is logged out:
It is expected that only participants count should increase by one

3) When the author already has an expertiza account and is logged in:
It is expected that only participants count should increase by one

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-17T04:50:15Z

Gsingh23: /* RSpec Tests */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and adding submissions to the assignment. Creation of new account will not require approval from instructor/admin. Joining URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases based on whether author has expertiza account or not.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author's expertiza account already exists, then he or she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

2. If Co-Author's expertiza does not exists then he/she will receive an email with username and password and expertiza link on his/her email, that was given by author to invite the co-author. When co-author logs in with same email id or password, he/she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

3. After that co-author can accept or reject the team invite and proceed with assignment submission.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====spec/controllers/invitations_controller_spec.rb====
This spec would test the following scenarios when an author is inviting co-authors to join his/her team

1) When the co-author does not have an expertiza account:
It is expected that invitation creation should increase the User count by one and Invitations count by one

2) When the co-author already has an expertiza account:
It is expected that invitation creation should increase only the Invitations count by one as user is already existing

3) When email entered by the author is in wrong format and co-author does not exist already:
It is expected that no new invitation should be created.

4) (Regression) for a normal assignment, if author tries to add a teammate who does not have an expertiza account
It is expected that no new invitation or user should be created.

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-17T00:31:23Z

Gsingh23: /* Changes for Conference's co-authors */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and adding submissions to the assignment. Creation of new account will not require approval from instructor/admin. Joining URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases based on whether author has expertiza account or not.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author's expertiza account already exists, then he or she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

2. If Co-Author's expertiza does not exists then he/she will receive an email with username and password and expertiza link on his/her email, that was given by author to invite the co-author. When co-author logs in with same email id or password, he/she will be able to see conference assignment in Assignments page and "Your Team" section will be having the invite sent by the author.

3. After that co-author can accept or reject the team invite and proceed with assignment submission.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-17T00:23:32Z

Gsingh23: /* Changes for Conference's authors */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and adding submissions to the assignment. Creation of new account will not require approval from instructor/admin. Joining URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases based on whether author has expertiza account or not.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in "Your Team" section.

2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in "Your Team" section.

3. After that Co-Author can accept or reject the team invite and proceed with assignment submission.

4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-17T00:02:15Z

Gsingh23: /* Creating The conference type assignment */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to join the given assignment.

* Authors will use this assignment to submit conference papers. If author does not have account already in expertiza, a new account will be created for him.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in "Your Team" section.

2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in "Your Team" section.

3. After that Co-Author can accept or reject the team invite and proceed with assignment submission.

4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-16T23:56:34Z

Gsingh23: /* Task to be Accomplished */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be shown on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link, username and temporary password.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.

The usage of the url and working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in "Your Team" section.

2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in "Your Team" section.

3. After that Co-Author can accept or reject the team invite and proceed with assignment submission.

4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-12-16T23:52:26Z

Gsingh23: /* Existing Solution */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share details of authors' names with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* When creating a conference type assignment, a link to join the conference will be show on the assignment page.
* Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.
* Author will be able to create a new team in "Your Team" section and can invite other Co-Authors to join the team.
* If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.
* Once Co-Author sees the invite they can accept or reject it.

==Sequence Diagram==
[[File:OSS12.png]]

==Design - The Grubby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.

The usage of the url and working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account.

*If Author already has an account he will be able to view the assignment assigned to him and a default team.
*If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password.

3. After Author logs in, he/she can navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author.

5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in "Your Team" section.

2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in "Your Team" section.

3. After that Co-Author can accept or reject the team invite and proceed with assignment submission.

4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.

===Files to be changed===
[[Image:Design_g.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:58:57Z

Gsingh23: /* Database Changes */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:58:49Z

Gsingh23: /* Database Changes */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.
This will work as a flag for all our functionalities in this project.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:58:14Z

Gsingh23: /* Database Changes */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.
This will work as a flag for all our functionality in this project.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:57:32Z

Gsingh23: /* Database Changes */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
As part of our change, the change in the database would be addition of a new column: 'is_conference_type_assignment' with default value 0, and value = 1 if the assignment is of 'conference' type.
This will work as a flag for all our functionality in this project.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:40:05Z

Gsingh23: /* Scenario 1: Creating student type user from controller by bypassing admin approval */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
There are no database changes as per the current design.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if author is able to to create and login into a new account without admin approval

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:37:41Z

Gsingh23: /* Scenario 1: Creating student type user from controller by bypassing admin approval */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
There are no database changes as per the current design.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:36:16Z

Gsingh23: /* Database Changes */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
There are no database changes as per the current design.

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:35:31Z

Gsingh23: /* Changes for Conference's authors */

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
There are no database changes as per the current design

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T04:03:52Z

Gsingh23: /* Changes for Conference's co-authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:56:58Z

Gsingh23: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:38:56Z

Gsingh23: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:30:25Z

Gsingh23: /* Creating The conference type assignment */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:20:01Z

Gsingh23: /* Creating The conference type assignment */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:16:29Z

Gsingh23:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:10:17Z

Gsingh23: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-05T00:33:07Z

Gsingh23: /* Issue 2: Instructors can make changes to each others’ rubrics */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Test Plan==
Since both of the issues under this project were UI related, and none of the business related code was put in/ changed in the back-end, no new Unit-Tests were required for Testing the fixes.
Following are the individual Test Plans for verifying the changes done in this project.

===Issue 1: Inappropriate redirection when Managing Questionnaire types===
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

''Expectation'': The 'Manage Content' page should be loaded with 'Questionnaires' tab active and 'Teammate Review' rubric expanded.

'''Test Case 2 (Regression)'''

2.1 In continuation with the Test Case 1, when you are on 'Manage Content' section's 'Questionnaire' tab, click on the 'Assignments' tab.

2.2 Move away from 'Manage Content' section by clicking on any of the menu Items, lets click on 'Profile' Menu Item here.

2.2 After 'Profile' section is loaded, Go back to the 'Manage Content' section by clicking on the 'Manage...' menu item.

''Expectation'': The 'Manage Content' page should be loaded with 'Assignments' tab active since this was the last active tab before leaving this section.

===Issue 2: Instructors can make changes to each others’ rubrics===

Follow the below steps to Verify the fix for this issue:

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

1.4 Scan through the list in the rubric.

''Expectation'': Each individual item should have Action icons (representing 'Edit','Delete','Copy','View'). But the 'Edit' action item should not be visible for all the items, only the items belonging to 'instructor6' should have the 'Edit' Option under them.

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-05T00:30:40Z

Gsingh23: /* Issue 2: Instructors can make changes to each others’ rubrics */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Test Plan==
Since both of the issues under this project were UI related, and none of the business related code was put in/ changed in the back-end, no new Unit-Tests were required for Testing the fixes.
Following are the individual Test Plans for verifying the changes done in this project.

===Issue 1: Inappropriate redirection when Managing Questionnaire types===
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

''Expectation'': The 'Manage Content' page should be loaded with 'Questionnaires' tab active and 'Teammate Review' rubric expanded.

'''Test Case 2 (Regression)'''

2.1 In continuation with the Test Case 1, when you are on 'Manage Content' section's 'Questionnaire' tab, click on the 'Assignments' tab.

2.2 Move away from 'Manage Content' section by clicking on any of the menu Items, lets click on 'Profile' Menu Item here.

2.2 After 'Profile' section is loaded, Go back to the 'Manage Content' section by clicking on the 'Manage...' menu item.

''Expectation'': The 'Manage Content' page should be loaded with 'Assignments' tab active since this was the last active tab before leaving this section.

===Issue 2: Instructors can make changes to each others’ rubrics===

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

1.4 Scan through the list in the rubric.

''Expectation'': Each individual item should have Action icons (representing 'Edit','Delete','Copy','View'). But the 'Edit' action item should not be visible for all the items, only the items belonging to 'instructor6' should have the 'Edit' Option under them.

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-05T00:30:24Z

Gsingh23: /* Issue 1: Inappropriate redirection when Managing Questionnaire types */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Test Plan==
Since both of the issues under this project were UI related, and none of the business related code was put in/ changed in the back-end, no new Unit-Tests were required for Testing the fixes.
Following are the individual Test Plans for verifying the changes done in this project.

===Issue 1: Inappropriate redirection when Managing Questionnaire types===
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

''Expectation'': The 'Manage Content' page should be loaded with 'Questionnaires' tab active and 'Teammate Review' rubric expanded.

'''Test Case 2 (Regression)'''

2.1 In continuation with the Test Case 1, when you are on 'Manage Content' section's 'Questionnaire' tab, click on the 'Assignments' tab.

2.2 Move away from 'Manage Content' section by clicking on any of the menu Items, lets click on 'Profile' Menu Item here.

2.2 After 'Profile' section is loaded, Go back to the 'Manage Content' section by clicking on the 'Manage...' menu item.

''Expectation'': The 'Manage Content' page should be loaded with 'Assignments' tab active since this was the last active tab before leaving this section.

==Issue 2: Instructors can make changes to each others’ rubrics==

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

1.4 Scan through the list in the rubric.

''Expectation'': Each individual item should have Action icons (representing 'Edit','Delete','Copy','View'). But the 'Edit' action item should not be visible for all the items, only the items belonging to 'instructor6' should have the 'Edit' Option under them.

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-05T00:30:05Z

Gsingh23: /* Test Plan */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Test Plan==
Since both of the issues under this project were UI related, and none of the business related code was put in/ changed in the back-end, no new Unit-Tests were required for Testing the fixes.
Following are the individual Test Plans for verifying the changes done in this project.

==Issue 1: Inappropriate redirection when Managing Questionnaire types==
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

''Expectation'': The 'Manage Content' page should be loaded with 'Questionnaires' tab active and 'Teammate Review' rubric expanded.

'''Test Case 2 (Regression)'''

2.1 In continuation with the Test Case 1, when you are on 'Manage Content' section's 'Questionnaire' tab, click on the 'Assignments' tab.

2.2 Move away from 'Manage Content' section by clicking on any of the menu Items, lets click on 'Profile' Menu Item here.

2.2 After 'Profile' section is loaded, Go back to the 'Manage Content' section by clicking on the 'Manage...' menu item.

''Expectation'': The 'Manage Content' page should be loaded with 'Assignments' tab active since this was the last active tab before leaving this section.

==Issue 2: Instructors can make changes to each others’ rubrics==

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

1.4 Scan through the list in the rubric.

''Expectation'': Each individual item should have Action icons (representing 'Edit','Delete','Copy','View'). But the 'Edit' action item should not be visible for all the items, only the items belonging to 'instructor6' should have the 'Edit' Option under them.

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-05T00:29:23Z

Gsingh23: /* Test Plan */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

===Test Plan===
Since both of the issues under this project were UI related, and none of the business related code was put in/ changed in the back-end, no new Unit-Tests were required for Testing the fixes.
Following are the individual Test Plans for verifying the changes done in this project.

==Issue 1: Inappropriate redirection when Managing Questionnaire types==
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

''Expectation'': The 'Manage Content' page should be loaded with 'Questionnaires' tab active and 'Teammate Review' rubric expanded.

'''Test Case 2 (Regression)'''

2.1 In continuation with the Test Case 1, when you are on 'Manage Content' section's 'Questionnaire' tab, click on the 'Assignments' tab.

2.2 Move away from 'Manage Content' section by clicking on any of the menu Items, lets click on 'Profile' Menu Item here.

2.2 After 'Profile' section is loaded, Go back to the 'Manage Content' section by clicking on the 'Manage...' menu item.

''Expectation'': The 'Manage Content' page should be loaded with 'Assignments' tab active since this was the last active tab before leaving this section.

==Issue 2: Instructors can make changes to each others’ rubrics==

1.1 Open the Expertiza application.

1.2 Login as an instructor(username:instructor6, password:password)

1.3 In the Menu Items Goto: 'Manage...>Questionnaires>Team Review Rubrics' (Goto here means pointing your mouse to that particular option and the following the sub-options, the click only takes place at the last option, here at "Team Review Rubrics")

1.4 Scan through the list in the rubric.

''Expectation'': Each individual item should have Action icons (representing 'Edit','Delete','Copy','View'). But the 'Edit' action item should not be visible for all the items, only the items belonging to 'instructor6' should have the 'Edit' Option under them.

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-04T22:47:09Z

Gsingh23: Undo revision 127040 by Gsingh23 (talk)

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Test Plan==
csdkjn

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-11-04T22:45:07Z

Gsingh23: /* Problem Statement */

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Problem Statement ==

=== Task 1 : Inappropriate redirection when Managing Questionnaire types ===

==== Description ====
Each of the options for Manage>Questionnaires> does not appropriately link you to the Questionnaires tab with that section of Questionnaires expanded. Currently, the homepage shows 3 tabs: Courses, Assignments and Questionnaires. Suppose a user clicks on the "courses" tab and then from the "Manage Content Tab" -> "Questionnaires", clicks on any of the options, then it will redirect to the same page and not the one which was selected. This needs to be fixed such that upon click, it opens up the corresponding rubric page with that particular rubric section expanded and also the respective tab (courses/assignments/questionnaires) must be highlighted.

==== Problem Cause (The grubby details) ====
The Manage Content page has three tabs in it namely: "Courses","Assignments" and "Questionnaires".
And the application has a feature of storing the 'Last open tab' in its session. Suppose a user was in 'Assignments' tab under 'Manage Content' Section, and when the user switches to some other tab (By clicking on Home for instance), and comes back on 'Manage Content' section (by clicking on 'Manage...' menu button), he is directed back on the 'Assignments' tab only (the tab that was opened before leaving the 'Manage Content' section).

The problem however, with this feature is that it dominates the natural flow of the application in the following scenario:
Lets say after leaving the 'Manage Content' section as mentioned above, the user clicks 'Manage...>Questionnaires', but even at this point, the user is directed again directed to 'Assignments' tab under 'Manage Content'

==== How to reproduce ====
If you are on the assignment tab and select to Manage…>Questionnaires> [some option], this will send you to the assignment tab. It is believed that the redirect will always send you to the view that was previously displayed. Change the tab to course or questionnaire and then it just sends you to that tab instead.

==== Flowchart for correct behavior====

[[File:Fc issue1.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx'''
- Created "ComponentDidMount" method under this script file which is a react lifecycle function and this is invoked immediately after a component is inserted into the tree. The setState method sets the expanded attribute to true for expanding the relative grid of the rubric. This method will trigger an extra rendering but it will happen before the browser updates the screen. This function will help determine which sub-menu item is selected and expands the corresponding rubric by updating the state of the table row.
<pre>
componentDidMount: function() {
rubBuffer = ["Review", "Metareview", "Author Feedback", "Teammate Review", "Assignment Survey", "Global Survey", "Course Survey"];

selMenuItem = document.getElementById("tree_display").getAttribute("data-menu-item");
selMenuItemInd = rubBuffer.indexOf(selMenuItem);

if(rubBuffer[selMenuItemInd] === this.props.name) {
if (selMenuItemInd !== -1) {
this.setState({
expanded: true
}, function () {
this.props.rowClicked(this.props.id, true, this.props.newParams)
})
}
}
},
</pre>

'''app/controllers/tree_display_controller.rb'''
- This is the main controller which calls the respective tab upon selection. The 'last_open_tab' holds on the tab clicked under 'Questionnaire'. For every goto_controller call, the tab number sent along in the parameter refers to the respective order of tabs that appear on the homepage.
The changes in the goto_controller will allow the function to keep a track of which tab was last opened by using a new argument i.e. last_open_tab and setting its values to the integer value corresponding to the relative ordering of the tabs on the page . For e.g., if the Questionnaires tab is clicked then a value of 3 will be passed as a parameter since the position of the Questionnaires tab is 3 on the page.
<pre>
def goto_controller(name_parameter, prevTab)
node_object = TreeFolder.find_by(name: name_parameter)
session[:root] = FolderNode.find_by(node_object_id: node_object.id).id
if(prevTab!=nil)
session[:last_open_tab] = prevTab
end
redirect_to controller: 'tree_display', action: 'list', currCtlr: name_parameter
end

def goto_questionnaires
goto_controller('Questionnaires','3')
end
</pre>

==== ScreenCast====

Here is a screencast of the tested functionality after the fix: [https://drive.google.com/open?id=1E2qDwcVvJBi_ybNdIqx6hykDmYVWqu6Y Fixed Issue #1186]

=== Task 2: Instructors can make changes to each others’ rubrics ===

==== Description ====
Currently, rubric lists show all public rubrics and there is no option to restrict the view as in assignments and courses. This should be fixed by only displaying the option to edit (pencil) when the rubric belongs to the user. This clearly indicates that the user has the ability or not to edit this rubric.

==== Problem Cause (The grubby details) ====
The problem which we are trying to resolve arises because of the fact that all the rubrics, questionnaires, surveys, etc have been made available for all the instructors to view. Because there was no limitation the code uses the same to code to render lists across the different users. This raises an issue that one instructor can if they want to edit other instructor's surveys when they were only supposed to view them
Currently, if a non-authorized user clicks on edit he is redirected to the same page with an error. A better approach would be to not show the edit button at all and thus we have fixed this user experience.

==== How to reproduce ====
Log in and Manage…>Questionnaires>Rubrics. Then click on one of the rubric types to show a list of rubrics and click through the edit options to reveal the flash error when you try and edit a rubric that is not yours.

==== Flowchart for correct behavior: ====

[[File:Fc uc2.png]]

====Major Fixes Done ====

'''app/assets/javascripts/tree_display.jsx:'''
- This code wait for the page to load and then try to find the user id embedded in the HTML sent from the backend. It then sets this id in a variable available across the app using javascript.
<pre>
let app_variables = {
currentUserId: null
};

window.addEventListener('load', e => {
let treeDisplayDiv = document.querySelector('#tree_display');
if (treeDisplayDiv) {
app_variables.currentUserId = document.querySelector('#tree_display').dataset.userId;
}
});
</pre>

We then pass the instructor's id coming from the API into the Component as props so that it is accessible inside out component for validation.
<pre>
instructor_id={entry.instructor_id}
</pre>

The check which is helping us achieve this is
<pre>
instructor_id={entry.instructor_id}
</pre>

'''app/controllers/controller2:'''
<pre>
(app_variables.currentUserId == null || this.props.instructor_id == app_variables.currentUserId)
</pre>

For API changes 
'''app/controllers/tree_display_controller.rb'''
<pre>
"instructor_id" => child.get_instructor_id,
</pre>

'''app/models/questionnaire_node.rb'''

This function added to the model which simply returns instructor_id associated with that particular questionnaire or survey.
<pre>
def get_instructor_id
Questionnaire.find_by(id: self.node_object_id).try(:instructor_id)
end
</pre>

====Major Fixes Done ====
dfvmn

==Deployment==
This application with the mentioned changes have been deployed to the following URL: [http://152.46.19.166:8080 http://152.46.19.166:8080]
* We have used VCL for deployment.
* Username: instructor6
* Password: password

==Team Members==
Ankit Manendra (amanend@ncsu.edu)

Bharat Sinha (bsinha2@ncsu.edu)

Gurman Singh (gsingh23@ncsu.edu )

Mentor: Carmen Bentley (cnaiken@ncsu.edu)

==References==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/expertiza/expertiza/issues/1186 Issue Number 1186]
#[https://github.com/expertiza/expertiza/issues/696 Issue Number 696]
#[https://reactjs.org/docs/react-component.html ReactJS Documentation]

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-10-27T00:08:10Z

Gsingh23: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-10-27T00:07:23Z

Gsingh23: /* Details (The grubby details) */

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-10-27T00:05:58Z

Gsingh23: /* Details (The grubby details) */

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-10-26T23:23:08Z

Gsingh23: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics

2019-10-26T21:55:09Z

Gsingh23: /* Problem Statement */