add more end points

Author: Crim

src/main/java/org/sourcelab/buildkite/api/client/BuildkiteClient.java

@@ -19,15 +19,23 @@
 
 import org.sourcelab.buildkite.api.client.request.Request;
 
+import java.io.Closeable;
+
 /**
  * Abstraction around underlying Http Client library.  Allows for replacing the
  * underlying library in the future if needed.
  */
-public interface Client {
+public interface Client extends Closeable {
     /**
      * Execute the supplied request and return the server's response.
      * @param request The request to execute.
-     * @return The servers response.
+     * @return The API response.
+     */
+    HttpResult executeRequest(final Request<?> request);
+
+    /**
+     * Close the Client implementation and release any resources it
+     * may have open.
      */
-    HttpResult executeRequest(final Request request);
+    void close();
 }

src/main/java/org/sourcelab/buildkite/api/client/http/Client.java

@@ -98,11 +98,16 @@ public HttpResult executeRequest(final Request request) {
                 default:
                     throw new IllegalArgumentException("Invalid HttpType: " + request.getMethod());
             }
-        } catch (IOException e) {
-            throw new RuntimeException(e);
+        } catch (final IOException ioException) {
+            throw new HttpRequestException(ioException.getMessage(), ioException);
         }
     }
 
+    @Override
+    public void close() {
+        // Not required in this implementation.
+    }
+
     private HttpResult executePostRequest(final Request request, final CloseableHttpClient httpClient) {
         try {
             final HttpPost httpPost = new HttpPost(generateRequestUri(request));

src/main/java/org/sourcelab/buildkite/api/client/http/HttpComponentsClient.java

@@ -39,10 +39,6 @@ public ListPipelinesRequest(final PipelineFilters filters) {
 
     @Override
     public String getPath() {
-        // TODO need to urlencode these?
-        if (filters.hasPipelineIdSlug()) {
-            return "/v2/organizations/" + filters.getOrgIdSlug() + "/pipelines/" + filters.getPipelineIdSlug();
-        }
         return "/v2/organizations/" + filters.getOrgIdSlug() + "/pipelines";
     }
 

src/main/java/org/sourcelab/buildkite/api/client/request/ListPipelinesRequest.java

@@ -23,7 +23,6 @@
 public class PipelineFilters implements Filters {
     private final PageOptions pageOptions;
     private final String orgIdSlug;
-    private final String pipelineIdSlug;
 
     /**
      * Builder for {@link PipelineFilters}.
@@ -39,12 +38,10 @@ public static PipelineFiltersBuilder newBuilder() {
      */
     public PipelineFilters(
         final PageOptions pageOptions,
-        final String orgIdSlug,
-        final String pipelineIdSlug
+        final String orgIdSlug
     ) {
         this.pageOptions = pageOptions == null ? PageOptions.getDefault() : pageOptions;
         this.orgIdSlug = orgIdSlug;
-        this.pipelineIdSlug = pipelineIdSlug;
     }
 
     public String getOrgIdSlug() {
@@ -55,14 +52,6 @@ public boolean hasOrgIdSlug() {
         return orgIdSlug != null;
     }
 
-    public String getPipelineIdSlug() {
-        return pipelineIdSlug;
-    }
-
-    public boolean hasPipelineIdSlug() {
-        return pipelineIdSlug != null;
-    }
-
     public PageOptions getPageOptions() {
         return pageOptions;
     }
@@ -72,7 +61,6 @@ public String toString() {
         return "PipelineFilters{"
                 + "pageOptions=" + pageOptions
                 + ", orgIdSlug='" + orgIdSlug + '\''
-                + ", pipelineIdSlug='" + pipelineIdSlug + '\''
                 + '}';
     }
 }

src/main/java/org/sourcelab/buildkite/api/client/request/PipelineFilters.java

@@ -25,7 +25,6 @@
 public final class PipelineFiltersBuilder {
     private PageOptions pageOptions = null;
     private String orgIdSlug = null;
-    private String pipelineIdSlug;
 
     /**
      * Constructor.
@@ -87,38 +86,20 @@ public PipelineFiltersBuilder withOrganization(final String orgIdSlug) {
         return this;
     }
 
-    /**
-     * Filter by the given Organization and Pipeline.
-     * @param orgIdSlug Organization to filter by.
-     * @param pipelineIdSlug Pipeline to filter by.
-     * @return PipelineFIltersBuilder for method chaining.
-     */
-    public PipelineFiltersBuilder withPipeline(final String orgIdSlug, final String pipelineIdSlug) {
-        withOrganization(orgIdSlug);
-        this.pipelineIdSlug = pipelineIdSlug;
-        return this;
-    }
-
     /**
      * New OrganizationFilters instance using configured properties.
      * @return New OrganizationFilters instance using configured properties.
      * @throws BuilderValidationException if not valid or complete.
      */
     public PipelineFilters build() {
         // Validation
-        if (pipelineIdSlug != null) {
-            if (orgIdSlug == null) {
-                throw new BuilderValidationException("If Pipeline is provided, then Organization must be provided.");
-            }
-        }
         if (orgIdSlug == null) {
             throw new BuilderValidationException("Organization must be provided.");
         }
 
         return new PipelineFilters(
             pageOptions,
-            orgIdSlug,
-            pipelineIdSlug
+            orgIdSlug
         );
     }
 }

src/main/java/org/sourcelab/buildkite/api/client/request/PipelineFiltersBuilder.java

@@ -100,6 +100,14 @@ public RequestParameter getParameterByName(final String name) {
         return parameters.get(name);
     }
 
+    /**
+     * Total number of request parameters contained.
+     * @return Total number of request parameters contained.
+     */
+    public int size() {
+        return getParameters().size();
+    }
+
     @Override
     public String toString() {
         return "RequestParameters{"

src/main/java/org/sourcelab/buildkite/api/client/request/RequestParameters.java

@@ -0,0 +1,72 @@
+/**
+ * Copyright 2023 SourceLab.org https://github.com/SourceLabOrg/Buildkite-Api-Client
+ *
+ * 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.sourcelab.buildkite.api.client.request;
+
+/**
+ * Options for Retrying a Job.
+ */
+public class RetryJobOptions {
+    private final String organizationSlug;
+    private final String pipelineSlug;
+    private final long buildNumber;
+    private final String jobId;
+
+    /**
+     * Builder instance for {@link RetryJobOptions}.
+     * @return Builder instance for {@link RetryJobOptions}.
+     */
+    public static RetryJobOptionsBuilder newBuilder() {
+        return new RetryJobOptionsBuilder();
+    }
+
+    /**
+     * Constructor.
+     */
+    public RetryJobOptions(final String organizationSlug, final String pipelineIdSlug, final long buildNumber, final String jobId) {
+        this.organizationSlug = organizationSlug;
+        this.pipelineSlug = pipelineIdSlug;
+        this.buildNumber = buildNumber;
+        this.jobId = jobId;
+    }
+
+    public String getOrganizationSlug() {
+        return organizationSlug;
+    }
+
+    public String getPipelineSlug() {
+        return pipelineSlug;
+    }
+
+    public long getBuildNumber() {
+        return buildNumber;
+    }
+
+    public String getJobId() {
+        return jobId;
+    }
+
+    @Override
+    public String toString() {
+        return "RetryJobOptions{"
+            + "orgIdSlug='" + organizationSlug + '\''
+            + ", pipelineIdSlug='" + pipelineSlug + '\''
+            + ", buildNumber=" + buildNumber
+            + ", jobId='" + jobId + '\''
+            + '}';
+    }
+}

src/main/java/org/sourcelab/buildkite/api/client/request/RetryJobOptions.java

@@ -0,0 +1,71 @@
+/**
+ * Copyright 2023 SourceLab.org https://github.com/SourceLabOrg/Buildkite-Api-Client
+ *
+ * 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.sourcelab.buildkite.api.client.request;
+
+import org.sourcelab.buildkite.api.client.exception.BuilderValidationException;
+
+public final class RetryJobOptionsBuilder {
+    private String organizationSlug = null;
+    private String pipelineSlug = null;
+    private Long buildNumber = null;
+    private String jobId = null;
+
+    public RetryJobOptionsBuilder() {
+    }
+
+    public RetryJobOptionsBuilder withOrganizationSlug(final String organizationSlug) {
+        this.organizationSlug = organizationSlug;
+        return this;
+    }
+
+    public RetryJobOptionsBuilder withPipelineSlug(final String pipelineSlug) {
+        this.pipelineSlug = pipelineSlug;
+        return this;
+    }
+
+    public RetryJobOptionsBuilder withBuildNumber(long buildNumber) {
+        this.buildNumber = buildNumber;
+        return this;
+    }
+
+    public RetryJobOptionsBuilder withJobId(final String jobId) {
+        this.jobId = jobId;
+        return this;
+    }
+
+    /**
+     * Create new {@link RetryJobOptions} instance.
+     * @return Create new {@link RetryJobOptions} instance.
+     */
+    public RetryJobOptions build() {
+        // Validation
+        if (organizationSlug == null) {
+            throw new BuilderValidationException("Organization must be provided.");
+        }
+        if (pipelineSlug == null) {
+            throw new BuilderValidationException("Pipeline must be provided.");
+        }
+        if (buildNumber == null) {
+            throw new BuilderValidationException("BuildNumber must be provided.");
+        }
+        if (jobId == null) {
+            throw new BuilderValidationException("JobId must be provided.");
+        }
+        return new RetryJobOptions(organizationSlug, pipelineSlug, buildNumber, jobId);
+    }
+}

src/main/java/org/sourcelab/buildkite/api/client/request/RetryJobOptionsBuilder.java

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2023 SourceLab.org https://github.com/SourceLabOrg/Buildkite-Api-Client
+ *
+ * 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.sourcelab.buildkite.api.client.request;
+
+import org.sourcelab.buildkite.api.client.response.Job;
+import org.sourcelab.buildkite.api.client.response.parser.GetJobResponseParser;
+import org.sourcelab.buildkite.api.client.response.parser.ResponseParser;
+
+import java.util.Objects;
+
+public class RetryJobRequest extends PutRequest<Job> {
+    private final RetryJobOptions options;
+
+    /**
+     * Constructor.
+     */
+    public RetryJobRequest(final RetryJobOptions options) {
+        this.options = Objects.requireNonNull(options);
+    }
+
+    @Override
+    public String getPath() {
+        return "/v2/organizations/" + options.getOrganizationSlug()
+            + "/pipelines/" + options.getPipelineSlug()
+            + "/builds/" + options.getBuildNumber()
+            + "/jobs/" + options.getJobId() + "/retry";
+
+    }
+
+    @Override
+    public ResponseParser<Job> getResponseParser() {
+        return new GetJobResponseParser();
+    }
+}