Issue 828 - Add new API - Discussion

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

@@ -0,0 +1,225 @@
+package org.kohsuke.github;
+
+import com.fasterxml.jackson.annotation.JacksonInject;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.Objects;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+
+/**
+ * A discussion in GitHub Team.
+ *
+ * @author Charles Moulliard
+ * @see <a href="https://developer.github.com/v3/teams/discussions">GitHub Team Discussions</a>
+ */
+public class GHDiscussion extends GHObject {
+
+    @JacksonInject
+    private GitHub root;
+    private GHTeam team;
+    private long number;
+    private String body, title, htmlUrl;
+
+    @JsonProperty(value = "private")
+    private boolean isPrivate;
+
+    @Override
+    public URL getHtmlUrl() throws IOException {
+        return GitHubClient.parseURL(htmlUrl);
+    }
+
+    GHDiscussion wrapUp(GHTeam team) {
+        this.team = team;
+        return this;
+    }
+
+    /**
+     * Get the team to which this discussion belongs.
+     *
+     * @return the team for this discussion
+     */
+    @Nonnull
+    public GHTeam getTeam() {
+        return team;
+    }
+
+    /**
+     * Get the title of the discussion.
+     *
+     * @return the title
+     */
+    public String getTitle() {
+        return title;
+    }
+
+    /**
+     * The description of this discussion.
+     *
+     * @return the body
+     */
+    public String getBody() {
+        return body;
+    }
+
+    /**
+     * The number of this discussion.
+     *
+     * @return the number
+     */
+    public long getNumber() {
+        return number;
+    }
+
+    /**
+     * The id number of this discussion. GitHub discussions have "number" instead of "id". This is provided for
+     * convenience.
+     *
+     * @return the id number for this discussion
+     * @see #getNumber()
+     */
+    @Override
+    public long getId() {
+        return getNumber();
+    }
+
+    /**
+     * Whether the discussion is private to the team.
+     *
+     * @return {@code true} if discussion is private.
+     */
+    public boolean isPrivate() {
+        return isPrivate;
+    }
+
+    /**
+     * Begins the creation of a new instance.
+     *
+     * Consumer must call {@link GHDiscussion.Creator#done()} to commit changes.
+     *
+     * @param team
+     *            the team in which the discussion will be created.
+     * @return a {@link GHLabel.Creator}
+     * @throws IOException
+     *             the io exception
+     */
+    static GHDiscussion.Creator create(GHTeam team) throws IOException {
+        return new GHDiscussion.Creator(team);
+    }
+
+    static GHDiscussion read(GHTeam team, long discussionNumber) throws IOException {
+        return team.root.createRequest()
+                .setRawUrlPath(getRawUrlPath(team, discussionNumber))
+                .fetch(GHDiscussion.class)
+                .wrapUp(team);
+    }
+
+    static PagedIterable<GHDiscussion> readAll(GHTeam team) throws IOException {
+        return team.root.createRequest()
+                .setRawUrlPath(getRawUrlPath(team, null))
+                .toIterable(GHDiscussion[].class, item -> item.wrapUp(team));
+    }
+
+    /**
+     * Begins a batch update
+     *
+     * Consumer must call {@link GHDiscussion.Updater#done()} to commit changes.
+     *
+     * @return a {@link GHDiscussion.Updater}
+     */
+    @Preview
+    @Deprecated
+    public GHDiscussion.Updater update() {
+        return new GHDiscussion.Updater(this);
+    }
+
+    /**
+     * Begins a single property update.
+     *
+     * @return a {@link GHDiscussion.Setter}
+     */
+    @Preview
+    @Deprecated
+    public GHDiscussion.Setter set() {
+        return new GHDiscussion.Setter(this);
+    }
+
+    /**
+     * Delete the discussion
+     *
+     * @throws IOException
+     *             the io exception
+     */
+    public void delete() throws IOException {
+        team.root.createRequest().method("DELETE").setRawUrlPath(getRawUrlPath(team, number)).send();
+    }
+
+    @NotNull
+    private static String getRawUrlPath(@Nonnull GHTeam team, @CheckForNull Long discussionNumber) {
+        return team.getUrl().toString() + "/discussions" + (discussionNumber == null ? "" : "/" + discussionNumber);
+    }
+
+    /**
+     * A {@link GHLabelBuilder} that updates a single property per request
+     *
+     * {@link #done()} is called automatically after the property is set.
+     */
+    public static class Setter extends GHDiscussionBuilder<GHDiscussion> {
+        private Setter(@Nonnull GHDiscussion base) {
+            super(GHDiscussion.class, base.team, base);
+            requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
+        }
+    }
+
+    /**
+     * A {@link GHLabelBuilder} that allows multiple properties to be updated per request.
+     *
+     * Consumer must call {@link #done()} to commit changes.
+     */
+    public static class Updater extends GHDiscussionBuilder<Updater> {
+        private Updater(@Nonnull GHDiscussion base) {
+            super(GHDiscussion.Updater.class, base.team, base);
+            requester.method("PATCH").setRawUrlPath(base.getUrl().toString());
+        }
+    }
+
+    /**
+     * A {@link GHLabelBuilder} that creates a new {@link GHLabel}
+     *
+     * Consumer must call {@link #done()} to create the new instance.
+     */
+    public static class Creator extends GHDiscussionBuilder<Creator> {
+
+        private Creator(@Nonnull GHTeam team) {
+            super(GHDiscussion.Creator.class, team, null);
+            requester.method("POST").setRawUrlPath(getRawUrlPath(team, null));
+        }
+
+        @Nonnull
+        public Creator private_(boolean value) throws IOException {
+            return with("private", value);
+        }
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        GHDiscussion that = (GHDiscussion) o;
+        return number == that.number && Objects.equals(getUrl(), that.getUrl()) && Objects.equals(team, that.team)
+                && Objects.equals(body, that.body) && Objects.equals(title, that.title);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(team, number, body, title);
+    }
+}

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

@@ -0,0 +1,77 @@
+package org.kohsuke.github;
+
+import java.io.IOException;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+
+/**
+ * Base class for creating or updating a discussion.
+ *
+ * @param <S>
+ *            Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
+ *            the same as {@link GHLabel}, this builder will commit changes after each call to
+ *            {@link #with(String, Object)}.
+ */
+class GHDiscussionBuilder<S> extends AbstractBuilder<GHDiscussion, S> {
+
+    private final GHTeam team;
+
+    /**
+     *
+     * @param intermediateReturnType
+     *            Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If
+     *            {@link S} the same as {@link GHDiscussion}, this builder will commit changes after each call to
+     *            {@link #with(String, Object)}.
+     * @param team
+     *            the GitHub team. Updates will be sent to the root of this team.
+     * @param baseInstance
+     *            instance on which to base this builder. If {@code null} a new instance will be created.
+     */
+    protected GHDiscussionBuilder(@Nonnull Class<S> intermediateReturnType,
+            @Nonnull GHTeam team,
+            @CheckForNull GHDiscussion baseInstance) {
+        super(GHDiscussion.class, intermediateReturnType, team.root, baseInstance);
+
+        this.team = team;
+
+        if (baseInstance != null) {
+            requester.with("title", baseInstance.getTitle());
+            requester.with("body", baseInstance.getBody());
+        }
+    }
+
+    /**
+     * Title for this discussion.
+     *
+     * @param value
+     *            title of discussion
+     * @throws IOException
+     *             the io exception
+     * @return either a continuing builder or an updated {@link GHDiscussion}
+     */
+    @Nonnull
+    public S title(String value) throws IOException {
+        return with("title", value);
+    }
+
+    /**
+     * Body content for this discussion.
+     *
+     * @param value
+     *            body of discussion
+     * @throws IOException
+     *             the io exception
+     * @return either a continuing builder or an updated {@link GHDiscussion}
+     */
+    @Nonnull
+    public S body(String value) throws IOException {
+        return with("body", value);
+    }
+
+    @Nonnull
+    @Override
+    public GHDiscussion done() throws IOException {
+        return super.done().wrapUp(team);
+    }
+}

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

@@ -3,9 +3,12 @@
 import java.io.IOException;
 import java.net.URL;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
 import java.util.TreeMap;
 
+import javax.annotation.Nonnull;
+
 /**
  * A team in GitHub organization.
  *
@@ -130,6 +133,36 @@ public void setPrivacy(Privacy privacy) throws IOException {
         root.createRequest().method("PATCH").with("privacy", privacy).withUrlPath(api("")).send();
     }
 
+    /**
+     * Retrieves the discussions.
+     *
+     * @return the paged iterable
+     * @throws IOException
+     *             the io exception
+     */
+    @Nonnull
+    public PagedIterable<GHDiscussion> listDiscussions() throws IOException {
+        return GHDiscussion.readAll(this);
+    }
+
+    /**
+     * Gets a single discussion by ID.
+     *
+     * @param discussionNumber
+     *            id of the discussion that we want to query for
+     * @return the discussion
+     * @throws java.io.FileNotFoundException
+     *             if the discussion does not exist
+     * @throws IOException
+     *             the io exception
+     *
+     * @see <a href= "https://developer.github.com/v3/teams/discussions/#get-a-discussion">documentation</a>
+     */
+    @Nonnull
+    public GHDiscussion getDiscussion(long discussionNumber) throws IOException {
+        return GHDiscussion.read(this, discussionNumber);
+    }
+
     /**
      * Retrieves the current members.
      *
@@ -297,6 +330,21 @@ private String api(String tail) {
         return "/teams/" + getId() + tail;
     }
 
+    /**
+     * Begins the creation of a new instance.
+     *
+     * Consumer must call {@link GHDiscussion.Creator#done()} to commit changes.
+     *
+     * @param title
+     *            title of the discussion to be created
+     * @return a {@link GHDiscussion.Creator}
+     * @throws IOException
+     *             the io exception
+     */
+    public GHDiscussion.Creator createDiscussion(String title) throws IOException {
+        return GHDiscussion.create(this).title(title);
+    }
+
     /**
      * Gets organization.
      *
@@ -318,4 +366,23 @@ public void refresh() throws IOException {
     public URL getHtmlUrl() {
         return GitHubClient.parseURL(html_url);
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        GHTeam ghTeam = (GHTeam) o;
+        return Objects.equals(name, ghTeam.name) && Objects.equals(getUrl(), ghTeam.getUrl())
+                && Objects.equals(permission, ghTeam.permission) && Objects.equals(slug, ghTeam.slug)
+                && Objects.equals(description, ghTeam.description) && privacy == ghTeam.privacy;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name, getUrl(), permission, slug, description, privacy);
+    }
 }