Skip to content

Commit 5d8907d

Browse files
henriquetrutahenriquetruta
committed
Initial Commit
0 parents  commit 5d8907d

File tree

212 files changed

+18976
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

212 files changed

+18976
-0
lines changed

‎.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Artifacts
2+
*.class
3+
4+
## Package Files
5+
*.jar
6+
*.war
7+
*.ear
8+
target
9+
10+
## IntelliJ
11+
.idea
12+
*.iml
13+
14+
## Logs
15+
*.log
16+
17+
## Temp
18+
*~
19+
.#*
20+
21+
dependency-reduced-pom.xml

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2+
![lifecycle: beta](https://img.shields.io/badge/lifecycle-beta-509bf5.svg)
3+
4+
# github-client
5+
6+
A small Java library for talking to Github/Github Enterprise and interacting with projects.
7+
8+
It supports authentication via simple access tokens, JWT endpoints and Github Apps (via DER private key).
9+
10+
It is also very light on GitHub, doing as few requests as necessary.
11+
12+
## Getting Started
13+
14+
Include the latest version of github-client into your project:
15+
16+
In Maven:
17+
```xml
18+
<dependency>
19+
<groupId>com.spotify</groupId>
20+
<artifactId>github-client</artifactId>
21+
<version>version</version>
22+
</dependency>
23+
```
24+
25+
Start talking to Github API.
26+
27+
```java
28+
final GitHubClient github = GithubClient.create(URI.create("https://github.com/api/v3/"));
29+
final IssueApi issueClient = github.createRepositoryClient("my-org", "my-repo").createIssueClient();
30+
issueClient.listComments(ISSUE_ID).get().forEach(comment -> log.info(comment.body()));
31+
```
32+
33+
## Authenticating
34+
35+
### Simple access token
36+
37+
```java
38+
final GitHubClient github = GithubClient.create(URI.create("https://github.com/api/v3/"));
39+
// Do the requests
40+
github.createRepositoryClient("my-org", "my-repo").getCommit("sha");
41+
```
42+
43+
### Private key
44+
45+
To authenticate as a Github App, you must provide a private key and the App ID, together with the API URL.
46+
47+
```java
48+
final GitHubClient github =
49+
GitHubClient.create(
50+
URI.create("https://github.com/api/v3/"),
51+
new File("/path-to-the/private-key.der"),
52+
APP_ID);
53+
```
54+
55+
Then, you can scope the client for a specific Installation ID, to do the operations at the installation level.
56+
The client will manage the generation of JWT tokens, as well as requesting and caching the installation tokens
57+
from GitHub.
58+
59+
```java
60+
final GitHubClient scoped = GitHubClient.scopeForInstallationId(github, INSTALLATION_ID);
61+
// Do the requests now using the scoped client.
62+
scoped.createRepositoryClient("my-org", "my-repo").getCommit("sha");
63+
```
64+
65+
It is also possible to provide the installation to the root client.
66+
67+
Refer to [Github App Authentication Guide](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/) for more information.
68+
69+
#### Making the private key readable for Java
70+
71+
Java does not natively support the PEM private keys that GitHub provides, without a third-party library. To convert it to the DER, java-friendly format, run:
72+
73+
```bash
74+
openssl pkcs8 -topk8 -inform PEM -outform DER -in <path-to-private-key.pem> -out <path-to-private_key.der> -nocrypt
75+
```
76+
77+
## Usage
78+
79+
This library attempts to mirror the structure of GitHub API endpoints. As an example, to get details of a Commit, there is
80+
the `GET /repos/:owner/:repo/commits` API call, under the `repos` API. Therefore, the `getCommit` method lives in the RepositoryClient.
81+
82+
```java
83+
final GitHubClient github = GithubClient.create(URI.create("https://github.com/api/v3/"));
84+
github.createRepositoryClient("my-org", "my-repo").getCommit("sha");
85+
```
86+
87+
Some APIs, such as Checks API are nested in the Repository API. Endpoints such as `POST /repos/:owner/:repo/check-runs` live in the ChecksClient:
88+
89+
```java
90+
final GitHubClient github =
91+
GitHubClient.create(
92+
URI.create("https://github.com/api/v3/"),
93+
new File("/path-to-the/private-key.der"),
94+
APP_ID);
95+
// Checks API need to be used by Github Apps
96+
GitHubClient.scopeForInstallationId(github, INSTALLATION_ID)
97+
.createRepositoryClient("my-org", "my-repo")
98+
.createChecksApiClient()
99+
.createCheckRun(CHECK_RUN_REQUEST);
100+
```
101+
102+
## Contributing
103+
104+
This project uses Maven. To run the tests locally, just run:
105+
106+
```bash
107+
mvn clean verify
108+
```
109+
110+
## Notes about maturity
111+
112+
This module was created after existing libraries were evaluated and dismissed, and we found that we were writing similar
113+
code in multiple projects. As such, it at least initially only contains enough functionality for our internal requirements
114+
which reflect that we were working on build system integration with the Github pull requests. It has been widely used for 4+
115+
years. It's important to notice that it does not cover all Github v3 API. Adding missing endpoints should be very straightforward.
116+
Pull Requests are welcome.
117+
118+
## Code of conduct
119+
This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
120+
121+
[code-of-conduct]: https://github.com/spotify/code-of-conduct/blob/master/code-of-conduct.md

0 commit comments

Comments
 (0)