Misterzym
/
wp-github-oembed
mirror of https://github.com/misterzym/wp-github-oembed.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge branch 'Zebouski-master'

widget
Lee Willis 6 years ago
parent
f66bd4a206 3f2b35a4b2
commit
36240a6a21
6 changed files with 180 additions and 125 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      github-api.php
  2. 209
      github-embed.php
  3. 11
      templates/author.php
  4. 27
      templates/repository.php
  5. 25
      templates/repository_contributors.php
  6. 29
      templates/repository_milestone_summary.php

4
github-api.php
Unescape View File

@ -1,7 +1,5 @@
<?php
// 0 - none.
define( 'GEDEBUG_NONE', 0 );
@ -57,10 +55,8 @@ class github_api {
* provide the credentials.
*/
public function set_credentials() {
$this->client_id = apply_filters( 'github-embed-client-id', $this->client_id );
$this->client_secret = apply_filters( 'github-embed-client-secret', $this->client_secret );
}

209
github-embed.php
Unescape View File

@ -36,13 +36,13 @@ Author URI: http://www.leewillis.co.uk/
* class to retrieve the information from the GitHub API.
* @uses class github_api
*/
class github_embed {
private $api;
/**
* Constructor. Registers hooks and filters
*
* @param class $api An instance of the github_api classs
*/
public function __construct( $api ) {
@ -73,7 +73,7 @@ class github_embed {
*/
function cron() {
global $wpdb, $table_prefix;
$sql = "DELETE
$sql = "DELETE
FROM {$table_prefix}postmeta
WHERE meta_key LIKE '_oembed_%'";
$results = $wpdb->get_results( $sql );
@ -92,12 +92,14 @@ class github_embed {
* Register the oEmbed provider, and point it at a local endpoint since github
* doesn't directly support oEmbed yet. Our local endpoint will use the github
* API to fulfil the request.
* @param array $providers The current list of providers
*
* @param array $providers The current list of providers
*
* @return array The list, with our new provider added
*/
public function register_oembed_handler() {
$oembed_url = home_url();
$key = $this->get_key();
$key = $this->get_key();
$oembed_url = add_query_arg( array( 'github_oembed' => $key ), $oembed_url );
wp_oembed_add_provider( '#https?://github.com/.*#i', $oembed_url, true );
}
@ -113,6 +115,7 @@ class github_embed {
$key = md5( time() . rand( 0, 65535 ) );
add_option( 'github_oembed_key', $key, '', 'yes' );
}
return $key;
}
@ -138,7 +141,7 @@ class github_embed {
}
// Check we have the required information
$url = isset( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
$url = isset( $_REQUEST['url'] ) ? $_REQUEST['url'] : null;
$format = isset( $_REQUEST['format'] ) ? $_REQUEST['format'] : null;
if ( ! empty( $format ) && 'json' !== $format ) {
@ -175,42 +178,45 @@ class github_embed {
}
}
/**
* Capture then return output of template, provided theme or fallback to plugin default.
*
* @param string $template The template name to process.
* @param string $data Array, object, or variable that the template needs.
*
* @return string
*/
private function process_template( $template, $data ) {
ob_start();
if ( ! locate_template( 'wp-github-oembed/' . $template, true ) ) {
require_once 'templates/' . $template;
}
return ob_get_clean();
}
/**
* Retrieve a list of contributors for a project
* @param string $owner The owner of the repository
* @param string $repository The repository name
*
* @param string $owner The owner of the repository
* @param string $repository The repository name
*/
private function oembed_github_repo_contributors( $owner, $repository ) {
$repo = $this->api->get_repo( $owner, $repository );
$contributors = $this->api->get_repo_contributors( $owner, $repository );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$data = [];
$data['repo'] = $this->api->get_repo( $owner, $repository );
$data['contributors'] = $this->api->get_repo_contributors( $owner, $repository );
$data['gravatar_size'] = apply_filters( 'github_oembed_gravatar_size', 64 );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$response->version = '1.0';
$response->title = $repo->description;
$gravatar_size = apply_filters( 'github_oembed_gravatar_size', 64 );
// @TODO This should all be templated
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-repo-contributors ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank">';
$response->html .= '<strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<span class="github-heading">Contributors: </span>';
$response->html .= '<ul class="github-repo-contributors">';
foreach ( $contributors as $contributor ) {
$response->html .= '<li class="github-repo-contributor">';
$response->html .= '<img class="github-repo-contributor-avatar" src="';
$response->html .= esc_url( add_query_arg( array( 's' => $gravatar_size ), $contributor->author->avatar_url ) );
$response->html .= '" alt="Picture of ' . esc_attr( $contributor->author->login ) . '">';
$response->html .= '<span class="github-repo-contributor-login">';
$response->html .= '<a href="https://github.com/' . esc_attr( $contributor->author->login ) . '">' . esc_attr( $contributor->author->login ) . '</a></span>';
}
$response->html .= '</ul>';
$response->html .= '<div style="clear: both;"></div>';
$response->html .= '</div>';
$response->title = $data['repo']->description;
$response->html = $this->process_template(
'repository_contributors.php', $data );
header( 'Content-Type: application/json' );
echo json_encode( $response );
die();
@ -221,37 +227,19 @@ class github_embed {
* output it as an oembed response
*/
private function oembed_github_repo_milestone_summary( $owner, $repository, $milestone ) {
$repo = $this->api->get_repo( $owner, $repository );
$summary = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$data = [];
$data['repo'] = $this->api->get_repo( $owner, $repository );
$data['summary'] = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$response->version = '1.0';
$response->title = $repo->description;
// @TODO This should all be templated
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-milestone-summary ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<span class="github-heading">Milestone: </span>';
$response->html .= '<span class="github-milestone-title">' . esc_html( $summary->title ) . '</span><br>';
$response->html .= '<span class="github-heading">Issues: </span>';
$response->html .= '<span class="github-milestone-issues">';
$response->html .= esc_html( number_format_i18n( $summary->open_issues ) ) . ' open, ';
$response->html .= esc_html( number_format_i18n( $summary->closed_issues ) ) . ' closed.</span><br>';
if ( ! empty( $summary->due_on ) ) {
$response->html .= '<span class="github-heading">Due: </span>';
$due_date = date_format( date_create( $summary->due_on ), 'jS F Y' );
$response->html .= '<span class="github-milestone-due-date">' . esc_html( $due_date ) . '</span><br>';
}
$response->html .= '<p class="github-milestone-description">' . nl2br( esc_html( $summary->description ) ) . '</p><br>';
$response->html .= '</div>';
$response->title = $data['repo']->description;
$response->html = $this->process_template(
'repository_milestone_summary.php', $data );
header( 'Content-Type: application/json' );
echo json_encode( $response );
@ -263,44 +251,25 @@ class github_embed {
* Retrieve the information from github for a repo, and
* output it as an oembed response
*/
private function oembed_github_repo ( $owner, $repository ) {
$repo = $this->api->get_repo( $owner, $repository );
$commits =$this->api->get_repo_commits( $owner, $repository );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
private function oembed_github_repo( $owner, $repository ) {
$data = [
'owner_slug' => $owner,
'repo_slug' => $repository,
];
$data['repo'] = $this->api->get_repo( $owner, $repository );
$data['commits'] = $this->api->get_repo_commits( $owner, $repository );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$response->version = '1.0';
$response->title = $repo->description;
// @TODO This should all be templated
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
$response->html = '<div class="github-embed github-embed-repository ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url ) . '" target="_blank">' . esc_html( $repo->html_url ) . '</a><br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/network' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->forks_count ) ) . '</a> forks.<br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/stargazers' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->stargazers_count ) ) . '</a> stars.<br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/issues' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->open_issues_count ) ) . '</a> open issues.<br/>';
if ( count( $commits ) ) {
$cnt = 0;
$response->html .= 'Recent commits:';
$response->html .= '<ul class="github_commits">';
foreach ( $commits as $commit ) {
if ( $cnt > 4 ) {
break;
}
$response->html .= '<li class="github_commit">';
$response->html .= '<a href="https://github.com/' . $owner . '/' . $repository . '/commit/' . esc_attr( $commit->sha ) . '" target="_blank">' . esc_html( $commit->commit->message ) . '</a>, ';
$response->html .= esc_html( $commit->commit->committer->name );
$response->html .= '</li>';
$cnt++;
}
$response->html .= '</ul>';
}
$response->html .= '</p>';
$response->html .= '</div>';
$response->title = $data['repo']->description;
$response->html = $this->process_template(
'repository.php', $data );
header( 'Content-Type: application/json' );
echo json_encode( $response );
die();
@ -310,24 +279,22 @@ class github_embed {
* Retrieve the information from github for an author, and output
* it as an oembed response
*/
private function oembed_github_author ( $owner ) {
$owner_info = $this->api->get_user( $owner );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
private function oembed_github_author( $owner ) {
$data = [];
$data["owner"] = $owner;
$data["owner_info"] = $this->api->get_user( $owner );
$data["logo_class"] = apply_filters( 'wp_github_oembed_logo_class',
'github-logo-octocat' );
$response = new stdClass();
$response->type = 'rich';
$response->width = '10';
$response->height = '10';
$response->version = '1.0';
$response->title = $owner_info->name;
// @TODO This should all be templated
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-user ' . $logo_class . '">';
$response->html .= '<p><a href="https://github.com/' . esc_attr( $owner ) . '" target="_blank"><strong>' . esc_html( $owner ) . '</strong></a><br/>';
$response->html .= esc_html( number_format_i18n( $owner_info->public_repos ) ) . ' repositories, ';
$response->html .= esc_html( number_format_i18n( $owner_info->followers ) ) . ' followers.</p>';
$response->html .= '</div>';
$response->title = $data['owner_info']->name;
$response->html = $this->process_template(
'author.php', $data );
header( 'Content-Type: application/json' );
echo json_encode( $response );
die();
@ -336,5 +303,5 @@ class github_embed {
require_once( 'github-api.php' );
$github_api = new github_api();
$github_api = new github_api();
$github_embed = new github_embed( $github_api );

11
templates/author.php
Unescape View File

@ -0,0 +1,11 @@
<div class="github-embed github-embed-user <?php echo $data['logo_class'] ?>">
<p>
<a href="https://github.com/<?php echo esc_attr( $data['owner'] ) ?>" target="_blank">
<strong>
<?php echo esc_html( $data['owner'] ) ?>
</strong>
</a>
<br>
<?php echo esc_html( number_format_i18n( $data['owner_info']->public_repos ) ) ?> repositories, <?php echo esc_html( number_format_i18n( $data['owner_info']->followers ) ) ?> followers.
</p>
</div>

27
templates/repository.php
Unescape View File

@ -0,0 +1,27 @@
<div class="github-embed github-embed-repository <?php echo $data['logo_class'] ?>">
<p>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?php echo esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>" target="_blank"><?php echo esc_html( $data['repo']->html_url ) ?></a><br>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>/network" target="_blank"><?php echo esc_html( number_format_i18n( $data['repo']->forks_count ) ) ?></a> forks.<br>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>/stargazers" target="_blank"><?php echo esc_html( number_format_i18n( $data['repo']->stargazers_count ) ) ?></a> stars.<br>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>/issues" target="_blank"><?php echo esc_html( number_format_i18n( $data['repo']->open_issues_count ) ) ?></a> open issues.<br>
Recent commits:
<ul class="github_commits">
<?php
$i = 0;
foreach ( $data['commits'] as $commit ) : ?>
<li class="github_commit">
<a href="https://github.com/<?php echo $data['owner_slug'] ?>/<?php echo $data['repo_slug'] ?>/commit/<?php echo esc_attr( $commit->sha ) ?>" target="_blank"><?php echo esc_html( $commit->commit->message ) ?></a>, <?php echo esc_html( $commit->commit->committer->name ); ?>
</li>
<?php
if (++$i == 5) break;
endforeach;
?>
</ul>
</p>
</div>

25
templates/repository_contributors.php
Unescape View File

@ -0,0 +1,25 @@
<div class="github-embed github-embed-repo-contributors <?php echo $data['logo_class'] ?>">
<p>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?php echo esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<span class="github-heading">Contributors: </span>
<ul class="github-repo-contributors">
<?php foreach ( $data['contributors'] as $contributor ) : ?>
<li class="github-repo-contributor">
<img class="github-repo-contributor-avatar"
src="<?php echo esc_url( add_query_arg( array( 's' => $data['gravatar_size'] ), $contributor->author->avatar_url ) ); ?>"
alt="Picture of <?php echo esc_attr( $contributor->author->login ) ?>">
<span class="github-repo-contributor-login">
<a href="https://github.com/<?php echo esc_attr( $contributor->author->login ) ?>">
<?php echo esc_attr( $contributor->author->login ) ?>
</a>
</span>
<?php endforeach; ?>
</ul>
<div style="clear: both;"></div>
</p>
</div>

29
templates/repository_milestone_summary.php
Unescape View File

@ -0,0 +1,29 @@
<div class="github-embed github-embed-milestone-summary <?php echo $data['logo_class'] ?>">
<p>
<a href="<?php echo esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?php echo esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<span class="github-heading">Milestone: </span>
<span class="github-milestone-title"><?php echo esc_html( $data['summary']->title ) ?></span>
<br>
<span class="github-heading">Issues: </span>
<span class="github-milestone-issues">
<?php echo esc_html( number_format_i18n( $data['summary']->open_issues ) ) ?> open, <?php echo esc_html( number_format_i18n( $data['summary']->closed_issues ) ) ?> closed.
</span>
<br>
<?php if ( ! empty( $data['summary']->due_on ) ) : ?>
<span class="github-heading">Due: </span>
<span class="github-milestone-due-date">
<?php echo esc_html( date_format( date_create( $data['summary']->due_on ), 'jS F Y' ) ) ?>
</span>
<br>
<?php endif ?>
<p class="github-milestone-description">
<?php echo nl2br( esc_html( $data['summary']->description ) ) ?>
</p>
<br>
</p>
</div>
Write Preview
Loading…
Cancel
Save