Merge pull request #977 from skaldarnar/feat/528-ghrelease-assets

Include assets directly in GHRelease

Author: bitwiseman

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

@@ -15,6 +15,7 @@
  * Release in a github repository.
  *
  * @see GHRepository#getReleases() GHRepository#getReleases()
+ * @see GHRepository#listReleases() () GHRepository#listReleases()
  * @see GHRepository#createRelease(String) GHRepository#createRelease(String)
  */
 public class GHRelease extends GHObject {
@@ -23,6 +24,7 @@ public class GHRelease extends GHObject {
 
     private String html_url;
     private String assets_url;
+    private List<GHAsset> assets;
     private String upload_url;
     private String tag_name;
     private String target_commitish;
@@ -249,18 +251,45 @@ public GHAsset uploadAsset(String filename, InputStream stream, String contentTy
     }
 
     /**
-     * Gets assets.
+     * Get the cached assets.
+     *
+     * @return the assets
+     *
+     * @deprecated This should be the default behavior of {@link #getAssets()} in a future release. This method is
+     *             introduced in addition to enable a transition to using cached asset information while keeping the
+     *             existing logic in place for backwards compatibility.
+     */
+    @Deprecated
+    @Preview
+    public List<GHAsset> assets() {
+        return assets;
+    }
+
+    /**
+     * Re-fetch the assets of this release.
      *
      * @return the assets
      * @throws IOException
      *             the io exception
+     * @deprecated The behavior of this method will change in a future release. It will then provide cached assets as
+     *             provided by {@link #assets()}. Use {@link #listAssets()} instead to fetch up-to-date information of
+     *             assets.
      */
+    @Deprecated
     public List<GHAsset> getAssets() throws IOException {
-        Requester builder = owner.root.createRequest();
+        return listAssets().toList();
+    }
 
-        return builder.withUrlPath(getApiTailUrl("assets"))
-                .toIterable(GHAsset[].class, item -> item.wrap(this))
-                .toList();
+    /**
+     * Re-fetch the assets of this release.
+     *
+     * @return the assets
+     * @throws IOException
+     *             the io exception
+     */
+    public PagedIterable<GHAsset> listAssets() throws IOException {
+        Requester builder = owner.root.createRequest();
+        return builder.withUrlPath(getApiTailUrl("assets")).toIterable(GHAsset[].class, item -> item.wrap(this));
     }
 
     /**

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

@@ -56,6 +56,8 @@ private void deleteAsset(GHRelease release, GHAsset asset) throws IOException {
     private GHAsset uploadAsset(GHRelease release) throws IOException {
         GHAsset asset = release.uploadAsset(new File("LICENSE.txt"), "application/text");
         assertNotNull(asset);
+        List<GHAsset> cachedAssets = release.assets();
+        assertEquals(0, cachedAssets.size());
         List<GHAsset> assets = release.getAssets();
         assertEquals(1, assets.size());
         assertEquals("LICENSE.txt", assets.get(0).getName());