CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design
This page provides a description of the Expertiza based OSS project.
About Expertiza
Expertiza is an open source project based on Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.
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
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
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)