Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2016/Badging System

2016-04-25T15:35:30Z

Dasoni: /* Tasks To Do */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks Done===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Used===
Files that are modified or are added can be found [http://github.com/expertiza/expertiza/pull/673/files here]

*Modified files:
**app/controllers/student_task_controller.rb 4
**app/controllers/users_controller.rb 4
**app/controllers/tree_display_controller.rb 4
**app/controllers/leaderboard_controller.rb 4
**app/controllers/assignments_controller.rb 4
**app/models/user.rb 4
**app/models/leaderboard.rb 4
**app/models/badge_user.rb 4
**app/models/assignment_form.rb 4
**app/models/assignment.rb 4
**app/views/leaderboard/index.html.erb 4
**app/views/leaderboard/_leaderBoards.html.erb 4
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**app/views/tree_display/actions/_courses_actions.html.erb 4
**config/routes.rb 4
**db/schema.rb 4
**app/views/leaderboard/view.html.erb 4
**app/views/auth/_login.html.erb 4
**app/views/assignments/edit.html.erb 4
**app/helpers/leaderboard_helper.rb 4
**app/helpers/assignment_helper.rb 4

*Newly added files:
**app/models/badge.rb 4
**app/models/badge_groups.rb 4
**app/models/assignment_group.rb 4
**app/controllers/badges_controller.rb 4
**app/controllers/badge_groups_controller.rb 4
**app/views/users/credly_register.html.erb 4
**app/views/assignments/edit/_badges.html.erb 4
**app/views/badges/ 4
**app/views/badge_groups/ 4
**app/views/assignments/edit/_select_badge.html.erb 4
**app/helpers/credly_helper.rb 4

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| name || varchar || Description of the badge
|-
| credly_badge_id || int || Corresponding badge id with Credly
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| strategy || varchar || Describes the strategy of awarding
|-
| badge_id || int || Assigned badge id.
|-
| course_id || int || Course for which group is formed.
|-
| is_course_level_group || boolean || Whether group is for course
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Walkthrough==
Below is a walkthrough of the changes to implement the Badging System:
===Instructor===
Instructors may configure badges on the course page using the new badge configuration icon:

[[File:Manage_courses_badges.jpg]]

Upon clicking the badge configuration icon, the user will be presented with two items: create groups and view all existing groups. Users may also edit and delete groups. A group is a set of assignments to present badges for.

[[File:badges_configuration.jpg]]

A new group may be created using the form below. This form allows instructors to create a new badge while creating a group for which they will be redirected to Credly. The form page must be refreshed upon creating a new badge so it may appear in the interface. The result of this form will create a new record in badge_groups and assignment_groups tables.

[[File:badges_new.jpg]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-25T15:35:01Z

Dasoni: /* Files Used */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Used===
Files that are modified or are added can be found [http://github.com/expertiza/expertiza/pull/673/files here]

*Modified files:
**app/controllers/student_task_controller.rb 4
**app/controllers/users_controller.rb 4
**app/controllers/tree_display_controller.rb 4
**app/controllers/leaderboard_controller.rb 4
**app/controllers/assignments_controller.rb 4
**app/models/user.rb 4
**app/models/leaderboard.rb 4
**app/models/badge_user.rb 4
**app/models/assignment_form.rb 4
**app/models/assignment.rb 4
**app/views/leaderboard/index.html.erb 4
**app/views/leaderboard/_leaderBoards.html.erb 4
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**app/views/tree_display/actions/_courses_actions.html.erb 4
**config/routes.rb 4
**db/schema.rb 4
**app/views/leaderboard/view.html.erb 4
**app/views/auth/_login.html.erb 4
**app/views/assignments/edit.html.erb 4
**app/helpers/leaderboard_helper.rb 4
**app/helpers/assignment_helper.rb 4

*Newly added files:
**app/models/badge.rb 4
**app/models/badge_groups.rb 4
**app/models/assignment_group.rb 4
**app/controllers/badges_controller.rb 4
**app/controllers/badge_groups_controller.rb 4
**app/views/users/credly_register.html.erb 4
**app/views/assignments/edit/_badges.html.erb 4
**app/views/badges/ 4
**app/views/badge_groups/ 4
**app/views/assignments/edit/_select_badge.html.erb 4
**app/helpers/credly_helper.rb 4

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| name || varchar || Description of the badge
|-
| credly_badge_id || int || Corresponding badge id with Credly
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| strategy || varchar || Describes the strategy of awarding
|-
| badge_id || int || Assigned badge id.
|-
| course_id || int || Course for which group is formed.
|-
| is_course_level_group || boolean || Whether group is for course
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Walkthrough==
Below is a walkthrough of the changes to implement the Badging System:
===Instructor===
Instructors may configure badges on the course page using the new badge configuration icon:

[[File:Manage_courses_badges.jpg]]

Upon clicking the badge configuration icon, the user will be presented with two items: create groups and view all existing groups. Users may also edit and delete groups. A group is a set of assignments to present badges for.

[[File:badges_configuration.jpg]]

A new group may be created using the form below. This form allows instructors to create a new badge while creating a group for which they will be redirected to Credly. The form page must be refreshed upon creating a new badge so it may appear in the interface. The result of this form will create a new record in badge_groups and assignment_groups tables.

[[File:badges_new.jpg]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-25T15:31:21Z

Dasoni:

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Used===
Files that are modified or are added can be found [http://github.com/expertiza/expertiza/pull/673/files here]

*Modified files:
**app/controllers/student_task_controller.rb 4
**app/controllers/users_controller.rb 4
**app/controllers/tree_display_controller.rb 4
**app/controllers/leaderboard_controller.rb 4
**app/controllers/assignments_controller.rb 4
**app/models/user.rb 4
**app/models/leaderboard.rb 4
**app/models/badge_user.rb 4
**app/models/assignment_form.rb 4
**app/models/assignment.rb 4
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**app/views/tree_display/actions/_courses_actions.html.erb 4
**config/routes.rb 4
**db/schema.rb 4
**app/views/leaderboard/view.html.erb 4
**app/views/auth/_login.html.erb 4
**app/views/assignments/edit.html.erb 4
**app/helpers/leaderboard_helper.rb 4
**app/helpers/assignment_helper.rb 4

*Newly added files:
**app/models/badge.rb 4
**app/models/badge_groups.rb 4
**app/models/assignment_group.rb 4
**app/controllers/badges_controller.rb 4
**app/controllers/badge_groups_controller.rb 4
**app/views/users/credly_register.html.erb 4
**app/views/assignments/edit/_badges.html.erb 4
**app/views/badges/ 4
**app/views/badge_groups/ 4
**app/views/assignments/edit/_select_badge.html.erb 4
**app/helpers/credly_helper.rb 4

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| name || varchar || Description of the badge
|-
| credly_badge_id || int || Corresponding badge id with Credly
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| strategy || varchar || Describes the strategy of awarding
|-
| badge_id || int || Assigned badge id.
|-
| course_id || int || Course for which group is formed.
|-
| is_course_level_group || boolean || Whether group is for course
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Walkthrough==
Below is a walkthrough of the changes to implement the Badging System:
===Instructor===
Instructors may configure badges on the course page using the new badge configuration icon:

[[File:Manage_courses_badges.jpg]]

Upon clicking the badge configuration icon, the user will be presented with two items: create groups and view all existing groups. Users may also edit and delete groups. A group is a set of assignments to present badges for.

[[File:badges_configuration.jpg]]

A new group may be created using the form below. This form allows instructors to create a new badge while creating a group for which they will be redirected to Credly. The form page must be refreshed upon creating a new badge so it may appear in the interface. The result of this form will create a new record in badge_groups and assignment_groups tables.

[[File:badges_new.jpg]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-24T16:50:24Z

Dasoni:

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
*Modified files:
**app/controllers/student_task_controller.rb
**app/controllers/users_controller.rb
**app/models/user.rb
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**config/routes.rb

*Newly added files:
**app/models/badges.rb
**app/models/badge_groups.rb
**app/controllers/badges_controller.rb
**app/controllers/badge_groups_controller.rb
**app/views/users/credly_register.html.erb
**app/views/assignments/edit/_badges_configuration.html.erb
**app/views/badges/

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| name || varchar || Description of the badge
|-
| credly_badge_id || int || Corresponding badge id with Credly
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| strategy || varchar || Describes the strategy of awarding
|-
| badge_id || int || Assigned badge id.
|-
| course_id || int || Course for which group is formed.
|-
| is_course_level_group || boolean || Whether group is for course
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-12T03:04:15Z

Dasoni: /* System Requirements */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
*Modified files:
**app/controllers/student_task_controller.rb
**app/controllers/users_controller.rb
**app/models/user.rb
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**config/routes.rb

*Newly added files:
**app/models/badges.rb
**app/models/badge_groups.rb
**app/controllers/badges_controller.rb
**app/controllers/badge_groups_controller.rb
**app/views/users/credly_register.html.erb
**app/views/assignments/edit/_badges_configuration.html.erb
**app/views/badges/

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-12T03:03:38Z

Dasoni: /* System Requirements */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
*Modified files:
**app/controllers/student_task_controller.rb
**app/controllers/users_controller.rb
**app/models/user.rb
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**config/routes.rb

*Newly added files:
**app/models/badges.rb
**app/models/badge_groups.rb
**app/controllers/badges_controller.rb
**app/controllers/badge_groups_controller.rb
**app/views/users/credly_register.html.erb
**app/views/assignments/edit/_badges_configuration.html.erb
**app/views/badges/

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-12T02:58:51Z

Dasoni: /* Use Cases */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Case Scenarios====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
*Modified files:
**app/controllers/student_task_controller.rb
**app/controllers/users_controller.rb
**app/models/user.rb
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**config/routes.rb

*Newly added files:
**app/models/badges.rb
**app/models/badge_groups.rb
**app/controllers/badges_controller.rb
**app/controllers/badge_groups_controller.rb
**app/views/users/credly_register.html.erb
**app/views/assignments/edit/_badges_configuration.html.erb
**app/views/badges/

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-12T02:56:06Z

Dasoni:

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza. Instructor can create badges using this service and assign to students.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Cases====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Save
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select LeaderBoard
**# Select Award Badges
**# Select Create new badge
**# Create new badge using Credly
**# Select Save

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
*Modified files:
**app/controllers/student_task_controller.rb
**app/controllers/users_controller.rb
**app/models/user.rb
**app/views/leaderboard/index.html.erb
**app/views/leaderboard/_top3LeaderBoards.html.erb
**app/views/leaderboard/_achievementLeaderBoards.html.erb
**app/views/course/edit.html.erb
**config/routes.rb

*Newly added files:
**app/models/badges.rb
**app/models/badge_groups.rb
**app/controllers/badges_controller.rb
**app/controllers/badge_groups_controller.rb
**app/views/users/credly_register.html.erb
**app/views/assignments/edit/_badges_configuration.html.erb
**app/views/badges/

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:badging_class_diagram.png]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T22:31:03Z

Dasoni: /* Mockups */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

====Use Cases====
* '''Student Views Leaderboard'''
** Actor: Student
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Mouse over Home
**# Select Leaderboard
* '''Instructor Views Assignment Leaderboard'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select View Badges on assignment
* '''Instructor Edits Assignment Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Assignments
**# Select Edit Assignments
**# Select Badges tab
**# Check enable badges
* '''Instructor Creates Course Badges'''
** Actor: Instructor
** Other Participants: None
** Primary Sequence:
**# Log into Expertiza
**# Select Courses
**# Select Edit Badges
**# Check assignments
**# Check Score Threshold
**# Enter 95.5 as scoring threshold
**# Select Submit

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
Associated files goes here.

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:Cap1.PNG]]

==Mockups==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: StudentLeaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: InstructorAssignment.png]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: EditAssignmentBadges.png]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: BadgeCourseOptions.png]]
Figure 4: Edit Course

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T21:34:45Z

Dasoni: /* Design */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
Associated files goes here.

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Design==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.
.
The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: Badge_student_leaderboard.png |600x454px]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: example.jpg]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: example.jpg]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: example.jpg]]
Figure 4: Edit Course

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:Cap1.PNG]]

==Mockups==

Mockup goes here

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T21:33:10Z

Dasoni: /* Requirements */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Files Identified===
Associated files goes here.

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Design==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: Badge_student_leaderboard.png]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: example.jpg]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: example.jpg]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: example.jpg]]
Figure 4: Edit Course

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:Cap1.PNG]]

==Mockups==

Mockup goes here

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T21:28:07Z

Dasoni: /* Requirements */

==Introduction==
===Background===
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

===Purpose===
One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza.

==Requirements==
===System Requirements===
The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.
===Use Case===
The following simple illustration shows the use cases of the system.

[[File:Use_case.PNG]]

===Tasks To Do===
*Create db table to store the participants with badges.
*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.
*Add badge specification to course details and assignment details page for the instructor to specify the badges.
*Create views for both students and instructors. Students should be able to view their badges from different courses and instructors should be able to see the badges awarded/earned for their class.
*Display a subset of the badge holders on the leaderboard page. Also, student can view badges of other students in the course.
*Criteria to be followed for awarding badges:
#Top scores for an assignment. (configured at assignment page)
#All scores more than a threshold for an assignment. (configured at assignment page)
#Mean score of selected assignments being greater than threshold. (configured at course page)
#Top mean score of selected assignments. (configured at course page)
#Discretionary merit badges for projects that exceed expectations.

===Deciding External Web Service===
{| class="wikitable"
|-
! Factors !! Open Badges !! Credly !! Bestr
|-
| Native User Management || No || Yes. No need to store all records locally. || No
|-
| Extensive API Support || Yes. But many still in beta phase. || Yes. (Primary reason for choosing Credly) || No
|-
| Interactive Badge Builder SDK|| Yes. But still in beta phase. || Yes || Yes. But gives few options for cusromization.
|-
| Existing Integration with other systems || Few || Many || No
|-
| Monetary Costs || Free || Free tier as well as paid plans. || Paid.
|}

From the above rubrics, we decided to use Credly as our web service for badging system.

==Design==
The Expertiza badging system will largely be driven by academic achievement from students. By using student’s scores as a way to provide badges it will be easy to automate the badge reward system upon closing an assignment. For instance, an instructor may decide to reward badges to the top 3 scores on an assignment so once the assignment closes those students will automatically be given those badges.

In order to use badges for an assignment, an instructor must turn on badging for their assignment upon creating or editing an assignment. When turning on the badging system the instructor may specify how many badges will be distributed, or choose to distribute them based off of a scoring threshold that students must achieve.

Following the completion of an assignment an instructor may view the awarded badges on the assignment page. A student will be able to view their earned badges on their homepage categorized by course and assignment.

In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

The layout of each page will match with the currently existing design standards in Expertiza we will continue to use the header and will use headings and links much like other pages. Figure 1 below shows what the leaderboard may look like from a student perspective. Each course the student has participated in will be displayed on the page and by clicking the “Show Badges” the page will generate a list of each of the participants sorted by the number of badges they have earned. In order to display the badges the application will make a call to Credly to query about student badges.

[[File: example.jpg]]
Figure 1: Student Leaderboard

The next figures are all from the perspective of an inspector or admin. In Figure 3 below an instructor may view the badges earned for a given assignment or course in which they own. They will get to his page by clicking a badges button from either the assignments or courses page. The title of the page will be the name of either the course of assignment. Like the previous figure, by clicking show badges the list of course participants will appear sorted by the number of badges they have earned. Another link, “Award Badges” will be used to manually grant a badge. When an instructor or admin clicks on the link, they will be directed to the credly page in order to grant the badge to the student.

[[File: example.jpg]]
Figure 2: Instructor assignment / course badge view

In order to use badges for an assignment, an instructor must first enable them for the assignment. The badges will be enabled by default. The figure below shows some of the settings associated with the badges system. Instructors may choose to automatically grant badges to students based off of their performance on the assignment. When editing or creating a new assignment they may come to the new badges tab and configure how they want the badges granted. Instructors may choose to grant some number of badges to the top scores of the group defined by the number the input, or they may decide to grant badges to anyone who may achieve a score past the provided scoring threshold.

[[File: example.jpg]]
Figure 3: Assignment Badge Settings

Like assignments, courses also need to have some settings to configure badges. In Figure 4, instructors may automatically grant badges for students based on mean scores of multiple assignments throughout the course. First the instructor must check all of the assignments they would like to include in the mean then they must select a scoring strategy. Like the previous figure, they may choose between granting a badge to the top number of participants based on instructor input, or they may set a threshold on a mean score and any student who has achieved a score past the mean will be granted a badge.

[[File: example.jpg]]
Figure 4: Edit Course

==Database Design==
The following tables will be created to implement a solution for this project.

1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_user_id || int || Primary key. Auto-generated
|-
| badge_id || int || Referenced from badges table
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_group_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

[[File:Cap1.PNG]]

==Mockups==

Mockup goes here

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T21:09:50Z

Dasoni: /* Object Oriented Design */

File:Cap1.PNG

2016-04-11T21:09:15Z

Dasoni:

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T21:02:06Z

Dasoni: /* Tasks To Do */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:48:38Z

Dasoni: /* Database Design */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:47:57Z

Dasoni: /* Deciding External Web Service */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:46:30Z

Dasoni: /* Use Case */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:46:11Z

Dasoni: /* Use Case */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:45:47Z

Dasoni: /* Use Case */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:43:49Z

Dasoni:

File:Use case.PNG

2016-04-11T20:42:12Z

Dasoni: Use case diag

Use case diag

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:10:54Z

Dasoni: /* Object Oriented Design */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T20:10:21Z

Dasoni: /* Object Oriented Design */

File:Capture.PNG

2016-04-11T20:08:47Z

Dasoni: uploaded a new version of "File:Capture.PNG": UML diagram

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T17:11:20Z

Dasoni: /* Requirements */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T17:04:14Z

Dasoni:

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T16:14:22Z

Dasoni: /* Introduction */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T16:03:48Z

Dasoni:

==Introduction==
Much like physical badges in the army and youth scout troops, digital badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing online badging web service, Credly, and integrate it with Expertiza.

==Database Design==
The following tables will be created to implement a solution for this project.
1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|-
| strategy || string || Describes the strategy of awarding
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

==Object Oriented Design==
As with most Ruby on Rails applications, this solution uses the Model-View-Controller
design pattern. The following diagram shows a workflow of the planned design along with the attributes and operations that are
relevant to the implementation of this solution.

==Mockups==

Mockup goes here

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T15:55:31Z

Dasoni:

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T15:48:56Z

Dasoni: /* Introduction */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T15:45:43Z

Dasoni: /* Database Design */

==Introduction==
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

==Database Design==
The following tables will be created to implement a solution for this project.
1. badges table - which stores badge_id and their descriptions.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table - which stores details about what badges are assignment to a user and related details.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|-
| strategy || string || Describes the strategy of awarding
|}

3. badge_groups - which stores information about which badges should be assigned depending on the threshold score.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups - which stores details about the team badges.
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# DRY Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T15:01:52Z

Dasoni: /* Database Design */

==Introduction==
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

==Database Design==
1. badges table
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

2. badge_users table
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|-
| strategy || string || Describes the strategy of awarding
|}

3. badge_groups
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

4. assignment_groups
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T15:01:15Z

Dasoni: /* Database Design */

==Introduction==
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

==Database Design==
# badges table
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| name || string || Description of the badge
|}

# badge_users table
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| user_id || int || Referenced from users table
|-
| course_id || int || Referenced from courses table
|-
| assignment_id || int || Referenced from assignments table
|-
| is_course_badge || boolean || Whether badge is a course-badge or individual-badge
|-
| strategy || string || Describes the strategy of awarding
|}

# badge_groups
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| badge_id || int || Primary key. Auto-generated
|-
| strategy || string || Describes the strategy of awarding
|-
| threshold || int || Score required to award the badge
|}

# assignment_groups
{| class="wikitable"
|-
! Column !! Type !! Comment
|-
| assignment_group_id || int || Primary key. Auto-generated
|-
| badge_group_id || int || Referenced from badge_groups table
|-
| assignment_id || int || Referenced from assignments table
|}

==Design Pattern==
# MVC – The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).
# Dry Principle – We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T14:54:22Z

Dasoni:

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T14:11:55Z

Dasoni: /* Design Pattern */

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T14:11:37Z

Dasoni: /* Introduction */

Badging System

2016-04-11T14:00:12Z

Dasoni: moved Badging System to CSC/ECE 517 Spring 2016/Badging System

#REDIRECT [[CSC/ECE 517 Spring 2016/Badging System]]

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T14:00:12Z

Dasoni: moved Badging System to CSC/ECE 517 Spring 2016/Badging System

====Introduction====
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:59:14Z

Dasoni: moved Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System to Badging System

#REDIRECT [[Badging System]]

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:59:14Z

Dasoni: moved Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System to Badging System

User:Dasoni

2016-04-11T13:58:41Z

Dasoni: moved User:Dasoni to Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System

#REDIRECT [[Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System]]

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:58:41Z

Dasoni: moved User:Dasoni to Http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE 517 Spring 2016/Badging System

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:54:43Z

Dasoni:

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:54:27Z

Dasoni:

===Introduction===
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

CSC/ECE 517 Spring 2016/Badging System

2016-04-11T13:54:09Z

Dasoni: Created page with "===Introduction Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online..."

===Introduction
Much like physical badges in the army and youth scout troops, digital based badges are an assessment and credentialing mechanism that is housed and managed online. Badges are designed to make visible and validate learning in both formal and informal settings, and hold the potential to help transform where and how learning is valued. In other words, badges may be used in order to set goals and motivations for students and reward and may help to improve their academic scores. Badges can also be considered as a way to reward student’s success. Moreover, badges can be used by teachers for alternative assessment techniques.

One request for the Expertiza system is to add a badging system as a way to measure student performance. Expertiza will take advantage of the motivations created from badges by awarding students with new badges based off providing a variety of factors within the Expertiza system. Some of these badges include: achieving a top percentage of scores in an assignment, achieving a high peer review score, performing well overall in a course and other manual accomplishments deemed necessary by the teaching staff for a course. Instead of implementing the whole badging system, we will call an existing web service (probably Credly) and integrate it with Expertiza.

CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature

2016-04-01T22:20:14Z

Dasoni:

This wiki page is for the description of changes made under E1602 OSS assignment for Spring 2016, CSC/ECE 517.

== Introduction ==
====Background====

Expertiza is an open source project based on Ruby on Rails framework. Expertiza has a quizzing feature which allow student authors to create quiz questions and test the peer reviewers. The idea behind this is, if a reviewer can answer the quiz questions which were created by the author correctly, we assume that the reviewer has read the artifact carefully enough and thereby we trust the peer-review.

====Current Implementation and Problems====
* Following three different types of questions are supported in quizzing feature of Expertiza
# Multiple Choice Radio
# Multiple Choice Checkbox
# True/False
* The current implementation of Quizzing feature is not consistent with the current questions and questionnaires. Since Quiz questionnaire is one sub type of questionnaire, so it should follow the design of other type of questionnaires. But, the current implementation is inconsistent with other questionnaires.
* In order to create a quiz, the existing code is written in the views which has a series of if-then structures to implement the functionality of each different question type. This kind of implementation makes the code slower and violates the principles of MVC architecture.
* Current HTML code doesn't looks like source code.
* Code is repeated for different question types.
* Proper Ruby naming conventions are not followed
====Changes Implemented====
* All logic moved to model. Four separate methods - <tt>edit</tt>, <tt>view_question_text</tt>, <tt>complete</tt> and <tt>view_completed_question</tt> in order to generate the same HTML for each of the question types. We used polymorphism by declaring all these methods in <tt>QuizQuestion</tt> which inherits from <tt>Question</tt> and has sub-types <tt>MultipleChoiceRadio</tt>, <tt>MultipleChoiceCheckbox</tt>, and <tt>TrueFalse</tt>.
* When questionnaire author creates a quiz, <tt>edit</tt> is called. To call this on UI, you can login as a student, click 'create quiz' / 'edit quiz' on 'Your Works' page. The <tt>edit</tt> method is now called from <tt>/view/questionnaires/_quiz_question.html.erb</tt>
* When questions are viewed by the author or the instructor, <tt>view_question_text</tt> method is called. To call this on UI, you can either login as a student, click 'view quiz' on 'Your works' page or login as an instructor, find an assignment with quizzing feature and click the icon 'view quiz questions'. The 'view_question_text' calls <tt>view/questionnaires/view.html.erb</tt>

* When the quiz takers tries to take the quiz, <tt>complete</tt> is called. To call this on UI, you can login as a quiz taker, request a quiz to take on “Take quizzes” page, then click “begin”. This method is now called on <tt>view/student_quizzes/take_quiz</tt>.
* When the quiz taker finished taking a quiz and wants to view the quiz result again, <tt>view_completed_question</tt> is called. To call this on UI, you can login as a quiz taker, find a finished quiz and click “view”. This method is called on <tt>view/student_quizzes/finished_quiz</tt>.
* Using polymorphism and DRY principles, code repetition has been virtually eliminated.

== Refactoring <tt>view_question_text</tt> ==

The <tt>view_question_text</tt> method is called when the author of the quiz or the instructor views the quiz. The method is responsible for generating the HTML to display the question along with each of its choices. The correct choice(s) should be bolded. Prior to refactoring, this functionality was located in <tt>app/views/student_quizzes/review_questions.html.erb</tt>:
<pre>
<%questions = questionnaire.questions%>
<% questions.each do |question| %>
 <%= question.txt %> 
<% question_type = question.get_formatted_question_type%>
Question Type: <%= question_type %> 

<% if question_type == 'True/False' %>
Correct Answer: <%= (QuizQuestionChoice.where(question_id: question.id, iscorrect:1).first.txt) %> 
<% elsif question_type == 'Multiple Choice - Radio' %>
<% correct_answer = '' %>
Answer Options: 
<% QuizQuestionChoice.where(question_id: question.id).each do |choice| %>
<% if choice.iscorrect == true %>
  <%= choice.txt %> 
<%else%>
  <%= choice.txt %> 
<% end %>

<% end %>
 
<% elsif question_type == 'Multiple Choice - Checked' %>
Answer Options: 
<% QuizQuestionChoice.where(question_id: question.id).each do |choice| %>
<% if choice.iscorrect == true %>
  <%= choice.txt %> 
<%else%>
  <%= choice.txt %> 
<% end %>
<% end %>
 
<% end %>
<% end %><hr>
</pre>

This logic has been moved to <tt>app/models/quiz_question.rb</tt>, so now the view simply needs to call the method:
<pre>
<%questions = questionnaire.questions%>
<%questions.each do |question| %>

<%if question.is_a? Question%>
<%=question.view_question_text.html_safe%>
<%end%>

<% end %><hr>
</pre>

Unit tests were added to <tt>spec/models/quiz_question_spec.rb</tt> covering all three types of questions to ensure that the correct HTML is generated.

== Refactoring <tt>edit</tt> ==

The <tt>edit</tt> method is called when the author creates or edits a quiz. It makes every element of the quiz editable. Prior to refactoring, the HTML was in <tt>app/views/questionnaires/_quiz_questionnaire.html.erb</tt>:

<pre>
<% if @questionnaire.type == 'QuizQuestionnaire' %>

<table id="questions_table">
<% if $disp_flag != 1 %>
<tr>
<td align=left width=300>Questions:</td>
<% if @questionnaire.type != 'QuizQuestionnaire' %><td align=left>weight</td><%end%>

</tr>
<% end %>

<% for @question in @questionnaire.questions %>
<% questionnum=@question.id %>
<tr>
<% if $disp_flag != 1 %>
<td > <%= text_area "question[]", 'txt', :cols=>100 %></td>
<% end %>
<% @quiz_question_choices = QuizQuestionChoice.where(question_id: @question.id) %>

</tr>
<% i=1 %>

<% for @quiz_question_choice in @quiz_question_choices %>
<tr>
<td>
   
<% if @question.type=="MultipleChoiceCheckbox" %>
<%= hidden_field_tag("quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][iscorrect]",'0') %>
<%= check_box_tag("quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][iscorrect]",'1', @quiz_question_choice.iscorrect) %>
 <%= text_field_tag "quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][txt]", @quiz_question_choice.txt, :size=>40 %>

<% end %>

<%if @question.type=="MultipleChoiceRadio" %>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][MultipleChoiceRadio][correctindex]", "#{i}", @quiz_question_choice.iscorrect)%>
 <%= text_field_tag "quiz_question_choices[#{questionnum}][MultipleChoiceRadio][#{i}][txt]", @quiz_question_choice.txt, :size=>40 %>
<% end %>

<%if @question.type=="TrueFalse" %>
<% if @quiz_question_choice.txt=="True"%>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][TrueFalse][1][iscorrect]", 'True', @quiz_question_choice.iscorrect) %> True
<%end%>

<% if @quiz_question_choice.txt=="False"%>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][TrueFalse][1][iscorrect]", 'False', @quiz_question_choice.iscorrect) %> False
<%end%>
<% end %>
</td>
</tr>
<% i+=1 %>
<%end %>

<% end %>
</table>
<% end %>
</pre>

After refactoring, the same file looked like:

<pre>
<% if @questionnaire.type == 'QuizQuestionnaire' %>

<table id="questions_table">
<% if $disp_flag != 1 %>
<tr>
<td align=left width=300>Questions:</td>
<% if @questionnaire.type != 'QuizQuestionnaire' %><td align=left>weight</td><%end%>

</tr>
<% end %>

<% for @question in @questionnaire.questions %>
<% i=1 %>
<%= @question.edit(i) %>
<% end %>
</table>
<% end %>
</pre>
== Refactoring <tt>complete</tt> ==
Logic is written in multiple_choice_checkbox model for multiple choice checkbox question type. Similarly, same process is followed for remaining question types. To begin a quiz, <tt>complete</tt> is called from the model.
@question = self
html = ""
html += label_tag("#{question.id}", question.txt) +" "
quiz_question_choices = QuizQuestionChoice.where(question_id: @question.id)
quiz_question_choices.each do |choice|
if answer=="view"
html += check_box_tag ("#{question.id}[]", "#{choice.txt}", choice.iscorrect)
html += label_tag("#{choice.txt}", choice.txt) + " "
end
if answer=="take"
html += check_box_tag ("#{question.id}[]", "#{choice.txt}")
html += label_tag("#{choice.txt}", choice.txt) + " "
end
html.html_safe
end
end

== Refactoring <tt>view_completed_question</tt> ==
The logic for viewing completed question and their answers is written in <tt>app/views/student_quizzes/finished_quiz.html.erb</tt> using a redundant if-elsif structure as shown below.
<% if question_type.eql? 'MultipleChoiceRadio' %>
<% QuizQuestionChoice.where(question_id: question.id).each do |answer| %>
<% if(answer.iscorrect) %>
<%= p answer.txt %> -- Correct 
<%else%>
<%= p answer.txt %> 
<% end %>
<% end %>
 
<%user_answer=Answer.where(response_id: @response.id, question_id: question.id).first%>
Your answer is: <%= user_answer.comments %>
<%if user_answer.answer==1%>
<img src="/assets/Check-icon.png"/>
<%else%>
<img src="/assets/delete_icon.png"/>
<%end%>
 
<% elsif question_type.eql? 'MultipleChoiceCheckbox' %>
...
<% elsif(question_type == 'TrueFalse') %>
...
The <tt>app/views/student_quizzes/finished_quiz.html.erb</tt> was refactored by removing the logic from the view and making it clean. We used a single construct which determines question type and answer type by calling view_completed_question method declared in quiz class as shown below.
<%user_answer=Answer.where(response_id: @response.id, question_id: question.id)%>
Question <%= i %>: <%= label_tag "#{question.id}", question.txt %> 
<%= question.view_completed_question(i,user_answer) %>
<% i += 1 %>
Similarly, logic was written in models for each of the question types. Following code snippet shows <tt>view_completed_question</tt> for true/false question type.
def view_completed_question(count, answer)
@question = self
html=""
html+= "Correct Answer is: "
html+= QuizQuestionChoice.where(question_id: @question.id,iscorrect: 1).first.txt
html+= " "
html+= "Your answer is: "
html+= answer.first.coments + ""
if(answer.first.answer == 1)
html+= "<img src=/assets/Check-icon.png/>"
else
html+= "<img src=/assets/delete_icon.png/>"
end
html+= " "
end

'''Remove irrelevant comments from the student_quizzes_controller'''
The <tt>student_quizzes_controller</tt> has a few comments which are irrelevant and make the method bulky. These could be safely removed from the code.

== Unit Testing ==
We added unit tests in <tt>spec/models/quiz_question_spec.rb</tt> which check the generated HTML for each of the refactored methods. by We used <tt>context</tt> blocks to incorporate tests for each type of question. Here is an example of the tests for <tt>view_question_text</tt>:

<pre>
describe "view_question_text" do
context "when the question is a multiple-choice radio" do
it "contains the text of the question" do
expect(@radio_question.view_question_text.html_safe).to include("In which city is NCSU located?")
end

it "contains each of the choices" do
expect(@radio_question.view_question_text.html_safe).to include("Raleigh")
expect(@radio_question.view_question_text.html_safe).to include("Atlanta")
expect(@radio_question.view_question_text.html_safe).to include("Charlotte")
expect(@radio_question.view_question_text.html_safe).to include("North Carolina")
end

it "bolds the correct answer" do
expect(@radio_question.view_question_text.html_safe).to include("Raleigh")
end

it "does not bold incorrect answers" do
expect(@radio_question.view_question_text.html_safe).not_to include("Atlanta")
expect(@radio_question.view_question_text.html_safe).not_to include("Charlotte")
expect(@radio_question.view_question_text.html_safe).not_to include("North Carolina")
end
end

context "when the question is a multiple-choice checkbox" do
it "contains the text of the question" do
expect(@checkbox_question.view_question_text.html_safe).to include("Which of the following are colors?")
end

it "contains each of the choices" do
expect(@checkbox_question.view_question_text.html_safe).to include("Paint")
expect(@checkbox_question.view_question_text.html_safe).to include("Blue")
expect(@checkbox_question.view_question_text.html_safe).to include("Car")
expect(@checkbox_question.view_question_text.html_safe).to include("Red")
end

it "bolds the correct answers" do
expect(@checkbox_question.view_question_text.html_safe).to include("Blue")
expect(@checkbox_question.view_question_text.html_safe).to include("Red")
end

it "does not bold incorrect answers" do
expect(@checkbox_question.view_question_text.html_safe).not_to include("Paint")
expect(@checkbox_question.view_question_text.html_safe).not_to include("Car")
end
end

context "when the question is true/false" do
it "contains the text of the question" do
expect(@true_false_question.view_question_text.html_safe).to include("2+2=4")
end

it "contains each of the choices" do
expect(@true_false_question.view_question_text.html_safe).to include("True")
expect(@true_false_question.view_question_text.html_safe).to include("False")
end

it "bolds the correct answer" do
expect(@true_false_question.view_question_text.html_safe).to include("True")
end

it "does not bold the incorrect answer" do
expect(@true_false_question.view_question_text.html_safe).not_to include("False")
end
end
end
</pre>

== UI Testing ==
You may want to use the following information to make UI testing easier if you are using the link in the Expertiza submission:

'''Assignment''': Quiz Assignment 
'''Instructor''': super_administrator2 
'''Students''': student15, student16, student17, student18, student19, student20 

If you are using the link in the Expertiza submission, you do not need a password. We made this change to facilitate testing. The committed code ''does not'' make any change for authenticating users.

Since this project involved code refactoring, no new functionality was added. But here are tests for each method to verify they are working correctly.

=== <tt>view_question_text</tt> ===
# Login as a student.
# Select an assignment that has quizzing enabled (e.g. Quiz Assignment).
# Select "Your Work"
# If you haven't created a quiz yet, go ahead and create one by clicking the "Create Quiz" link.
# Select "View quiz".
# You should see each question, followed by the choices. The correct choice(s) will be bolded.

=== <tt>edit</tt> ===
# Login as a student.
# Select an assignment that has quizzing enabled (e.g. Quiz Assignment).
# Select "Your Work"
# If you haven't created a quiz yet, go ahead and create one by clicking the "Create Quiz" link.
# Select "Edit quiz".
# You should see each question, followed by the choices, each in an editable text field. The correct choice(s) will be checked.

=== <tt>complete</tt> ===
# Login as a student.
# Select an assignment that has quizzing enabled (e.g. Quiz Assignment).
# Select "Your Work"
# If you haven't created a quiz yet, go ahead and create one by clicking the "Create Quiz" link.
# Select "Take Quizzes".
# Click 'Begin'.
# You should see each question, followed by the choices. You can record your answers for each questions and then click 'submit'. Your answers will be saved.

=== <tt>view_completed_question</tt> ===
# Login as a student.
# Select an assignment that has quizzing enabled (e.g. Quiz Assignment).
# Select "Your Work"
# If you haven't created/taken a quiz yet, go ahead and create one by clicking the "Create Quiz" link and take the quiz.
# Find a finished quiz and click on 'View'.
# You should see each question, followed by the choices. The correct choice(s) will be bolded and your recorded answer will be shown.

N.B. The VCL image sometimes may take a longer time to load. But, it's up and running perfectly.

CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature

2016-04-01T22:18:27Z

Dasoni:

CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature

2016-03-24T02:34:30Z

Dasoni: /* Refactoring view_completed_question */

CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature

2016-03-24T02:33:44Z

Dasoni: /* Remove irrelevant comments from the student_quizzes_controller */

This wiki page is for the description of changes made under E1602 OSS assignment for Spring 2016, CSC/ECE 517.

== Introduction ==
====Background====

Expertiza is an open source project based on Ruby on Rails framework. Expertiza has a quizzing feature which allow student authors to create quiz questions and test the peer reviewers. The idea behind this is, if a reviewer can answer the quiz questions which were created by the author correctly, we assume that the reviewer has read the artifact carefully enough and thereby we trust the peer-review.

====Current Implementation and Problems====
* Following three different types of questions are supported in quizzing feature of Expertiza
# Multiple Choice Radio
# Multiple Choice Checkbox
# True/False
* The current implementation of Quizzing feature is not consistent with the current questions and questionnaires. Since Quiz questionnaire is one sub type of questionnaire, so it should follow the design of other type of questionnaires. But, the current implementation is inconsistent with other questionnaires.
* In order to create a quiz, the existing code is written in the views which has a series of if-then structures to implement the functionality of each different question type. This kind of implementation makes the code slower and violates the principles of MVC architecture.
* Current HTML code doesn't looks like source code.
* Code is repeated for different question types.
* Proper Ruby naming conventions are not followed
====Changes Implemented====
* All logic moved to model. Four separate methods - <tt>edit</tt>, <tt>view_question_text</tt>, <tt>complete</tt> and <tt>view_completed_question</tt> in order to generate the same HTML for each of the question types. We used polymorphism by declaring all these methods in <tt>QuizQuestion</tt> which inherits from <tt>Question</tt> and has sub-types <tt>MultipleChoiceRadio</tt>, <tt>MultipleChoiceCheckbox</tt>, and <tt>TrueFalse</tt>.
* When questionnaire author creates a quiz, <tt>edit</tt> is called. To call this on UI, you can login as a student, click 'create quiz' / 'edit quiz' on 'Your Works' page. The <tt>edit</tt> method is now called from <tt>/view/questionnaires/_quiz_question.html.erb</tt>
* When questions are viewed by the author or the instructor, <tt>view_question_text</tt> method is called. To call this on UI, you can either login as a student, click 'view quiz' on 'Your works' page or login as an instructor, find an assignment with quizzing feature and click the icon 'view quiz questions'. The 'view_question_text' calls <tt>view/questionnaires/view.html.erb</tt>

* When the quiz takers tries to take the quiz, <tt>complete</tt> is called. To call this on UI, you can login as a quiz taker, request a quiz to take on “Take quizzes” page, then click “begin”. This method is now called on <tt>view/student_quizzes/take_quiz</tt>.
* When the quiz taker finished taking a quiz and wants to view the quiz result again, <tt>view_completed_question</tt> is called. To call this on UI, you can login as a quiz taker, find a finished quiz and click “view”. This method is called on <tt>view/student_quizzes/finished_quiz</tt>.
* Using polymorphism and DRY principles, code repetition has been virtually eliminated.

== Refactoring <tt>view_question_text</tt> ==

The <tt>view_question_text</tt> method is called when the author of the quiz or the instructor views the quiz. The method is responsible for generating the HTML to display the question along with each of its choices. The correct choice(s) should be bolded. Prior to refactoring, this functionality was located in <tt>app/views/student_quizzes/review_questions.html.erb</tt>:
<pre>
<%questions = questionnaire.questions%>
<% questions.each do |question| %>
 <%= question.txt %> 
<% question_type = question.get_formatted_question_type%>
Question Type: <%= question_type %> 

<% if question_type == 'True/False' %>
Correct Answer: <%= (QuizQuestionChoice.where(question_id: question.id, iscorrect:1).first.txt) %> 
<% elsif question_type == 'Multiple Choice - Radio' %>
<% correct_answer = '' %>
Answer Options: 
<% QuizQuestionChoice.where(question_id: question.id).each do |choice| %>
<% if choice.iscorrect == true %>
  <%= choice.txt %> 
<%else%>
  <%= choice.txt %> 
<% end %>

<% end %>
 
<% elsif question_type == 'Multiple Choice - Checked' %>
Answer Options: 
<% QuizQuestionChoice.where(question_id: question.id).each do |choice| %>
<% if choice.iscorrect == true %>
  <%= choice.txt %> 
<%else%>
  <%= choice.txt %> 
<% end %>
<% end %>
 
<% end %>
<% end %><hr>
</pre>

This logic has been moved to <tt>app/models/quiz_question.rb</tt>, so now the view simply needs to call the method:
<pre>
<%questions = questionnaire.questions%>
<%questions.each do |question| %>

<%if question.is_a? Question%>
<%=question.view_question_text.html_safe%>
<%end%>

<% end %><hr>
</pre>

Unit tests were added to <tt>spec/models/quiz_question_spec.rb</tt> covering all three types of questions to ensure that the correct HTML is generated.

== Refactoring <tt>edit</tt> ==

The <tt>edit</tt> method is called when the author creates or edits a quiz. It makes every element of the quiz editable. Prior to refactoring, the HTML was in <tt>app/views/questionnaires/_quiz_questionnaire.html.erb</tt>:

<pre>
<% if @questionnaire.type == 'QuizQuestionnaire' %>

<table id="questions_table">
<% if $disp_flag != 1 %>
<tr>
<td align=left width=300>Questions:</td>
<% if @questionnaire.type != 'QuizQuestionnaire' %><td align=left>weight</td><%end%>

</tr>
<% end %>

<% for @question in @questionnaire.questions %>
<% questionnum=@question.id %>
<tr>
<% if $disp_flag != 1 %>
<td > <%= text_area "question[]", 'txt', :cols=>100 %></td>
<% end %>
<% @quiz_question_choices = QuizQuestionChoice.where(question_id: @question.id) %>

</tr>
<% i=1 %>

<% for @quiz_question_choice in @quiz_question_choices %>
<tr>
<td>
   
<% if @question.type=="MultipleChoiceCheckbox" %>
<%= hidden_field_tag("quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][iscorrect]",'0') %>
<%= check_box_tag("quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][iscorrect]",'1', @quiz_question_choice.iscorrect) %>
 <%= text_field_tag "quiz_question_choices[#{questionnum}][MultipleChoiceCheckbox][#{i}][txt]", @quiz_question_choice.txt, :size=>40 %>

<% end %>

<%if @question.type=="MultipleChoiceRadio" %>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][MultipleChoiceRadio][correctindex]", "#{i}", @quiz_question_choice.iscorrect)%>
 <%= text_field_tag "quiz_question_choices[#{questionnum}][MultipleChoiceRadio][#{i}][txt]", @quiz_question_choice.txt, :size=>40 %>
<% end %>

<%if @question.type=="TrueFalse" %>
<% if @quiz_question_choice.txt=="True"%>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][TrueFalse][1][iscorrect]", 'True', @quiz_question_choice.iscorrect) %> True
<%end%>

<% if @quiz_question_choice.txt=="False"%>
<%= radio_button_tag("quiz_question_choices[#{questionnum}][TrueFalse][1][iscorrect]", 'False', @quiz_question_choice.iscorrect) %> False
<%end%>
<% end %>
</td>
</tr>
<% i+=1 %>
<%end %>

<% end %>
</table>
<% end %>
</pre>

After refactoring, the same file looked like:

<pre>
<% if @questionnaire.type == 'QuizQuestionnaire' %>

<table id="questions_table">
<% if $disp_flag != 1 %>
<tr>
<td align=left width=300>Questions:</td>
<% if @questionnaire.type != 'QuizQuestionnaire' %><td align=left>weight</td><%end%>

</tr>
<% end %>

<% for @question in @questionnaire.questions %>
<% i=1 %>
<%= @question.edit(i) %>
<% end %>
</table>
<% end %>
</pre>
== Refactoring <tt>complete</tt> ==
Logic is written in multiple_choice_checkbox model for multiple choice checkbox question type. Similarly, same process is followed for remaining question types. To begin a quiz, <tt>complete</tt> is called from the model.
@question = self
html = ""
html += label_tag("#{question.id}", question.txt) +" "
quiz_question_choices = QuizQuestionChoice.where(question_id: @question.id)
quiz_question_choices.each do |choice|
if answer=="view"
html += check_box_tag ("#{question.id}[]", "#{choice.txt}", choice.iscorrect)
html += label_tag("#{choice.txt}", choice.txt) + " "
end
if answer=="take"
html += check_box_tag ("#{question.id}[]", "#{choice.txt}")
html += label_tag("#{choice.txt}", choice.txt) + " "
end
html.html_safe
end
end

== Refactoring <tt>view_completed_question</tt> ==
The logic for viewing completed question and their answers is written in <tt>app/views/student_quizzes/finished_quiz.html.erb</tt> using a redundant if-elsif structure as shown below.
<% if question_type.eql? 'MultipleChoiceRadio' %>
<% QuizQuestionChoice.where(question_id: question.id).each do |answer| %>
<% if(answer.iscorrect) %>
<%= p answer.txt %> -- Correct 
<%else%>
<%= p answer.txt %> 
<% end %>
<% end %>
 
<%user_answer=Answer.where(response_id: @response.id, question_id: question.id).first%>
Your answer is: <%= user_answer.comments %>
<%if user_answer.answer==1%>
<img src="/assets/Check-icon.png"/>
<%else%>
<img src="/assets/delete_icon.png"/>
<%end%>
 
<% elsif question_type.eql? 'MultipleChoiceCheckbox' %>
...
<% elsif(question_type == 'TrueFalse') %>
...
The <tt>app/views/student_quizzes/finished_quiz.html.erb</tt> was refactored by removing the logic from the view and making it clean. We used a single construct which determines question type and answer type by calling view_completed_question method declared in quiz class as shown below.
<%user_answer=Answer.where(response_id: @response.id, question_id: question.id)%>
Question <%= i %>: <%= label_tag "#{question.id}", question.txt %> 
<%= question.view_completed_question(i,user_answer) %>
<% i += 1 %>
Similarly, logic was written in models for each of the question types. Following code snippet shows <tt>view_completed_question</tt> for true/false question type.
def view_completed_question(count, answer)
@question = self
html=""
html+= "Correct Answer is: "
html+= QuizQuestionChoice.where(question_id: @question.id,iscorrect: 1).first.txt
html+= " "
html+= "Your answer is: "
html+= answer.first.coments + ""
if(answer.first.answer == 1)
html+= "<img src=/assets/Check-icon.png/>"
else
html+= "<img src=/assets/delete_icon.png/>"
end
html+= " "
end

'''Remove irrelevant comments from the <tt>student_quizzes_controller'''
The <tt>student_quizzes_controller</tt> has a few comments which are irrelevant and make the method bulky. These could be safely removed from the code.

== Unit Testing ==
We added unit tests in <tt>spec/models/quiz_question_spec.rb</tt> which check the generated HTML for each of the refactored methods. by We used <tt>context</tt> blocks to incorporate tests for each type of question. Here is an example of the tests for <tt>view_question_text</tt>:

<pre>
describe "view_question_text" do
context "when the question is a multiple-choice radio" do
it "contains the text of the question" do
expect(@radio_question.view_question_text.html_safe).to include("In which city is NCSU located?")
end

it "contains each of the choices" do
expect(@radio_question.view_question_text.html_safe).to include("Raleigh")
expect(@radio_question.view_question_text.html_safe).to include("Atlanta")
expect(@radio_question.view_question_text.html_safe).to include("Charlotte")
expect(@radio_question.view_question_text.html_safe).to include("North Carolina")
end

it "bolds the correct answer" do
expect(@radio_question.view_question_text.html_safe).to include("Raleigh")
end

it "does not bold incorrect answers" do
expect(@radio_question.view_question_text.html_safe).not_to include("Atlanta")
expect(@radio_question.view_question_text.html_safe).not_to include("Charlotte")
expect(@radio_question.view_question_text.html_safe).not_to include("North Carolina")
end
end

context "when the question is a multiple-choice checkbox" do
it "contains the text of the question" do
expect(@checkbox_question.view_question_text.html_safe).to include("Which of the following are colors?")
end

it "contains each of the choices" do
expect(@checkbox_question.view_question_text.html_safe).to include("Paint")
expect(@checkbox_question.view_question_text.html_safe).to include("Blue")
expect(@checkbox_question.view_question_text.html_safe).to include("Car")
expect(@checkbox_question.view_question_text.html_safe).to include("Red")
end

it "bolds the correct answers" do
expect(@checkbox_question.view_question_text.html_safe).to include("Blue")
expect(@checkbox_question.view_question_text.html_safe).to include("Red")
end

it "does not bold incorrect answers" do
expect(@checkbox_question.view_question_text.html_safe).not_to include("Paint")
expect(@checkbox_question.view_question_text.html_safe).not_to include("Car")
end
end

context "when the question is true/false" do
it "contains the text of the question" do
expect(@true_false_question.view_question_text.html_safe).to include("2+2=4")
end

it "contains each of the choices" do
expect(@true_false_question.view_question_text.html_safe).to include("True")
expect(@true_false_question.view_question_text.html_safe).to include("False")
end

it "bolds the correct answer" do
expect(@true_false_question.view_question_text.html_safe).to include("True")
end

it "does not bold the incorrect answer" do
expect(@true_false_question.view_question_text.html_safe).not_to include("False")
end
end
end
</pre>