This project aims to provide a Java wrapper for Github API.
Java
Switch branches/tags
Nothing to show
Pull request Compare This branch is 8 commits ahead, 11 commits behind nabeelmukhtar:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples/src/java/com/github/api/v2/services/example
lib
src
.gitignore
README.md
build.xml
ivy.xml
ivysettings.xml
pom.xml

README.md

GitHub Java SDK

Description

This project provides a Java wrapper for the GitHub API v.2.0.

License

This project is open source with Apache License, Version 2.0.

Requirements

This project has only one dependency on Gson which can be downloaded here.

The library is supported on AppEngine and Android platforms as well.

Key Features

The library implements all the methods of GitHub API v.2.0. Additionally it has methods for reading various atom feeds from the GitHub site. It also has a method for downloading the source as a zip archive. The library is divided into various services each implementing a specific portion of the API.

  • UserService: Provides methods of the User API.
  • IssueService: Provides methods of the Issues API.
  • GistService: Provides methods of the Gist API.
  • NetworkService: Provides methods of the Network API.
  • RepositoryService: Provides methods of the Repository API.
  • CommitService: Provides methods of the Commit API.
  • ObjectService: Provides methods of the Object API.
  • OrganizationService: Provides methods of the Organization API.
  • PullRequestService: Provides methods of the Pull Request API.
  • JobService: Provides methods of the Job API.
  • FeedService: Provides methods for reading the Atom/RSS feeds.
  • OAuthService: Provides methods for OAuth 2.0 authentication and authorization.

Usage

Most of the methods of the API can be invoked without using any authentication. However some need the user to be authenticated.

Typical

The typical usage includes the creation of the appropriate servive using a factory and invoking the methods of that service. GitHubServiceFactory factory = GitHubServiceFactory.newInstance(); RepositoryService service = factory.createRepositoryService(); List repositories = service.searchRepositories("hadoop"); for (Repository repository : repositories) { printResult(repository); } Repository repository = service.getRepository("nabeelmukhtar", "github-java-sdk"); printResult(repository);

Authenticated

Authenticated usage is not very different from typical usage. Before calling any service method that requires authentication, you have to set the credentials on the service instance. Subsequent method calls from the same instance will not need further authentication. GitHubServiceFactory factory = GitHubServiceFactory.newInstance(); RepositoryService service = factory.createRepositoryService(); service.setAuthentication(new LoginTokenAuthentication("nabeelmukhtar", "xxx-xxx-xxx")); service.createRepository("new-repo", "Creating new repository.", "http://www.example.com", Repository.Visibility.PUBLIC);

Executing Unit Tests

If you'd like to build the library and run the tests, you'll need to first modify some of the settings in src/test/resources/com/github/api/v2/services/constant/TestConstants.properties.

  • com.github.api.v2.services.apiKey: Your API token as shown under api token on https://github.com/account/admin
  • com.github.api.v2.services.testUserName: Your GitHub username

The first couple of times you run the tests you'll receive lots of errors. As the tests have run more times and created more artifacts in your sample respository, the number of errors will decrease. At some point you should reach the state where all test failures are the result of features not being implemented.

More Information

For more information see the following wiki pages.