github_api.module

<?php

/**
 * @file
 * GitHub API module functions.
 */

/**
 * Implements hook_menu().
 */
function github_api_menu() {
  $items = array();

  $items['admin/config/development/github_api'] = array(
    'title' => 'GitHub API',
    'description' => 'Configure the GitHub API.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('github_api_settings'),
    'access arguments' => array('administer github api'),
    'file' => 'includes/github_api.admin.inc',
  );

  return $items;
}

/**
 * Implements hook_permission().
 */
function github_api_permission() {
  return array(
    'administer github api' => array(
      'title' => t('Administer GitHub API'),
      'description' => t('Configure the GitHub API module settings.'),
    ),
  );
}

/**
 * Implements hook_flush_caches().
 */
function github_api_flush_caches() {
  return array('cache_github_api');
}

/**
 * Instantiates a GitHub client object.
 *
 * @param bool $auth
 *   If TRUE the client will use authenticated calls.
 *
 * @return GithubClient
 *   The instantiated object.
 */
function github_api_client($auth = TRUE) {
  composer_manager_register_autoloader();

  $cache_obj = NULL;
  if (variable_get('github_api_use_cache', TRUE)) {
    $cache_obj = new \Github\HttpClient\CachedHttpClient();
    $cache_obj->setCache(new DrupalGithubApiHttpClientCacheDrupalNativeCache());
  }

  $client = new Github\Client($cache_obj);

  if ($auth) {
    $token = variable_get('github_api_token');
    $user = variable_get('github_api_username');
    if ($token) {
      $client->authenticate($user, $token, GitHub\Client::AUTH_HTTP_PASSWORD);
    }
    else {
      $client->authenticate($user, variable_get('github_api_password'), GitHub\Client::AUTH_HTTP_TOKEN);
    }
  }

  return $client;
}

/**
 * Request a GitHub API oAuth token.
 *
 * @param string $username
 *   The GitHub username to use for the request.
 * @param string $password
 *   The password for the GitHub user.
 * @param string $note
 *   A note to annotate the token in GitHub.
 *
 * @return string
 *   The oAuth token.
 */
function github_api_get_token($username, $password, $note = '') {
  composer_manager_register_autoloader();

  $client = new Github\Client();
  $client->authenticate($username, $password, GitHub\Client::AUTH_HTTP_PASSWORD);
  if (!$note) {
    $note = variable_get('site_name');
  }

  $params = array(
    'note' => $note,
    'note_url' => $GLOBALS['base_url'],
    'scopes' => array('user', 'repo'),
  );

  $response = $client->api('authorizations')->create($params);
  if (!empty($response['token'])) {
    return $response['token'];
  }
}

/**
 * Fetches a diff between 2 commits or branches.
 *
 * @param string $username
 *   The GitHub username of the repo owner.
 * @param string $repository
 *   The name of the repository.
 * @param string $base
 *   The name or hash to use as the base for the comparison.
 * @param string $head
 *   The name of the head.
 *
 * @return array
 *
 * @throws Exception
 */
function github_api_diff($username, $repository, $base, $head) {
  if (!$username) {
    $username = variable_get('github_api_default_owner');
  }

  $client = github_api_client();
  $response = $client->api('repo')->commits()->compare($username, $repository, $base, $head, 'application/vnd.github.v3.diff');
  return $response;
}


/**
 * Function to create a branch from a given head.
 *
 * @param string $username
 *   The GitHub username of the repo owner.
 * @param string $repository
 *   The name of the repository.
 * @param string $source
 *   The name of the head that the branch will be created from.
 * @param string $destination
 *   The name of the new branch head.
 *
 * @return array
 *
 * @throws Exception
 */
function github_api_create_branch($username = NULL, $repository = NULL, $source = NULL, $destination = NULL) {
  if (!$username) {
    $username = variable_get('github_api_default_owner');
  }

  $client = github_api_client();

  try {
    $client->api('current_user')->show();

    $references = $client->api('git')->references();

    $branch_head = $references->show($username, $repository, 'heads/' . $source);

    if (!($references instanceof Github\Api\GitData\References)) {
      throw new Exception('Create action failed.');
    }

    $params = array(
      'ref' => 'refs/heads/' . $destination,
      'sha' => $branch_head['object']['sha'],
    );

    return $references->create($username, $repository, $params);
  }
  catch (Exception $exception) {
    watchdog('github_api', '@exception', array('@exception' => $exception->getMessage()), WATCHDOG_ERROR);
  }
}

/**
 * Function to merge a head into a branch from a given repository.
 *
 * @param string $username
 *   The GitHub username of the repo owner.
 * @param string $repository
 *   The name of the repository.
 * @param string $source
 *   The head to merge. This can be a branch name or a commit SHA1.
 * @param string $destination
 *   The name of the base branch that the head will be merged into.
 * @param string $message
 *   Commit message to use for the merge commit. If omitted, a default message
 * will be used.
 *
 * @return array
 *
 * @throws Exception
 */
function github_api_merge($username = NULL, $repository = NULL, $source = NULL, $destination = NULL, $message = NULL) {
  if (!$username) {
    $username = variable_get('github_api_default_owner');
  }

  $client = github_api_client();

  try {
    $client->api('current_user')->show();

    $repo_object = $client->api('repo');
    $references = $client->api('git')->references();

    $branch_head = $references->show($username, $repository, 'heads/' . $source);

    if (!($references instanceof Github\Api\GitData\References) || !($repo_object instanceof Github\Api\Repo)) {
      throw new Exception('Merge action failed.');
    }

    return $repo_object->merge($username, $repository, $destination, $source, $message);
  }
  catch (Exception $exception) {
    watchdog('github_api', '@exception', array('@exception' => $exception->getMessage()), WATCHDOG_ERROR);
  }
}

/**
 * Function to merge a head into a branch from a given repository.
 *
 * @param string $username
 *   The GitHub username of the repo owner.
 * @param string $repository
 *   The name of the repository.
 * @param string $source
 *   The base head to merge or create a new branch. This can be a branch name or
 * a commit SHA1.
 * @param string $destination
 *   The name of the new branch or the branch that will be merged into.
 * @param string $message
 *   Commit message to use for the merge commit. If omitted, a default message
 * will be used.
 *
 * @return array
 *
 * @throws Exception
 */
function github_api_create_or_merge_branch($username = NULL, $repository = NULL, $source = NULL, $destination = NULL, $message = NULL) {
  if (!$username) {
    $username = variable_get('github_api_default_owner');
  }

  $client = github_api_client();

  try {
    $client->api('current_user')->show();

    $references = $client->api('git')->references();

    if (!($references instanceof Github\Api\GitData\References)) {
      throw new Exception('Create or merge action failed.');
    }

    // Throws not found exception
    $branch_source = $references->show($username, $repository, 'heads/' . $source);
    try {
      $branch_dest = $references->show($username, $repository, 'heads/' . $destination);
    }
    catch (Exception $exception) {
      $params = array(
        'ref' => 'refs/heads/' . $destination,
        'sha' => $branch_source['object']['sha'],
      );

      return $references->create($username, $repository, $params);
    }
    // Finally
    $repo_object = $client->api('repo');
    if (!($repo_object instanceof Github\Api\Repo)) {
      throw new Exception('Merge action failed.');
    }

    return $repo_object->merge($username, $repository, $destination, $source, $message);
  }
  catch (Exception $exception) {
    watchdog('github_api', '@exception', array('@exception' => $exception->getMessage()), WATCHDOG_ERROR);
  }
}

/**
 * Rule action to delete a branch.
 *
 * @param string $username
 *   The GitHub username of the repo owner.
 *
 * @param string $repository
 *   The name of the repository.
 *
 * @param string $source_branch
 *   The name of the branch to be deleted.
 *
 * @throws Exception
 */
function github_api_delete_branch($username = NULL, $repository = NULL, $source_branch = NULL) {
  if (!$username) {
    $username = variable_get('github_api_default_owner');
  }

  $client = github_api_client();

  try {
    $client->api('current_user')->show();
    $references = $client->api('git')->references();

    if (!($references instanceof Github\Api\GitData\References)) {
      throw new Exception('Create action failed.');
    }

    return $references->remove($username, $repository, 'heads/' . $source_branch);
  }
  catch (Exception $exception) {
    watchdog('github_api', '@exception', array('@exception' => $exception->getMessage()), WATCHDOG_ERROR);
  }
}