org.eclipse.che.plugin.github.ide.GitHubServiceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of che-plugin-github-ide Show documentation
There is a newer version: 7.0.0-rc-3.0
Show newest version
/*
 * Copyright (c) 2012-2018 Red Hat, Inc.
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Red Hat, Inc. - initial API and implementation
 */
package org.eclipse.che.plugin.github.ide;

import java.util.List;
import javax.validation.constraints.NotNull;
import org.eclipse.che.api.promises.client.Promise;
import org.eclipse.che.ide.rest.AsyncRequestCallback;
import org.eclipse.che.plugin.github.shared.Collaborators;
import org.eclipse.che.plugin.github.shared.GitHubIssueComment;
import org.eclipse.che.plugin.github.shared.GitHubIssueCommentInput;
import org.eclipse.che.plugin.github.shared.GitHubPullRequest;
import org.eclipse.che.plugin.github.shared.GitHubPullRequestCreationInput;
import org.eclipse.che.plugin.github.shared.GitHubPullRequestList;
import org.eclipse.che.plugin.github.shared.GitHubRepository;
import org.eclipse.che.plugin.github.shared.GitHubRepositoryList;
import org.eclipse.che.plugin.github.shared.GitHubUser;

/**
 * Client service for Samples.
 *
 * @author Oksana Vereshchaka
 * @author Kevin Pollet
 */
public interface GitHubServiceClient {

  /**
   * Get given repository information.
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository.
   * @param repository the repository name.
   */
  Promise getRepository(String oauthToken, String user, String repository);

  /**
   * Get list of available public and private repositories of the authorized user.
   *
   * @param oauthToken Github OAuth authorization token
   */
  Promise> getRepositoriesList(String oauthToken);

  /**
   * Get list of forks for given repository
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository.
   * @param repository the repository name.
   */
  Promise getForks(
      @NotNull String oauthToken, String user, String repository);

  /**
   * Fork the given repository for the authorized user.
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository to fork.
   * @param repository the repository name.
   */
  Promise fork(@NotNull String oauthToken, String user, String repository);

  /**
   * Add a comment to the issue on the given repository.
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository.
   * @param repository the repository name.
   * @param issue the issue number.
   * @param input the comment.
   * @param callback callback called when operation is done.
   */
  void commentIssue(
      @NotNull String oauthToken,
      @NotNull String user,
      @NotNull String repository,
      @NotNull String issue,
      @NotNull GitHubIssueCommentInput input,
      @NotNull AsyncRequestCallback callback);

  /**
   * Get pull requests for given repository.
   *
   * @param oauthToken Github OAuth authorization token
   * @param owner the repository owner.
   * @param repository the repository name.
   */
  Promise getPullRequests(
      @NotNull String oauthToken, @NotNull String owner, @NotNull String repository);

  /**
   * Get pull requests for given repository.
   *
   * @param oauthToken Github OAuth authorization token
   * @param owner the repository owner.
   * @param repository the repository name.
   * @param head user and branch name in the format of user:ref-name
   */
  Promise getPullRequests(
      @NotNull String oauthToken, String owner, String repository, String head);

  /**
   * Get a pull request by id for a given repository.
   *
   * @param oauthToken Github OAuth authorization token
   * @param owner the owner of the target repository
   * @param repository the target repository
   * @param pullRequestId the Id of the pull request
   * @param callback the callback with either the pull request as argument or null if it doesn't
   *     exist
   */
  void getPullRequest(
      @NotNull String oauthToken,
      @NotNull String owner,
      @NotNull String repository,
      @NotNull String pullRequestId,
      @NotNull AsyncRequestCallback callback);

  /**
   * Create a pull request on origin repository
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository.
   * @param repository the repository name.
   * @param input the pull request information.
   */
  Promise createPullRequest(
      @NotNull String oauthToken,
      @NotNull String user,
      @NotNull String repository,
      @NotNull GitHubPullRequestCreationInput input);

  /**
   * Get the list of available public repositories for a GitHub user.
   *
   * @param oauthToken Github OAuth authorization token
   * @param userName the name of GitHub User
   * @param callback callback called when operation is done.
   */
  void getRepositoriesByUser(
      @NotNull String oauthToken,
      String userName,
      @NotNull AsyncRequestCallback callback);

  /**
   * Get the list of available repositories by GitHub organization.
   *
   * @param oauthToken Github OAuth authorization token
   * @param organization the name of GitHub organization.
   * @param callback callback called when operation is done.
   */
  void getRepositoriesByOrganization(
      @NotNull String oauthToken,
      String organization,
      @NotNull AsyncRequestCallback callback);

  /**
   * Get list of available public repositories for GitHub account.
   *
   * @param oauthToken Github OAuth authorization token
   * @param account the GitHub account.
   * @param callback callback called when operation is done.
   */
  void getRepositoriesByAccount(
      @NotNull String oauthToken,
      String account,
      @NotNull AsyncRequestCallback callback);

  /**
   * Get list of collaborators of GitHub repository. For detail see GitHub REST API
   * http://developer.github.com/v3/repos/collaborators/.
   *
   * @param oauthToken Github OAuth authorization token
   * @param user the owner of the repository.
   * @param repository the repository name.
   * @param callback callback called when operation is done.
   */
  void getCollaborators(
      @NotNull String oauthToken,
      @NotNull String user,
      @NotNull String repository,
      @NotNull AsyncRequestCallback callback);

  /**
   * Get the list of the organizations, where authorized user is a member.
   *
   * @param oauthToken Github OAuth authorization token
   */
  Promise> getOrganizations(@NotNull String oauthToken);

  /**
   * Get authorized user information.
   *
   * @param oauthToken Github OAuth authorization token
   */
  Promise getUserInfo(@NotNull String oauthToken);

  /**
   * Generate and upload new public key if not exist on github.com.
   *
   * @param oauthToken Github OAuth authorization token
   * @param callback callback called when operation is done.
   */
  void updatePublicKey(@NotNull String oauthToken, @NotNull AsyncRequestCallback callback);

  /**
   * Updates github pull request
   *
   * @param oauthToken Github OAuth authorization token
   * @param user repository owner
   * @param repository name of repository
   * @param pullRequestId pull request identifier
   * @param pullRequest update body
   * @return updated pull request
   */
  Promise updatePullRequest(
      @NotNull String oauthToken,
      String user,
      String repository,
      String pullRequestId,
      GitHubPullRequest pullRequest);
}