Merge branch 'main' into implement_apps

Author: dbaur

pom.xml

@@ -704,7 +704,7 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-enforcer-plugin</artifactId>
-            <version>3.1.0</version>
+            <version>3.2.1</version>
             <executions>
               <execution>
                 <id>enforce-jacoco-exist</id>

src/main/java/org/kohsuke/github/GHAppInstallation.java

@@ -361,4 +361,25 @@ public GHAppCreateTokenBuilder createToken(Map<String, GHPermissionType> permiss
     public GHAppCreateTokenBuilder createToken() {
         return new GHAppCreateTokenBuilder(root(), String.format("/app/installations/%d/access_tokens", getId()));
     }
+
+    /**
+     * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub
+     * App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will
+     * also see the upcoming pending change.
+     *
+     * <p>
+     * GitHub Apps must use a JWT to access this endpoint.
+     * <p>
+     * OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
+     *
+     * @return a GHMarketplaceAccountPlan instance
+     * @throws IOException
+     *             it may throw an {@link IOException}
+     * @see <a href=
+     *      "https://docs.github.com/en/rest/apps/marketplace?apiVersion=2022-11-28#get-a-subscription-plan-for-an-account">Get
+     *      a subscription plan for an account</a>
+     */
+    public GHMarketplaceAccountPlan getMarketplaceAccount() throws IOException {
+        return new GHMarketplacePlanForAccountBuilder(root(), account.getId()).createRequest();
+    }
 }

src/main/java/org/kohsuke/github/GHMarketplaceAccount.java

@@ -1,5 +1,6 @@
 package org.kohsuke.github;
 
+import java.io.IOException;
 import java.net.URL;
 
 // TODO: Auto-generated Javadoc
@@ -72,4 +73,25 @@ public GHMarketplaceAccountType getType() {
         return type;
     }
 
+    /**
+     * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub
+     * App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will
+     * also see the upcoming pending change.
+     *
+     * <p>
+     * GitHub Apps must use a JWT to access this endpoint.
+     * <p>
+     * OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
+     *
+     * @return a GHMarketplaceListAccountBuilder instance
+     * @throws IOException
+     *             in case of {@link IOException}
+     * @see <a href=
+     *      "https://docs.github.com/en/rest/apps/marketplace?apiVersion=2022-11-28#get-a-subscription-plan-for-an-account">Get
+     *      a subscription plan for an account</a>
+     */
+    public GHMarketplaceAccountPlan getPlan() throws IOException {
+        return new GHMarketplacePlanForAccountBuilder(root(), this.id).createRequest();
+    }
+
 }

src/main/java/org/kohsuke/github/GHMarketplacePlanForAccountBuilder.java

@@ -0,0 +1,45 @@
+package org.kohsuke.github;
+
+import java.io.IOException;
+
+// TODO: Auto-generated Javadoc
+/**
+ * Returns the plan associated with current account.
+ *
+ * @author Benoit Lacelle
+ * @see GHMarketplacePlan#listAccounts()
+ * @see GitHub#listMarketplacePlans()
+ */
+public class GHMarketplacePlanForAccountBuilder extends GitHubInteractiveObject {
+    private final Requester builder;
+    private final long accountId;
+
+    /**
+     * Instantiates a new GH marketplace list account builder.
+     *
+     * @param root
+     *            the root
+     * @param accountId
+     *            the account id
+     */
+    GHMarketplacePlanForAccountBuilder(GitHub root, long accountId) {
+        super(root);
+        this.builder = root.createRequest();
+        this.accountId = accountId;
+    }
+
+    /**
+     * Fetch the plan associated with the account specified on construction.
+     * <p>
+     * GitHub Apps must use a JWT to access this endpoint.
+     *
+     * @return a GHMarketplaceAccountPlan
+     * @throws IOException
+     *             on error
+     */
+    public GHMarketplaceAccountPlan createRequest() throws IOException {
+        return builder.withUrlPath(String.format("/marketplace_listing/accounts/%d", this.accountId))
+                .fetch(GHMarketplaceAccountPlan.class);
+    }
+
+}

src/main/java/org/kohsuke/github/GHPullRequest.java

@@ -242,9 +242,9 @@ public int getAdditions() throws IOException {
     }
 
     /**
-     * Gets commits.
+     * Gets the number of commits.
      *
-     * @return the commits
+     * @return the number of commits
      * @throws IOException
      *             the io exception
      */

src/main/java/org/kohsuke/github/GitHub.java

@@ -915,6 +915,23 @@ public List<GHEventInfo> getEvents() throws IOException {
         return createRequest().withUrlPath("/events").toIterable(GHEventInfo[].class, null).toList();
     }
 
+    /**
+     * List public events for a user
+     * <a href="https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-public-events-for-a-user">see
+     * API documentation</a>
+     *
+     * @param login
+     *            the login (user) to look public events for
+     * @return the events
+     * @throws IOException
+     *             the io exception
+     */
+    public List<GHEventInfo> getUserPublicEvents(String login) throws IOException {
+        return createRequest().withUrlPath("/users/" + login + "/events/public")
+                .toIterable(GHEventInfo[].class, null)
+                .toList();
+    }
+
     /**
      * Gets a single gist by ID.
      *

src/main/java/org/kohsuke/github/extras/authorization/JWTTokenProvider.java

@@ -3,6 +3,7 @@
 import io.jsonwebtoken.JwtBuilder;
 import io.jsonwebtoken.Jwts;
 import io.jsonwebtoken.SignatureAlgorithm;
+import io.jsonwebtoken.jackson.io.JacksonSerializer;
 import org.kohsuke.github.authorization.AuthorizationProvider;
 
 import java.io.File;
@@ -181,7 +182,7 @@ private String refreshJWT() {
         validUntil = expiration.minus(Duration.ofMinutes(2));
 
         // Builds the JWT and serializes it to a compact, URL-safe string
-        return builder.compact();
+        return builder.serializeToJsonWith(new JacksonSerializer<>()).compact();
     }
 
     Instant getIssuedAt(Instant now) {

src/site/apt/index.apt

@@ -140,9 +140,9 @@ Pluggable HTTP client
 
   This library comes with a pluggable connector to use different HTTP client implementations
   through <<<HttpConnector>>>. In particular, this means you can use {{{https://square.github.io/okhttp/}OkHttp}},
-  so we can make use of it's HTTP response cache.
+  so we can make use of its HTTP response cache.
   Making a conditional request against the GitHub API and receiving a 304 response
-  {{{https://docs.github.com/en/rest/overview/resources-in-the-rest-api#conditional-requests}does not count against the rate limit}}.
+  {{{https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#conditional-requests}does not count against the rate limit}}.
 
   The following code shows an example of how to set up persistent cache on the disk:
 

src/test/java/org/kohsuke/github/AbstractGHAppInstallationTest.java

@@ -1,5 +1,6 @@
 package org.kohsuke.github;
 
+import com.google.common.collect.ImmutableSet;
 import io.jsonwebtoken.Jwts;
 import org.apache.commons.io.IOUtils;
 import org.kohsuke.github.authorization.AuthorizationProvider;
@@ -9,6 +10,7 @@
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.security.GeneralSecurityException;
 import java.security.KeyFactory;
 import java.security.PrivateKey;
@@ -17,13 +19,19 @@
 import java.time.temporal.ChronoUnit;
 import java.util.Base64;
 import java.util.Date;
+import java.util.List;
 
 // TODO: Auto-generated Javadoc
 /**
  * The Class AbstractGHAppInstallationTest.
  */
 public class AbstractGHAppInstallationTest extends AbstractGitHubWireMockTest {
 
+    private static String ENV_GITHUB_APP_ID = "GITHUB_APP_ID";
+    private static String ENV_GITHUB_APP_JWK_PATH = "GITHUB_APP_JWK_PATH";
+    private static String ENV_GITHUB_APP_ORG = "GITHUB_APP_ORG";
+    private static String ENV_GITHUB_APP_REPO = "GITHUB_APP_REPO";
+
     private static String TEST_APP_ID_1 = "82994";
     private static String TEST_APP_ID_2 = "83009";
     private static String TEST_APP_ID_3 = "89368";
@@ -44,16 +52,23 @@ public class AbstractGHAppInstallationTest extends AbstractGitHubWireMockTest {
      * Instantiates a new abstract GH app installation test.
      */
     protected AbstractGHAppInstallationTest() {
+        String appId = System.getenv(ENV_GITHUB_APP_ID);
+        String appJwkPath = System.getenv(ENV_GITHUB_APP_JWK_PATH);
         try {
-            jwtProvider1 = new JWTTokenProvider(TEST_APP_ID_1,
-                    new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_1).getFile()));
-            jwtProvider2 = new JWTTokenProvider(TEST_APP_ID_2,
-                    new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_2).getFile()).toPath());
-            jwtProvider3 = new JWTTokenProvider(TEST_APP_ID_3,
-                    new String(
-                            Files.readAllBytes(
-                                    new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_3).getFile()).toPath()),
-                            StandardCharsets.UTF_8));
+            if (appId != null && appJwkPath != null) {
+                jwtProvider1 = new JWTTokenProvider(appId, Paths.get(appJwkPath));
+                jwtProvider2 = jwtProvider1;
+                jwtProvider3 = jwtProvider1;
+            } else {
+                jwtProvider1 = new JWTTokenProvider(TEST_APP_ID_1,
+                        new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_1).getFile()));
+                jwtProvider2 = new JWTTokenProvider(TEST_APP_ID_2,
+                        new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_2).getFile()).toPath());
+                jwtProvider3 = new JWTTokenProvider(TEST_APP_ID_3,
+                        new String(Files.readAllBytes(
+                                new File(this.getClass().getResource(PRIVATE_KEY_FILE_APP_3).getFile()).toPath()),
+                                StandardCharsets.UTF_8));
+            }
         } catch (GeneralSecurityException | IOException e) {
             throw new RuntimeException("These should never fail", e);
         }
@@ -89,17 +104,28 @@ private String createJwtToken(String keyFileResouceName, String appId) {
      *             Signals that an I/O exception has occurred.
      */
     protected GHAppInstallation getAppInstallationWithToken(String jwtToken) throws IOException {
+        if (jwtToken.startsWith("Bearer ")) {
+            jwtToken = jwtToken.substring("Bearer ".length());
+        }
+
         GitHub gitHub = getGitHubBuilder().withJwtToken(jwtToken)
                 .withEndpoint(mockGitHub.apiServer().baseUrl())
                 .build();
 
-        GHAppInstallation appInstallation = gitHub.getApp()
-                .listInstallations()
-                .toList()
-                .stream()
-                .filter(it -> it.getAccount().login.equals("hub4j-test-org"))
-                .findFirst()
-                .get();
+        GHApp app = gitHub.getApp();
+
+        GHAppInstallation appInstallation;
+        if (ImmutableSet.of(TEST_APP_ID_1, TEST_APP_ID_2, TEST_APP_ID_3).contains(Long.toString(app.getId()))) {
+            List<GHAppInstallation> installations = app.listInstallations().toList();
+            appInstallation = installations.stream()
+                    .filter(it -> it.getAccount().login.equals("hub4j-test-org"))
+                    .findFirst()
+                    .get();
+        } else {
+            // We may be processing a custom JWK, for a custom GHApp: fetch a relevant repository dynamically
+            appInstallation = app.getInstallationByRepository(System.getenv(ENV_GITHUB_APP_ORG),
+                    System.getenv(ENV_GITHUB_APP_REPO));
+        }
 
         // TODO: this is odd
         // appInstallation

src/test/java/org/kohsuke/github/AppTest.java

@@ -1036,6 +1036,30 @@ public void testEventApi() throws Exception {
         }
     }
 
+    /**
+     * Test user public event api.
+     *
+     * @throws Exception
+     *             the exception
+     */
+    @Test
+    public void testUserPublicEventApi() throws Exception {
+        for (GHEventInfo ev : gitHub.getUserPublicEvents("PierreBtz")) {
+            if (ev.getType() == GHEvent.PULL_REQUEST) {
+                if (ev.getId() == 27449881624L) {
+                    assertThat(ev.getActorLogin(), equalTo("PierreBtz"));
+                    assertThat(ev.getOrganization().getLogin(), equalTo("hub4j"));
+                    assertThat(ev.getRepository().getFullName(), equalTo("hub4j/github-api"));
+                    assertThat(ev.getCreatedAt(), equalTo(GitHubClient.parseDate("2023-03-02T16:37:49Z")));
+                    assertThat(ev.getType(), equalTo(GHEvent.PULL_REQUEST));
+                }
+
+                GHEventPayload.PullRequest pr = ev.getPayload(GHEventPayload.PullRequest.class);
+                assertThat(pr.getNumber(), is(pr.getPullRequest().getNumber()));
+            }
+        }
+    }
+
     /**
      * Test app.
      *