Added support for project snippets.

Author: gmessner

README.md

@@ -11,7 +11,7 @@ To utilize the GitLab API for Java in your project, simply add the following dep
 ```java
 dependencies {
     ...
-    compile group: 'org.gitlab4j', name: 'gitlab4j-api', version: '4.4.7'
+    compile group: 'org.gitlab4j', name: 'gitlab4j-api', version: '4.4.8'
 }
 ```
 
@@ -20,11 +20,11 @@ dependencies {
 <dependency>
     <groupId>org.gitlab4j</groupId>
     <artifactId>gitlab4j-api</artifactId>
-    <version>4.4.7</version>
+    <version>4.4.8</version>
 </dependency>
 ```
 
-If you are not using Gradle or Maven you can download the latest gitlab4j-api JAR file here: [gitlab4j-api-4.4.7.jar](https://oss.sonatype.org/service/local/repositories/releases/content/org/gitlab4j/gitlab4j-api/4.4.7/gitlab4j-api-4.4.7.jar "Download JAR")
+If you are not using Gradle or Maven you can download the latest gitlab4j-api JAR file here: [gitlab4j-api-4.4.8.jar](https://oss.sonatype.org/service/local/repositories/releases/content/org/gitlab4j/gitlab4j-api/4.4.8/gitlab4j-api-4.4.8.jar "Download JAR")
 
 Javadocs are available here: <a href="http://www.messners.com/gitlab4j-api/javadocs/index.html?org/gitlab4j/api/package-summary.html" target="_top">Javadocs</a>
 

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

@@ -1,3 +1,26 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Greg Messner <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.gitlab4j.api;
 
 import java.io.UnsupportedEncodingException;
@@ -14,6 +37,7 @@
 import org.gitlab4j.api.models.Member;
 import org.gitlab4j.api.models.Project;
 import org.gitlab4j.api.models.ProjectHook;
+import org.gitlab4j.api.models.Snippet;
 import org.gitlab4j.api.models.Visibility;
 
 /**
@@ -1265,4 +1289,147 @@ public void deleteIssue(Integer projectId, Integer issueId) throws GitLabApiExce
         Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
         delete(expectedStatus, getDefaultPerPageParam(), "projects", projectId, "issues", issueId);
     }
+
+    /**
+     * Get a list of project snippets.  This only returns the first page of snippets.
+     *
+     * GET /projects/:id/snippets
+     *
+     * @param projectId the project ID to get the snippets for
+     * @return a list of project's snippets
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Snippet> getSnippets(Integer projectId) throws GitLabApiException {
+        return (getSnippets(projectId, 1, this.getDefaultPerPage()));
+    }
+
+    /**
+     * Get a list of project snippets.  This only returns the first page of snippets.
+     *
+     * GET /projects/:id/snippets
+     *
+     * @param projectId the project ID to get the snippets for
+     * @param page the page to get
+     * @param perPage the number of snippets per page
+     * @return a list of project's snippets for the specified range
+     * @throws GitLabApiException if any exception occurs
+     */
+    public List<Snippet> getSnippets(Integer projectId, int page, int perPage) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", projectId, "snippets");
+        return (response.readEntity(new GenericType<List<Snippet>>() {}));
+    }
+
+    /**
+     * Get a Pager of project's snippets.
+     *
+     * GET /projects/:id/snippets
+     *
+     * @param projectId the project ID to get the issues for
+     * @param itemsPerPage the number of snippets per page
+     * @return the Pager of snippets
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Pager<Snippet> getSnippets(Integer projectId, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<Snippet>(this, Snippet.class, itemsPerPage, null, "projects", projectId, "snippets"));
+    }
+
+    /**
+     * Get a single of project snippet.
+     *
+     * GET /projects/:id/snippets/:snippet_id
+     *
+     * @param projectId the project ID to get the snippet for
+     * @param snippetId the ID of the project's snippet
+     * @return the specified project Snippet
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Snippet getSnippet(Integer projectId, Integer snippetId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "projects", projectId, "snippets", snippetId);
+        return (response.readEntity(Snippet.class));
+    }
+
+    /**
+     * Creates a new project snippet. The user must have permission to create new snippets.
+     *
+     * POST /projects/:id/snippets
+     *
+     * @param id the ID of the project owned by the authenticated user, required
+     * @param title the title of a snippet, required
+     * @param fileName the name of a snippet file, required
+     * @param description the description of a snippet, optional
+     * @param code the content of a snippet, required
+     * @param visibility the snippet's visibility, required
+     * @return a Snippet instance with info on the created snippet
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Snippet createSnippet(Integer projectId, String title, String filename, String description,
+            String code, Visibility visibility) throws GitLabApiException {
+
+        GitLabApiForm formData = new GitLabApiForm()
+                .withParam("title", title, true)
+                .withParam("file_name", filename, true)
+                .withParam("description", description)
+                .withParam("code", code, true)
+                .withParam("visibility", visibility, true);
+
+        Response response = post(Response.Status.CREATED, formData, "projects", projectId, "snippets");
+        return (response.readEntity(Snippet.class));
+    }
+
+    /**
+     * Updates an existing project snippet. The user must have permission to change an existing snippet.
+     *
+     * PUT /projects/:id/snippets/:snippet_id
+     *
+     * @param id the ID of the project owned by the authenticated user, required
+     * @param snippetId the ID of a project's snippet, required
+     * @param title the title of a snippet, optional
+     * @param fileName the name of a snippet file, optional
+     * @param description the description of a snippet, optioptionalonal
+     * @param code the content of a snippet, optional
+     * @param visibility the snippet's visibility, reqoptionaluired
+     * @return a Snippet instance with info on the updated snippet
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Snippet updateSnippet(Integer projectId, Integer snippetId, String title, String filename, String description,
+            String code, Visibility visibility) throws GitLabApiException {
+
+        GitLabApiForm formData = new GitLabApiForm()
+                .withParam("title", title)
+                .withParam("file_name", filename)
+                .withParam("description", description)
+                .withParam("code", code)
+                .withParam("visibility", visibility);
+
+        Response response = put(Response.Status.OK, formData.asMap(), "projects", projectId, "snippets", snippetId);
+        return (response.readEntity(Snippet.class));
+    }
+
+    /*
+     * Deletes an existing project snippet. This is an idempotent function and deleting a
+     * non-existent snippet does not cause an error.
+     *
+     * DELETE /projects/:id/snippets/:snippet_id
+     *
+     * @param projectId the project ID of the snippet
+     * @param snippetId the ID of the project's snippet
+     * @throws GitLabApiException if any exception occurs
+     */
+    public void deleteSnippet(Integer projectId, Integer snippetId) throws GitLabApiException {
+        delete(Response.Status.NO_CONTENT, null, "projects", projectId, "snippets", snippetId);
+    }
+
+    /*
+     * Get the raw project snippet as plain text.
+     *
+     * GET /projects/:id/snippets/:snippet_id/raw
+     *
+     * @param projectId the project ID of the snippet
+     * @param snippetId the ID of the project's snippet
+     * @throws GitLabApiException if any exception occurs
+     */
+    public String getRawSnippetContent(Integer projectId, Integer snippetId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "projects", projectId, "snippets", snippetId, "raw");
+        return (response.readEntity(String.class));
+    }
 }

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

@@ -1,7 +1,29 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Greg Messner <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.gitlab4j.api.models;
 
-import java.util.HashMap;
-import java.util.Map;
+import org.gitlab4j.api.utils.JacksonJsonEnumHelper;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
@@ -13,24 +35,20 @@ public enum JobStatus {
 
     RUNNING, PENDING, SUCCESS, FAILED, CANCELED, SKIPPED;
 
-    private static Map<String, JobStatus> valuesMap = new HashMap<>(6);
-    static {
-        for (JobStatus status : JobStatus.values())
-            valuesMap.put(status.toValue(), status);
-    }
+    private static JacksonJsonEnumHelper<JobStatus> enumHelper = new JacksonJsonEnumHelper<>(JobStatus.class);
 
     @JsonCreator
     public static JobStatus forValue(String value) {
-    return valuesMap.get(value);
-  }
+        return enumHelper.forValue(value);
+    }
 
     @JsonValue
     public String toValue() {
-    return (name().toLowerCase());
-  }
+        return (enumHelper.toString(this));
+    }
 
     @Override
     public String toString() {
-    return (name().toLowerCase());
-  }
+        return (enumHelper.toString(this));
+    }
 }

src/main/java/org/gitlab4j/api/models/ProjectSnippet.java renamed to src/main/java/org/gitlab4j/api/models/Snippet.java

@@ -1,3 +1,26 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Greg Messner <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.gitlab4j.api.models;
 
 import java.util.Date;
@@ -8,7 +31,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class ProjectSnippet {
+public class Snippet {
 
     private Author author;
     private Date createdAt;

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

@@ -1,7 +1,29 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Greg Messner <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.gitlab4j.api.models;
 
-import java.util.HashMap;
-import java.util.Map;
+import org.gitlab4j.api.utils.JacksonJsonEnumHelper;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
@@ -10,24 +32,20 @@ public enum Visibility {
 
     PUBLIC, PRIVATE, INTERNAL;
 
-    private static Map<String, Visibility> valuesMap = new HashMap<>(3);
-    static {
-        for (Visibility visibility : Visibility.values())
-            valuesMap.put(visibility.toValue(), visibility);
-    }
+    private static JacksonJsonEnumHelper<Visibility> enumHelper = new JacksonJsonEnumHelper<>(Visibility.class);
 
     @JsonCreator
     public static Visibility forValue(String value) {
-        return valuesMap.get(value);
+        return enumHelper.forValue(value);
     }
 
     @JsonValue
     public String toValue() {
-        return (name().toLowerCase());
+        return (enumHelper.toString(this));
     }
 
     @Override
     public String toString() {
-        return (name().toLowerCase());
+        return (enumHelper.toString(this));
     }
 }