Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better handle GitHub bad token #15

Merged
merged 2 commits into from
May 3, 2020
Merged

Better handle GitHub bad token #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7973935
Transform a NRE in an UnauthorizedAccessException with clearer message
pmiossec Apr 27, 2020
7a99961
Client: Cleaning/refactoring
pmiossec Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 59 additions & 38 deletions Git.hub/Client.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Threading.Tasks;
using RestSharp;
using RestSharp.Authenticators;
Expand All @@ -12,7 +13,7 @@ namespace Git.hub
/// </summary>
public class Client
{
private RestClient client;
private readonly RestClient _client;

/// <summary>
/// Creates a new client instance for github.com
Expand All @@ -25,8 +26,7 @@ public Client() : this("https://api.github.com") { }
/// <param name="apiEndpoint">the host to connect to, e.g. 'https://api.github.com'</param>
public Client(string apiEndpoint)
{
client = new RestClient(apiEndpoint);
client.UserAgent = "mabako/Git.hub";
_client = new RestClient(apiEndpoint) { UserAgent = "mabako/Git.hub" };
}

/// <summary>
Expand All @@ -36,10 +36,8 @@ public Client(string apiEndpoint)
/// <param name="password">password</param>
public void setCredentials(string user, string password)
{
if (user != null && password != null)
client.Authenticator = new HttpBasicAuthenticator(user, password);
else
client.Authenticator = null;
_client.Authenticator =
user != null && password != null ? new HttpBasicAuthenticator(user, password) : null;
}

/// <summary>
Expand All @@ -48,10 +46,7 @@ public void setCredentials(string user, string password)
/// <param name="token">oauth2-token</param>
public void setOAuth2Token(string token)
{
if (token != null)
client.Authenticator = new OAuth2AuthHelper(token);
else
client.Authenticator = null;
_client.Authenticator = token != null ? new OAuth2AuthHelper(token) : null;
}

/// <summary>
Expand All @@ -60,16 +55,16 @@ public void setOAuth2Token(string token)
/// <returns>list of repositories</returns>
public IList<Repository> getRepositories()
{
if (client.Authenticator == null)
if (_client.Authenticator == null)
throw new ArgumentException("no authentication details");

var request = new RestRequest("/user/repos?type=all");

var repos = client.GetList<Repository>(request);
var repos = _client.GetList<Repository>(request);
if (repos == null)
throw new Exception("Bad Credentials");

repos.ForEach(r => r._client = client);
repos.ForEach(r => r._client = _client);
return repos;
}

Expand All @@ -80,14 +75,14 @@ public IList<Repository> getRepositories()
/// <returns>list of repositories</returns>
public IList<Repository> getRepositories(string username)
{
var request = new RestRequest("/users/{name}/repos");
request.AddUrlSegment("name", username);
var request = new RestRequest("/users/{name}/repos")
.AddUrlSegment("name", username);

var list = client.GetList<Repository>(request);
var list = _client.GetList<Repository>(request);
if (list == null)
throw new InvalidOperationException("User does not exist.");

list.ForEach(r => r._client = client);
list.ForEach(r => r._client = _client);
return list;
}

Expand All @@ -99,15 +94,15 @@ public IList<Repository> getRepositories(string username)
/// <returns>fetched repository</returns>
public Repository getRepository(string username, string repositoryName)
{
var request = new RestRequest("/repos/{name}/{repo}");
request.AddUrlSegment("name", username);
request.AddUrlSegment("repo", repositoryName);
var request = new RestRequest("/repos/{name}/{repo}")
.AddUrlSegment("name", username)
.AddUrlSegment("repo", repositoryName);

var repo = client.Get<Repository>(request).Data;
var repo = DoRequest<Repository>(request);
if (repo == null)
return null;

repo._client = client;
repo._client = _client;
repo.Detailed = true;
return repo;
}
Expand All @@ -119,13 +114,13 @@ public Repository getRepository(string username, string repositoryName)
/// <returns></returns>
public IList<Repository> getOrganizationRepositories(string organization)
{
var request = new RestRequest("/orgs/{org}/repos");
request.AddUrlSegment("org", organization);
var request = new RestRequest("/orgs/{org}/repos")
.AddUrlSegment("org", organization);

var list = client.GetList<Repository>(request);
var list = _client.GetList<Repository>(request);

Organization org = new Organization { Login = organization };
list.ForEach(r => { r._client = client; r.Organization = org; });
var org = new Organization { Login = organization };
list.ForEach(r => { r._client = _client; r.Organization = org; });
return list;
}

Expand All @@ -137,16 +132,14 @@ public IList<Repository> getOrganizationRepositories(string organization)
/// <returns>current user</returns>
public User getCurrentUser()
{
if (client.Authenticator == null)
if (_client.Authenticator == null)
throw new ArgumentException("no authentication details");

var request = new RestRequest("/user");

var user = client.Get<User>(request);
if (user.Data == null)
throw new Exception("Bad Credentials");
var user = DoRequest<User>(request, false);

return user.Data;
return user;
}

public async Task<User> GetUserAsync(string userName)
Expand All @@ -158,7 +151,7 @@ public async Task<User> GetUserAsync(string userName)

var request = new RestRequest($"/users/{userName}");

var user = await client.ExecuteGetTaskAsync<User>(request);
var user = await _client.ExecuteGetTaskAsync<User>(request);
return user.Data;
}

Expand All @@ -172,11 +165,39 @@ public List<Repository> searchRepositories(string query)
var request = new RestRequest("/legacy/repos/search/{query}");
request.AddUrlSegment("query", query);

var repos = client.Get<APIv2.RepositoryListV2>(request).Data;
if (repos == null || repos.Repositories == null)
throw new Exception(string.Format("Could not search for {0}", query));
var repos = DoRequest<APIv2.RepositoryListV2>(request);
if (repos?.Repositories == null)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add {} to conform with GE style (but will not be the same as other files in this submodule)

{
throw new Exception($"Could not search for {query}");
}

return repos.Repositories.Select(r => r.ToV3(_client)).ToList();
}

private T DoRequest<T>(IRestRequest request, bool throwOnError = true) where T : new()
{
var response = _client.Get<T>(request);
if (response.IsSuccessful)
{
return response.Data;
}

if (!throwOnError)
{
return default;
}

if (response.StatusCode == HttpStatusCode.Unauthorized)
{
if (_client.Authenticator == null)
{
throw new UnauthorizedAccessException("Please configure a GitHub authentication token.");
}

throw new UnauthorizedAccessException("The GitHub authentication token provided is not valid.");
}

return repos.Repositories.Select(r => r.ToV3(client)).ToList();
throw new Exception(response.StatusDescription);
}
}
}