Initial commit (#316).

Author: gmessner

src/main/java/org/gitlab4j/api/BoardsApi.java

@@ -0,0 +1,266 @@
+package org.gitlab4j.api;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Stream;
+
+import javax.ws.rs.core.GenericType;
+import javax.ws.rs.core.Response;
+
+import org.gitlab4j.api.models.Board;
+import org.gitlab4j.api.models.BoardList;
+
+/**
+ * This class implements the client side API for the GitLab Issue Boards API calls.
+ * 
+ * NOTE: If a user is not a member of a group and the group is private, 
+ *       a GET request on that group will result to a 404 status code.
+ * 
+ * @see <a href="https://docs.gitlab.com/ce/api/boards.html">GitLab Issue Boards API Documentaion</a>
+ */
+public class BoardsApi extends AbstractApi {
+
+    public BoardsApi(GitLabApi gitLabApi) {
+        super(gitLabApi);
+    }
+
+    /**
+     * Lists Issue Boards in the given project.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a list of project's issue boards
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Board> getBoards(Object projectIdOrPath) throws GitLabApiException {
+        return (getBoards(projectIdOrPath, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Get all issue boards for the specified project using the specified page and per page setting
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param page the page to get
+     * @param perPage the number of items per page
+     * @return a list of project's Boards in the specified range
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Board> getBoards(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
+        Response response = get(javax.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage),
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards");
+        return (response.readEntity(new GenericType<List<Board>>() {}));
+    }
+
+    /**
+     * Get a Pager of all issue boards for the specified project.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param itemsPerPage the number of items per page
+     * @return a Pager of project's issue boards
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<Board> getBoards(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<Board>(this, Board.class, itemsPerPage, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards"));
+    }
+
+    /**
+     * Get a Stream of all issue boards for the specified project.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a Stream of project's issue boards
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Board> getBoardsStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getBoards(projectIdOrPath, getDefaultPerPage()).stream());
+    }
+
+    /**
+     * Get a single issue board.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @return a Board instance for the specified board ID
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Board getBoard(Object projectIdOrPath, Integer boardId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, 
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId);
+        return (response.readEntity(Board.class));
+    }
+
+    /**
+     * Get an issue board as an Optional instance.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id</code></pre> 
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @return the Board instance for the specified board ID as an Optional instance
+     */
+    public Optional<Board> getOptionalBoard(Object projectIdOrPath, Integer boardId) {
+        try {
+            return (Optional.ofNullable(getBoard(projectIdOrPath, boardId)));
+        } catch (GitLabApiException glae) {
+            return (GitLabApi.createOptionalFromException(glae));
+        }
+    }
+
+    /**
+     * Get a list of the board’s lists. Does not include open and closed lists.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @return a list of the issue board's lists
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId) throws GitLabApiException {
+        return (getBoardLists(projectIdOrPath, boardId, getDefaultPerPage()).all());
+    }
+
+    /**
+     * Get a list of the board’s lists for the specified project to using the specified page and per page setting.
+     * Does not include open and closed lists.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param page the page to get
+     * @param perPage the number of Boards per page
+     * @return a list of the issue board's lists in the specified range
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId, int page, int perPage) throws GitLabApiException {
+        Response response = get(javax.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage),
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists");
+        return (response.readEntity(new GenericType<List<BoardList>>() {}));
+    }
+
+    /**
+     * Get a Pager of the board’s lists. Does not include open and closed lists.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param itemsPerPage the number of Board instances that will be fetched per page
+     * @return a Pager of the issue board's lists
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<BoardList>(this, BoardList.class, itemsPerPage, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists"));
+    }
+
+    /**
+     * Get a Stream of the board’s lists. Does not include open and closed lists.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @return a Stream of the issue board's lists
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<BoardList> getBoardsListsStream(Object projectIdOrPath, Integer boardId) throws GitLabApiException {
+        return (getBoardLists(projectIdOrPath, boardId, getDefaultPerPage()).stream());
+    }
+
+    /**
+     * Get a single issue board list.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param listId the ID of the board lists to get
+     * @return a BoardList instance for the specified board ID and list ID
+     * @throws GitLabApiException if any exception occurs
+     */
+    public BoardList getBoardList(Object projectIdOrPath, Integer boardId, Integer listId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, 
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId);
+        return (response.readEntity(BoardList.class));
+    }
+
+    /**
+     * Get a single issue board list as an Optional instance.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id</code></pre> 
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param listId the ID of the board lists to get
+     * @return a BoardList instance for the specified board ID and list ID as an Optional instance
+     */
+    public Optional<BoardList> getOptionalBoardList(Object projectIdOrPath, Integer boardId, Integer listId) {
+        try {
+            return (Optional.ofNullable(getBoardList(projectIdOrPath, boardId, listId)));
+        } catch (GitLabApiException glae) {
+            return (GitLabApi.createOptionalFromException(glae));
+        }
+    }
+
+    /**
+     * Creates a new Issue Board list.
+     *
+     * <pre><code>GitLab Endpoint: POST /projects/:id/boards/:board_id/lists</code></pre> 
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param labelId the ID of the label
+     * @return the created BoardList instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public BoardList createBoardList(Object projectIdOrPath, Integer boardId, Integer labelId) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm()
+                .withParam("label_id", labelId, true);
+        Response response = post(Response.Status.CREATED, formData, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists");
+        return (response.readEntity(BoardList.class));
+    }
+
+    /**
+     * Updates an existing Issue Board list. This call is used to change list position.
+     *
+     * <pre><code>GitLab Endpoint: PUT /projects/:id/boards/:board_id/lists/:list_id</code></pre> 
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param listId the ID of the list
+     * @param position the new position for the list
+     * @return the updated BoardList instance
+     * @throws GitLabApiException if any exception occurs
+     */
+    public BoardList updateBoardList(Object projectIdOrPath, Integer boardId, Integer listId, Integer position) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm().withParam("position", position, true);
+        Response response = putWithFormData(Response.Status.OK, formData,
+                "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId);
+        return (response.readEntity(BoardList.class));
+    }
+
+    /**
+     * Soft deletes an existing Issue Board list. Only for admins and project owners.
+     *
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/boards/:board_id/lists/:list_id</code></pre> 
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param boardId the ID of the board
+     * @param listId the ID of the list
+     * @throws GitLabApiException if any exception occurs
+     */
+    public void deleteBoardList(Object projectIdOrPath, Integer boardId, Integer listId) throws GitLabApiException {
+        delete(Response.Status.NO_CONTENT, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId);
+    }
+}

src/main/java/org/gitlab4j/api/models/Board.java

@@ -0,0 +1,65 @@
+package org.gitlab4j.api.models;
+
+import java.util.List;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
+import org.gitlab4j.api.utils.JacksonJson;
+
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
+public class Board {
+
+    private Integer id;
+    private String name;
+    private Project project;
+    private Milestone milestone;
+    private List<BoardList> lists;
+
+    public Integer getId() {
+        return id;
+    }
+
+    public void setId(Integer id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Project getProject() {
+        return project;
+    }
+
+    public void setProject(Project project) {
+        this.project = project;
+    }
+
+    public Milestone getMilestone() {
+        return milestone;
+    }
+
+    public void setMilestone(Milestone milestone) {
+        this.milestone = milestone;
+    }
+
+    public List<BoardList> getLists() {
+        return lists;
+    }
+
+    public void setLists(List<BoardList> lists) {
+        this.lists = lists;
+    }
+
+    @Override
+    public String toString() {
+        return (JacksonJson.toJsonString(this));
+    }
+}

src/main/java/org/gitlab4j/api/models/BoardList.java

@@ -0,0 +1,45 @@
+package org.gitlab4j.api.models;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
+import org.gitlab4j.api.utils.JacksonJson;
+
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
+public class BoardList {
+
+    private Integer id;
+    private Label label;
+    private Integer position;
+
+    public Integer getId() {
+        return id;
+    }
+
+    public void setId(Integer id) {
+        this.id = id;
+    }
+
+    public Label getLabel() {
+        return label;
+    }
+
+    public void setLabel(Label label) {
+        this.label = label;
+    }
+
+    public Integer getPosition() {
+        return position;
+    }
+
+    public void setPosition(Integer position) {
+        this.position = position;
+    }
+
+    @Override
+    public String toString() {
+        return (JacksonJson.toJsonString(this));
+    }
+}