Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T22:09:23Z

Mguo6: /* Frontend Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "github_metric_uses" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: github_metric_uses'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The GithubMetricUsesController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_github_use' colspan="2">
<input type="checkbox" name = "github_use" id="github_use" <%= "checked"
if GithubMetricUsesController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('github_use', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if GithubMetricUsesController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#github_use').change(function () {
if (jQuery('#github_use').is(':checked')) {
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\github_metric_uses_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table github_metric_uses. If so, return TRUE.
#check if assignment_id exists in the table github_metric_uses
def self.exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
!github_use.nil?
end

2. If assignment_id does not exist in the table github_metric_uses, save it.
#if assignment_id does not exist in the table github_metric_uses, save it
def self.save(assignment_id)
unless exist(assignment_id)
github_use = GithubMetricUses.new(assignment_id)
github_use.assignment_id = assignment_id
github_use.save
end
end

3. If assignment_id exists in the table github_metric_uses, delete it
#if assignment_id exists in the table github_metric_uses, delete it
def self.delete(assignment_id)
if exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
github_use.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table github_metric_uses
def exist
assignment_id = params[:assignment_id]
GithubMetricUsesController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table github_metric_uses, save it
def save
assignment_id = params[:assignment_id]
GithubMetricUsesController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table github_metric_uses, delete it
def delete
assignment_id = params[:assignment_id]
GithubMetricUsesController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
Assignments could be edited on the assignment viewing page. Also, the submissions would be showed and there would be differences when "Github metrics" is chosen or is not chosen.

=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T21:55:26Z

Mguo6: /* Database Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "github_metric_uses" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: github_metric_uses'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The GithubMetricUsesController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if GithubMetricUsesController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if GithubMetricUsesController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\github_metric_uses_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table github_metric_uses. If so, return TRUE.
#check if assignment_id exists in the table github_metric_uses
def self.exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
!github_use.nil?
end

2. If assignment_id does not exist in the table github_metric_uses, save it.
#if assignment_id does not exist in the table github_metric_uses, save it
def self.save(assignment_id)
unless exist(assignment_id)
github_use = GithubMetricUses.new(assignment_id)
github_use.assignment_id = assignment_id
github_use.save
end
end

3. If assignment_id exists in the table github_metric_uses, delete it
#if assignment_id exists in the table github_metric_uses, delete it
def self.delete(assignment_id)
if exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
github_use.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table github_metric_uses
def exist
assignment_id = params[:assignment_id]
GithubMetricUsesController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table github_metric_uses, save it
def save
assignment_id = params[:assignment_id]
GithubMetricUsesController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table github_metric_uses, delete it
def delete
assignment_id = params[:assignment_id]
GithubMetricUsesController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
Assignments could be edited on the assignment viewing page. Also, the submissions would be showed and there would be differences when "Github metrics" is chosen or is not chosen.

=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T21:51:06Z

Mguo6:

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The GithubMetricUsesController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if GithubMetricUsesController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if GithubMetricUsesController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/github_metric_uses/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\github_metric_uses_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table github_metric_uses. If so, return TRUE.
#check if assignment_id exists in the table github_metric_uses
def self.exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
!github_use.nil?
end

2. If assignment_id does not exist in the table github_metric_uses, save it.
#if assignment_id does not exist in the table github_metric_uses, save it
def self.save(assignment_id)
unless exist(assignment_id)
github_use = GithubMetricUses.new(assignment_id)
github_use.assignment_id = assignment_id
github_use.save
end
end

3. If assignment_id exists in the table github_metric_uses, delete it
#if assignment_id exists in the table github_metric_uses, delete it
def self.delete(assignment_id)
if exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
github_use.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table github_metric_uses
def exist
assignment_id = params[:assignment_id]
GithubMetricUsesController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table github_metric_uses, save it
def save
assignment_id = params[:assignment_id]
GithubMetricUsesController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table github_metric_uses, delete it
def delete
assignment_id = params[:assignment_id]
GithubMetricUsesController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
Assignments could be edited on the assignment viewing page. Also, the submissions would be showed and there would be differences when "Github metrics" is chosen or is not chosen.

=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T21:48:43Z

Mguo6:

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The GithubMetricUsesController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if GithubMetricUsesController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if GithubMetricUsesController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
!github_use.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
github_use = GithubMetricUses.new(assignment_id)
github_use.assignment_id = assignment_id
github_use.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
github_use = GithubMetricUses.find_by(assignment_id: assignment_id)
github_use.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
GithubMetricUsesController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
GithubMetricUsesController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
GithubMetricUsesController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
Assignments could be edited on the assignment viewing page. Also, the submissions would be showed and there would be differences when "Github metrics" is chosen or is not chosen.

=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T21:31:29Z

Mguo6: /* Functionality Walk Through */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
Assignments could be edited on the assignment viewing page. Also, the submissions would be showed and there would be differences when "Github metrics" is chosen or is not chosen.

=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T21:12:00Z

Mguo6: /* Testing */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
The details are in the Test Plan [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2149._Finish_Github_metrics_integration_-_Reputations#Test_Plan].

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T20:38:13Z

Mguo6: /* Testing */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
Testing part Includes UI Testing and Rspec. Our UI tests aim to capture the following core pieces of functionality. Detailed of Using Github Testing first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T20:37:51Z

Mguo6: /* Testing */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
Testing part Includes UI Testing and Rspec. Our UI tests aim to capture the following core pieces of functionality.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T20:36:49Z

Mguo6: /* Testing */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
Testing part Includes UI Testing and Rspec.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-12-01T20:35:50Z

Mguo6: /* Test Plan */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. We will some RSpec test code to test the function.

==Team Action Items==

==== Adding turn on and turn off option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the class method in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses the instance method in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Class Methods =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Instance Methods =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment id if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
The Github API requires users to be authenticated to query the API. Since GitHub no longer supports authentication through query parameters, we move the authentication to the header. From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and communication between the Expertiza server and Github, and using client_id/client_secret to make OAuth app unauthenticated are disabled.

The callback URL (the URL of the Expertiza server) is set within Github.com, where the OAuth app is configured (and Client Keys/Secrets are generated). The code from the previous project uses Client Key/Secret pairs that are tied to a Github OAuth app that is configured to callback to http://localhost:3000/auth/github/callback. Naturally, when Expertiza is running in a production environment, or a deployment on a remote server where the client is not on the localhost, this callback will fail to redirect.

Therefore, we create a new OAuth app using a Github.com account that configures a callback URL to http://server_ip_or_url:port/auth/github2021/callback/. The production callback URL is: https://expertiza.ncsu.edu/auth/github2021/callback. The reason "github2021" is used for this project is due to Github's 2021 updates to their security infrastructure -- our code handles "github" and "github2021" callbacks differently to match these security updates.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

Move the authentication to the header
def query_commit_statistics(data)
uri = URI.parse("https://api.github.com/graphql")
http = Net::HTTP.new(uri.host, uri.port) # host: api.github.com, port: 443
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
# request = Net::HTTP::Post.new(uri.path, 'Authorization' => 'Bearer' + ' ' + session["github_access_token"]) # set up authorization
request = Net::HTTP::Post.new(uri.path) # set up authorization
# send the token in the header
request['Authorization'] = 'Bearer' + ' ' + session["github_access_token"]
request.body = data.to_json # convert query message to json and pass as request body
response = http.request(request) # make the actual request
ActiveSupport::JSON.decode(response.body.to_s) # convert the response body to string, decoded then return
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn off functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Using Github Testing
first, go to the assignment edit page and check the checkbox of use github metric, then go to the list submission page check the page if has the content about ithub data.

it "check the box of the use github metrics? and the list_submissions page will have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: true)
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_content("Github data")
end

it "uncheck the checkbox of the use github metrics? and the list_submissions page will not have the content 'Github data' " do
visit "/assignments/#{@assignment.id}/edit"
check('Use github metrics?', allow_label_click: false)
page.uncheck('Use github metrics?')
visit "/assignments/list_submissions?id=#{@assignment.id}"
expect(page).to have_no_content("Github data")
end

==Resources==
=====Key Links=====
[https://github.com/expertiza/expertiza/pull/2158 Pull Request Of E2149]

[https://www.youtube.com/watch?v=8BveAT6ourQ&t=80s demo video Of E2149]

[https://www.youtube.com/watch?v=UiPNnQdWPqo test video Of E2149]

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:50:07Z

Mguo6: /* Not Self Functions */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the self function in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses not self functions in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====
URL in frontend uses such functions.

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:49:40Z

Mguo6: /* Frontend Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the self function in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3. Post the assignment id if the user selects the 'check' button and delete the data if the user cancels it by url. The function uses not self functions in controller.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:44:19Z

Mguo6: /* Frontend Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the self function in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}
$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:43:59Z

Mguo6: /* Frontend Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics. The UseGithubMetricsController.exist use the self function in the controller.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

3.

jQuery(document).ready(function () {
// This function determines whether the 'Topics' tab must be displayed when the page is re-loaded
var checkbox = jQuery('#assignment_has_topics');
if (checkbox.is(':checked')) {
// If this checkbox is checked, show the 'Topics' tab
jQuery("#topics_tab_header").show();
} else {
// Otherwise, hide topics tab
jQuery("#topics_tab_header").hide();
}

$('#use_github').change(function () {
if (jQuery('#use_github').is(':checked')) {
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'POST',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
} else{
jQuery.ajax({
url: '/use_github_metrics/' + <%= @assignment.id %>,
method: 'DELETE',
xhrFields: {
withCredentials: true
},
dataType: 'json'
})
}
})
});

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

GitHub's OAuth implementation

[[File:github-oauth.png|750px]]

#Use Oauth protocols to attempt to authorize user for either google or github
def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

After requesting the user's GitHub identity, the user will be redirected back to Expertiza by GitHub. If the user accepts the request, GitHub redirects back to expertiza with a temporary code in a code parameter and the state provided in the previous step in a state parameter. The client_id and client_secret are required as they received from GitHub for Expertiza. The code is also required as it would be a response to the request. Then the access token allows Expertiza to make requests to the API on a behalf of a user.

#Login functionality for Github to get access_token
def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:16:49Z

Mguo6: /* Self Functions */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

1. Check if assignment_id exists in the table use_github_metrics. If so, return TRUE.
#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

2. If assignment_id does not exist in the table use_github_metrics, save it.
#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

3. If assignment_id exists in the table use_github_metrics, delete it
#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

===Using access_token as a query param===
Originally, the code uses the API with parameters。
curl "https://api.github.com/user/repos?access_token=my_access_token"

Now, we send the token in the header:
curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos

===Using client_id/client_secret as a query param===
Originally, the code uses an OAuth app's client_id and client_secret to make unauthenticated calls with a higher rate limit similar to
curl "https://api.github.com/user/repos?client_id=my_client_id&client_secret=my_secret_id"
Instead, we use the following format:
curl -u my_client_id:my_client_secret https://api.github.com/user/repos

[[File:github-oauth.png|700px]]

def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:13:55Z

Mguo6: /* Controller Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== Self Functions =====

#check if assignment_id exists in the table use_github_metrics
def self.exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
!use_github.nil?
end

#if assignment_id does not exist in the table use_github_metrics, save it
def self.save(assignment_id)
unless exist(assignment_id)
use_github = UseGithubMetric.new(assignment_id)
use_github.assignment_id = assignment_id
use_github.save
end
end

#if assignment_id exists in the table use_github_metrics, delete it
def self.delete(assignment_id)
if exist(assignment_id)
use_github = UseGithubMetric.find_by(assignment_id: assignment_id)
use_github.destroy
end
end

===== Not Self Functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

===Using access_token as a query param===
Originally, the code uses the API with parameters。
curl "https://api.github.com/user/repos?access_token=my_access_token"

Now, we send the token in the header:
curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos

===Using client_id/client_secret as a query param===
Originally, the code uses an OAuth app's client_id and client_secret to make unauthenticated calls with a higher rate limit similar to
curl "https://api.github.com/user/repos?client_id=my_client_id&client_secret=my_secret_id"
Instead, we use the following format:
curl -u my_client_id:my_client_secret https://api.github.com/user/repos

def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

def custom_github_login
session_code = request.env['rack.request.query_hash']['code']
result = RestClient.post('https://github.com/login/oauth/access_token',
{:client_id => GITHUB_CONFIG['client_key'],
:client_secret => GITHUB_CONFIG['client_secret'],
:code => session_code},
:accept => :json)
access_token = JSON.parse(result)['access_token']
session["github_access_token"] = access_token
redirect_to controller: 'assignments', action: 'list_submissions', id: session["assignment_id"]
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T22:12:39Z

Mguo6: /* Controller Modification */

==Abstract==
Expertiza provides teammate reviews to measure how much each team member contributed. It also augments this data with Github data of each group’s submitted repo link to help differentiate the performance of team members for grading purposes and predict which projects are likely to be merged. Instructors would like to compile this Github repository statistics on a per-project, per-team basis, and integrate the display of these data within Expertiza.
The project team will troubleshoot existing code and add new features.

==Problem Statement==
The functionality of the showing GitHub metrics cannot be turned off, meaning that an instructor who uses Expertiza for writing assignments in an English course would get a Github metrics report. There needs to be a way to turn the report off for a particular assignment. The project doesn't report lines added and deleted because of the lack of support from the current API. It adds quite a lot of lines of code for a single project and some codes could be refactored. The test plans of the current project are not described thoroughly enough. We will modify the existing RSpec test code and add some new tests.

==Methodology==
The team has synced the revised 2021 Spring project E2111 code with the current status of the Expertiza/beta branch and has begun analyzing the existing code. Prior customer feedback has advised the team to address inextensibility/coupling issues, documentation issues, and synchronization issues. We are performing our own end-to-end analysis of the code in addition to this feedback, and have found numerous action items so far. We have separated these action items into Primary and Secondary objectives: Primary objectives are "must-haves" that need to be addressed before the existing code is mergeable. Secondary objectives are "nice-to-haves" or features that are either left out of the original project or will make the integration display more integrated.

==Team Action Items==

==== Adding turn on and turn down option ====
The functionality of the current project cannot be turned off. We will provide an option for instructors not to query Github metrics data before they post the assignment, which is the way we turn the GitHub report off for a particular assignment.

[[File:Turn on.png|800px]]

==== Database Modification ====
In order to determine whether the GitHub report of the assignment is turned on or turned off, we need to create a new table named "use_github_metric" to save the id of the assignment whose GitHub metric is turned on. We also have an alternative solution to add a boolean field in the assignment table, but due to security concerns, we give it up. We think we should not change the data of the assignment.

'''Table: use_github_metric'''
{| class="wikitable"
|- style="font-weight:bold;"
! id(PK)
! Assignment_id(FK)
|-
| 1
| 1
|-
| 2
| 15
|}

==== Simplify the Codes ====
Extract the repeating part of codes and then construct an independent method based on them. Finally, we could use this method.

The last edition uses the lots of Google API to help generate the chart, we can use the method from helper to generate charts instead.

==== Frontend Modification ====
If a user chooses not to include the GitHub metric in the assignment (the functionality is turned off), the icon named "Login to Query of Github data" should not be displayed on the frontend page.

1. We edited expertiza\app\views\assignments\edit\_general.html.erb and added a checkbox. The codes are as follow.
If the id of the assignment exists, there will be a checkbox for the user to use github metrics.


<tr>
<td style='padding:5px' id='assignment_use_github' colspan="2">
<input type="checkbox" name = "use_github" id="use_github" <%= "checked"
if UseGithubMetricsController.exist(@assignment_form.assignment.id) %>></input>
<%= label_tag('use_github', 'Use github metrics?') %>
</td>
</tr>

2. The expertiza\app\views\assignments\list_submissions.html.erb is edited too.
If the id of the assignment exists and github_access_token is null (it means that the user hasn't logged in), then the page will show 'Login to Query Github data' button. If github_access_token is not null, it would show 'Refresh Github data' button because the user has logged in.

<%if UseGithubMetricsController.exist(@assignment.id) %>
<% if session["github_access_token"].nil? %>
<% topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@teams.first) %>
<%= link_to 'Login to Query Github data', { controller: 'metrics', action: 'show', id: participants.first.id } %>
<% else %>
<%= link_to 'Refresh Github data', { controller: 'metrics', action: 'query_assignment_statistics', id: @assignment.id},
:onclick => "showLoadIcon()"%>
<img id="load_icon" src="<%= image_url('ajax-loader.gif') %>" style="display:none">
<% end %>
<% end %>

==== Controller Modification ====
We added a function in expertiza\app\controllers\use_github_metrics_controller.rb as follwowing.

===== self functions =====

===== not self functions =====

1. Return TRUE if the assignment id exists.
#check if assignment_id exists in the table use_github_metrics
def exist
assignment_id = params[:assignment_id]
UseGithubMetricsController.exist(assignment_id)
end

2. Save assignment is if it doesn't exist. This function is for the frontend page to select the checkbox.
#if assignment_id does not exist in the table use_github_metrics, save it
def save
assignment_id = params[:assignment_id]
UseGithubMetricsController.save(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

3. Delete assignment id if it exists. This function is for the frontend page to cancel the checkbox.
#if assignment_id exists in the table use_github_metrics, delete it
def delete
assignment_id = params[:assignment_id]
UseGithubMetricsController.delete(assignment_id)
respond_to do |format|
format.json { render json: assignment_id }
end
end

==== Testing ====
See the details in Test Plan.

==Functionality Walk Through==
=== Assignment edit page view ===
An instructor can customize an assignment in this view. We will provide an option for instructors to decide whether they need Github metrics in the assignment or not.

Before we modified this part, this page is as follows:

[[File:Before liang.png|900px]]

After modifying it, this page is:

[[File:Edit page.png|900px]]

=== List Submissions View: with Github metrics option===
This is how a user will view List Submissions when they choose Github metrics in the previous assignment edit page and is not authenticated to Github yet. The Login link redirects to an omniauth login page, which redirects back to this page.

[[File:listviewwgithub.png|900px]]

=== List Submissions View: without Github metrics option===
This is how a user will view List Submissions when they did not choose Github metrics in the previous assignment edit page. The Login link for querying Github data would not be provided to the instructors if they don't choose the "use GitHub metric" option.

[[File:listviewwogithub.png|900px]]

==Final Design UML==
This UML shows the new classes and models we created and implemented in our final project. Besides these, we also modified some of the existing classes and methods, we will give more detailed information later.

[[File:E2149_Uml_1.png|800px]]

==OminiAuth Github API update==
GitHub no longer supports authentication through query parameters. Thus, we move the authentication to the header.
From September 8, 2021, using access_token as a query parameter to access the API (as a user or as a GitHub App) and using client_id/client_secret to make OAuth app unauthenticated are disabled.

===Using access_token as a query param===
Originally, the code uses the API with parameters。
curl "https://api.github.com/user/repos?access_token=my_access_token"

Now, we send the token in the header:
curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos

===Using client_id/client_secret as a query param===
Originally, the code uses an OAuth app's client_id and client_secret to make unauthenticated calls with a higher rate limit similar to
curl "https://api.github.com/user/repos?client_id=my_client_id&client_secret=my_secret_id"
Instead, we use the following format:
curl -u my_client_id:my_client_secret https://api.github.com/user/repos

def oauth_login
case params[:provider]
when "github"
github_login
when "google_oauth2"
google_login
when "github2021" # due to github 0
custom_github_login
else
ExpertizaLogger.error LoggerMessage.new(controller_name, user.name, "Invalid OAuth Provider", "")
end
end

==Test Plan==

=== UI Testing ===

Our UI tests aim to capture the following core pieces of functionality:

'''Turn on and turn down functionality button: '''

In order to test the functionality manually, we follow the following steps:
:1. Log in to Expertiza as an instructor
:2. Navigate to assignments through Manage
:3. Show a turn on/turn down option for Github metric on the page
:4. Process the page without choosing Github metrics report for a particular assignment
:5. The page should not display "Login to Query of Github data" options.

=== Rspec ===
Detailed of Github Testing

After changing the way of calling the GitHub API, we need to test whether we can get the data from the GitHub API correctly.

describe '#gets data from GitHub api v4(graphql)' do
end

describe '#get_github_repository_details' do
end

describe '#get_statuses_for_pull_request' do
end

==Resources==
=====Key Links=====

[https://docs.github.com/en/rest Github API Documentation]

[https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/ Deprecating API authentication through query parameters]

=====Previous Project References=====
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018-_Project_E1858._Github_metrics_integration Original E1858 Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1983._Refactor_E1858,_Github_metrics_integration_view E1983 Revision Documentation]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2021_-_E2111._Refactor_github_metrics_integration E2111 Project Refactoring]

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:53:47Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:53:29Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:28:03Z

Mguo6: /* Controller Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:26:43Z

Mguo6: /* Controller Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:22:11Z

Mguo6: /* Controller Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T21:10:57Z

Mguo6: /* Controller Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:51:54Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:51:20Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:50:45Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:50:11Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:42:53Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:40:10Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-30T20:39:27Z

Mguo6: /* Frontend Modification */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-09T04:16:32Z

Mguo6: /* Clarify the Codes */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-09T04:08:34Z

Mguo6: /* Team Action Items */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-09T04:08:01Z

Mguo6: /* Team Action Items */

CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations

2021-11-09T04:07:30Z

Mguo6: /* Team Action Items */

CSC/ECE 517 Fall 2021

2021-11-09T01:31:00Z

Mguo6: /* OSS Projects */

== OSS Projects ==

* [[CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2129. Refactor auth_controller.rb & password_retrieval_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2123. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2144. Refactor delayed mailer and scheduled task]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]
* [[CSC/ECE 517 Fall 2021 - E2146. Introduce a Student View for instructors]]
* [[CSC/ECE 517 Fall 2021 - Refactor Evaluation of SQL Queries]]
* [[CSC/ECE 517 Fall 2021 - E2135. Email notification to reviewers and instructors]]

== Final Projects ==
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2166._Testing_-_Scoring_%26_Grades#Description_about_project CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring_and_Grades]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2150._Integrate_suggestion_detection_algorithm#Description_about_project CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2151._Allow_reviewers_to_bid_on_what_to_review CSC/ECE 517 Fall 2021 - E2151. Allow reviewers to bid on what to review]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2152._Revision_planning_tool#Description_about_project CSC/ECE 517 Fall 2021 - E2152. Revision_planning_tool]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2170._Testing_-_Response_Maps#Description_about_project CSC/ECE 517 Fall 2021 - E2170. Testing - Response Maps]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza#Description_about_project CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper CSC/ECE 517 Fall 2021 - E2162. Further refactoring and improvement of review mapping helper]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2163._Refactor_waitlist_functionality CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2165._Fix_teammate-review_view CSC/ECE 517 Fall 2021 - E2165. Fix teammate review view ]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2155._Calibration_submissions_should_be_copied_along_with_calibration_assignments CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2148._Completion/Progress_View CSC/ECE 517 Fall 2021 - E2148. Completion/Progress view]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2158._Grading_audit_trail CSC/ECE 517 Fall 2021 - E2158. Grading audit trail ]
*[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2159._Expertiza_internationalization CSC/ECE 517 Fall 2021 - E2159. Expertiza internationalization]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2160._Implementing_and_testing_import_export_controllers#Description_about_project CSC/ECE 517 Fall 2021 - E2160. Implementing and testing import and export controllers]
*[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2161._Merge_code_for_role_based_reviewing_with_code_for_topic_specific_rubrics CSC/ECE 517 Fall 2021 - E2161. Merge code for role based reviewing with code for topic specific rubrics]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2164._Heatgrid_fixes_and_improvements#Description_about_project CSC/ECE 517 Fall 2021 - E2164. Heatgrid fixes and improvements]
* [[CSC/ECE 517 Fall 2021 - E2168. Testing - Reputations]]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2126._Testing_-_Team_Related_Files#Description_about_project CSC/ECE 517 Fall 2021 - E2126. Testing - Team Related Files]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2156._Issues_related_to_meta-reviewing#Description_about_project CSC/ECE 517 Fall 2021 - E2156. Issues related to meta-reviewing]
* [[CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging]]
* [[CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations]]
* [[E2157. Fix issues related to deadlines and late policies]]

CSC/ECE 517 Fall 2021