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

Jump to bottom

Retrieve mandatory email address from Github #129

Closed
wants to merge 2 commits into from
Closed

Retrieve mandatory email address from Github #129

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f70ab71
Retrieve mandatory email address from Github
Zoly Jul 22, 2024
9274810
Merge pull request #3 from Zoly/Retrieve-mandatory-email-address-from…
Zoly Jul 22, 2024
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
54 changes: 49 additions & 5 deletions src/Libraries/GithubOAuth.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@

class GithubOAuth extends AbstractOAuth
{
public static string $API_CODE_URL = 'https://github.com/login/oauth/authorize';
public static string $API_TOKEN_URL = 'https://github.com/login/oauth/access_token';
public static string $API_USER_INFO_URL = 'https://api.github.com/user';
private static string $APPLICATION_NAME = 'ShieldOAuth';
public static string $API_CODE_URL = 'https://github.com/login/oauth/authorize';
public static string $API_TOKEN_URL = 'https://github.com/login/oauth/access_token';
public static string $API_USER_INFO_URL = 'https://api.github.com/user'; // The /user API returns the user's publicly visible data or null for those that are not set
public static string $API_USER_EMAILS_URL = 'https://api.github.com/user/emails'; // The /user/emails API returns all email addresses for the user, including those that are not set public
private static string $APPLICATION_NAME = 'ShieldOAuth';

protected string $token;
protected CURLRequest $client;
protected ShieldOAuthConfig $config;
Expand Down Expand Up @@ -89,7 +91,49 @@ protected function fetchUserInfoWithToken(): object
exit($e->getMessage());
}

return json_decode($response->getBody());
$userInfo = json_decode($response->getBody(), false);

// the email address is mandatory
if (empty($userInfo->email)) {
$userInfo->email = $this->getUserPrimaryEmail($this->fetchUserEmailsWithToken());
}

return $userInfo;
}

/**
* @return list<object>
*/
protected function fetchUserEmailsWithToken(): array
{
// send request to API URL
try {
$response = $this->client->request('GET', self::$API_USER_EMAILS_URL, [
'headers' => [
'User-Agent' => self::$APPLICATION_NAME . '/1.0',
'Accept' => 'application/vnd.github+json',
'Authorization' => 'Bearer ' . $this->getToken(),
],
'http_errors' => false,
]);
} catch (Exception $e) {
exit($e->getMessage());
}

return json_decode($response->getBody(), false);
}

/**
* @param list<object> $emailAddresses
*/
protected function getUserPrimaryEmail(array $emailAddresses): string
{
// try to get the one marked as primary, otherwise grab the first one
if (! empty($emailAddresses)) {
$primaryEmail = array_filter($emailAddresses, static fn ($eMail) => $eMail->primary);
$userEmail = ! empty($primaryEmail) ? array_shift($primaryEmail)->email : array_shift($emailAddresses)->email;
}
return $userEmail ?? '';
}

protected function setColumnsName(string $nameOfProcess, $userInfo): array
Expand Down
Loading