System hook improvements

Author: jmini

gitlab4j-api/src/main/java/org/gitlab4j/api/SystemHooksApi.java

@@ -23,7 +23,7 @@ public SystemHooksApi(GitLabApi gitLabApi) {
      *
      * <pre><code>GitLab Endpoint: GET /hooks</code></pre>
      *
-     * @return a list of SystemHookEvent
+     * @return a list of SystemHook
      * @throws GitLabApiException if any exception occurs
      */
     public List<SystemHook> getSystemHooks() throws GitLabApiException {
@@ -38,7 +38,7 @@ public List<SystemHook> getSystemHooks() throws GitLabApiException {
      *
      * @param page the page to get
      * @param perPage the number of deploy keys per page
-     * @return the list of SystemHookEvent in the specified range
+     * @return the list of SystemHook in the specified range
      * @throws GitLabApiException if any exception occurs
      */
     public List<SystemHook> getSystemHooks(int page, int perPage) throws GitLabApiException {
@@ -51,8 +51,8 @@ public List<SystemHook> getSystemHooks(int page, int perPage) throws GitLabApiEx
      *
      * <pre><code>GitLab Endpoint: GET /hooks</code></pre>
      *
-     * @param itemsPerPage the number of SystemHookEvent instances that will be fetched per page
-     * @return a Pager of SystemHookEvent
+     * @param itemsPerPage the number of SystemHook instances that will be fetched per page
+     * @return a Pager of SystemHook
      * @throws GitLabApiException if any exception occurs
      */
     public Pager<SystemHook> getSystemHooks(int itemsPerPage) throws GitLabApiException {
@@ -64,13 +64,27 @@ public Pager<SystemHook> getSystemHooks(int itemsPerPage) throws GitLabApiExcept
      *
      * <pre><code>GitLab Endpoint: GET /hooks</code></pre>
      *
-     * @return a Stream of SystemHookEvent
+     * @return a Stream of SystemHook
      * @throws GitLabApiException if any exception occurs
      */
     public Stream<SystemHook> getSystemHookStream() throws GitLabApiException {
         return (getSystemHooks(getDefaultPerPage()).stream());
     }
 
+    /**
+     * Get a list of all system hooks. This method requires admin access.
+     *
+     * <pre><code>GitLab Endpoint: GET /hooks</code></pre>
+     *
+     * @param hookId the ID of the system hook.
+     * @return the SystemHook
+     * @throws GitLabApiException if any exception occurs
+     */
+    public SystemHook getSystemHook(Long hookId) throws GitLabApiException {
+        Response response = get(Response.Status.OK, null, "hooks", hookId);
+        return response.readEntity(SystemHook.class);
+    }
+
     /**
      * Add a new system hook. This method requires admin access.
      *
@@ -81,7 +95,7 @@ public Stream<SystemHook> getSystemHookStream() throws GitLabApiException {
      * @param pushEvents when true, the hook will fire on push events, optional
      * @param tagPushEvents when true, the hook will fire on new tags being pushed, optional
      * @param enableSslVerification do SSL verification when triggering the hook, optional
-     * @return an SystemHookEvent instance with info on the added system hook
+     * @return an SystemHook instance with info on the added system hook
      * @throws GitLabApiException if any exception occurs
      */
     public SystemHook addSystemHook(
@@ -104,7 +118,7 @@ public SystemHook addSystemHook(
      * @param url the hook URL, required
      * @param token secret token to validate received payloads, optional
      * @param systemHook the systemHook to create
-     * @return an SystemHookEvent instance with info on the added system hook
+     * @return an SystemHook instance with info on the added system hook
      * @throws GitLabApiException if any exception occurs
      */
     public SystemHook addSystemHook(String url, String token, SystemHook systemHook) throws GitLabApiException {
@@ -116,6 +130,8 @@ public SystemHook addSystemHook(String url, String token, SystemHook systemHook)
         GitLabApiForm formData = new GitLabApiForm()
                 .withParam("url", url, true)
                 .withParam("token", token)
+                .withParam("name", systemHook.getName())
+                .withParam("description", systemHook.getDescription())
                 .withParam("push_events", systemHook.getPushEvents())
                 .withParam("tag_push_events", systemHook.getTagPushEvents())
                 .withParam("merge_requests_events", systemHook.getMergeRequestsEvents())
@@ -166,7 +182,7 @@ public void deleteSystemHook(Long hookId) throws GitLabApiException {
      *
      * <pre><code>GitLab Endpoint: GET /hooks/:hook_id</code></pre>
      *
-     * @param hook the SystemHookEvent instance to test
+     * @param hook the SystemHook instance to test
      * @throws GitLabApiException if any exception occurs
      */
     public void testSystemHook(SystemHook hook) throws GitLabApiException {
@@ -194,4 +210,19 @@ public void testSystemHook(Long hookId) throws GitLabApiException {
 
         get(Response.Status.OK, null, "hooks", hookId);
     }
+
+    /**
+     * Add a new system hook. This method requires admin access.
+     *
+     *  <pre><code>GitLab Endpoint: PUT /hooks/:hook_id/url_variables/:key</code></pre>
+     *
+     * @param hookId the ID of the system hook
+     * @param key Key of the URL variable
+     * @param value Value of the URL variable.
+     * @throws GitLabApiException if any exception occurs
+     */
+    public void addSystemHookUrlVariable(Long hookId, String key, String value) throws GitLabApiException {
+        GitLabApiForm formData = new GitLabApiForm().withParam("value", value, true);
+        put(Response.Status.CREATED, formData, "hooks", hookId, "url_variables", key);
+    }
 }

gitlab4j-models/src/main/java/org/gitlab4j/api/models/SystemHook.java

@@ -9,6 +9,8 @@ public class SystemHook implements Serializable {
     private static final long serialVersionUID = 1L;
 
     private Long id;
+    private String name;
+    private String description;
     private String url;
     private Date createdAt;
     private Boolean pushEvents;
@@ -25,6 +27,22 @@ public void setId(Long id) {
         this.id = id;
     }
 
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
     public String getUrl() {
         return url;
     }