micc83 / GitHub-API-3-Client-for-WordPress

A simple class to query GitHub API v3.0 from WordPress

GitHub API 3 Client for WordPress

A simple class to query GitHub API v3.0 from WordPress

Documentation

As first go to https://github.com/settings/applications, create an application and get both Client ID and Client Secret. After that just include class-wp-github-client.php in your plugin or theme folder. That's it, check the following example, to understand how Wp_Github_Client works.

Example

// Include the client
require_once( 'class-wp-github-client.php' );

// Configure the client, at first run you'll be asked for permission
$github_client = new Wp_Github_Client( array(
    'app_name'      =>  'My application name',
    'client_id'     =>  'client_id',
    'client_secret' =>  'client_secret',
    'scope'         =>  'gist'
) );

// Create a new gists
$github_client->post( '/gists', array(
    'description'   =>  'the description for this gist',
    'public'        =>  true,
    'files'         =>  array(
    'file1.txt'     =>  array(
        'content'   =>  'String file contents'
        )
    )
) );

// Get starred gists of the current user
var_dump( $github_client->get( '/gists/starred' ) );

// Delete a gist by ID
$github_client->delete( '/gists/5875745' );

// Update an existing gist
$github_client->patch( '/gists/5875558', array(
    'description' => 'the description for this gist changed'
) );

// Star a gist
$github_client->put( '/gists/5875706/star' );

// Get all the gist of the current user after a given date
$datetime = new DateTime('2012-07-26 23:21:46');

var_dump( $github_client->get( '/gists', array(
    'since' => $datetime->format(DateTime::ISO8601)
) ) ); 

For a full list of GitHub API 3 resources check here: http://developer.github.com/v3/

Support and contacts

If you need support you can find me on twitter or comment on the dedicated page on my website.