add get pipeline end point

Author: Crim

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

@@ -29,29 +29,35 @@
 import org.sourcelab.buildkite.api.client.request.DeleteAccessTokenRequest;
 import org.sourcelab.buildkite.api.client.request.GetAccessTokenRequest;
 import org.sourcelab.buildkite.api.client.request.GetMetaRequest;
+import org.sourcelab.buildkite.api.client.request.GetOrganizationRequest;
+import org.sourcelab.buildkite.api.client.request.GetPipelineRequest;
 import org.sourcelab.buildkite.api.client.request.GetUserRequest;
 import org.sourcelab.buildkite.api.client.request.ListBuildsRequest;
 import org.sourcelab.buildkite.api.client.request.ListEmojisRequest;
 import org.sourcelab.buildkite.api.client.request.ListOrganizationsRequest;
+import org.sourcelab.buildkite.api.client.request.ListPipelinesRequest;
 import org.sourcelab.buildkite.api.client.request.OrganizationFilters;
 import org.sourcelab.buildkite.api.client.request.OrganizationFiltersBuilder;
 import org.sourcelab.buildkite.api.client.request.PageOptions;
 import org.sourcelab.buildkite.api.client.request.PageableRequest;
 import org.sourcelab.buildkite.api.client.request.PingRequest;
+import org.sourcelab.buildkite.api.client.request.PipelineFiltersBuilder;
+import org.sourcelab.buildkite.api.client.request.PipelineFilters;
 import org.sourcelab.buildkite.api.client.request.Request;
 import org.sourcelab.buildkite.api.client.response.AccessTokenResponse;
 import org.sourcelab.buildkite.api.client.response.CurrentUserResponse;
 import org.sourcelab.buildkite.api.client.response.Emoji;
 import org.sourcelab.buildkite.api.client.response.ErrorResponse;
 import org.sourcelab.buildkite.api.client.response.ListBuildsResponse;
 import org.sourcelab.buildkite.api.client.response.ListOrganizationsResponse;
+import org.sourcelab.buildkite.api.client.response.ListPipelinesResponse;
 import org.sourcelab.buildkite.api.client.response.MetaResponse;
 import org.sourcelab.buildkite.api.client.response.Organization;
 import org.sourcelab.buildkite.api.client.response.PageableResponse;
 import org.sourcelab.buildkite.api.client.response.PagingLinks;
 import org.sourcelab.buildkite.api.client.response.PingResponse;
+import org.sourcelab.buildkite.api.client.response.Pipeline;
 import org.sourcelab.buildkite.api.client.response.parser.ErrorResponseParser;
-import org.sourcelab.buildkite.api.client.response.parser.ListOrganizationsResponseParser;
 
 import java.io.IOException;
 import java.util.List;
@@ -168,10 +174,67 @@ public ListOrganizationsResponse listOrganizations(final OrganizationFilters fil
      */
     public Optional<Organization> getOrganization(final String organizationSlugId) throws BuildkiteException {
         Objects.requireNonNull(organizationSlugId);
-        final ListOrganizationsResponse response = listOrganizations(OrganizationFilters.newBuilder()
-                .withOrganization(organizationSlugId)
+        final Organization response = executeRequest(new GetOrganizationRequest(organizationSlugId));
+        return Optional.ofNullable(response);
+    }
+
+    /**
+     * Retrieve all Pipeline accessible to the current user/API access token for the given Organization.
+     * Results will be paged.
+     *
+     * @param filters Filter criteria.
+     * @return All Pipelines accessible to the current user/API access token. Results
+     *         will be paged if the number of results exceeds 30.
+     * @throws BuildkiteException if API returns an error response.
+     */
+    public ListPipelinesResponse listPipelines(final PipelineFiltersBuilder filters) throws BuildkiteException {
+        Objects.requireNonNull(filters);
+        return listPipelines(filters.build());
+    }
+
+    /**
+     * Retrieve all Pipelines accessible to the current user/API access token for the given Organization.
+     * Results will be paged.
+     *
+     * @param filters Filter criteria.
+     * @return All Pipelines accessible to the current user/API access token. Results
+     *         will be paged if the number of results exceeds 30.
+     * @throws BuildkiteException if API returns an error response.
+     */
+    public ListPipelinesResponse listPipelines(final PipelineFilters filters) throws BuildkiteException {
+        Objects.requireNonNull(filters);
+        return executeRequest(new ListPipelinesRequest(filters));
+    }
+
+    /**
+     * Retrieve all Pipelines accessible to the current user/API access token for the given Organization.
+     * Results will be paged.
+     *
+     * @param organizationSlugId Organization Slug Id to retrieve pipelines for.
+     * @return All Pipelines accessible to the current user/API access token for the given Organization. Results
+     *         will be paged if the number of results exceeds 30.
+     * @throws BuildkiteException if API returns an error response.
+     */
+    public ListPipelinesResponse listPipelines(final String organizationSlugId) throws BuildkiteException {
+        Objects.requireNonNull(organizationSlugId);
+        return listPipelines(PipelineFilters.newBuilder()
+            .withOrganization(organizationSlugId)
         );
-        return response.getOrganizationBySlug(organizationSlugId);
+    }
+
+    /**
+     * Retrieve specific pipeline via its Organization and Pipeline Slug Ids.
+     *
+     * @param organizationSlugId Slug of the organization to retrieve.
+     * @param pipelineSlugId Slug of the pipeline to retrieve.
+     * @return Pipeline matching the slug, if found.
+     * @throws BuildkiteException if API returns an error response.
+     */
+    public Optional<Pipeline> getPipeline(final String organizationSlugId, final String pipelineSlugId) throws BuildkiteException {
+        Objects.requireNonNull(organizationSlugId);
+        Objects.requireNonNull(pipelineSlugId);
+        final Pipeline pipeline = executeRequest(new GetPipelineRequest(organizationSlugId, pipelineSlugId));
+        return Optional.ofNullable(pipeline);
     }
 
     /**

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

@@ -0,0 +1,47 @@
+/**
+ * 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.Organization;
+import org.sourcelab.buildkite.api.client.response.parser.GetOrganizationResponseParser;
+import org.sourcelab.buildkite.api.client.response.parser.ResponseParser;
+
+import java.util.Objects;
+
+public class GetOrganizationRequest extends GetRequest<Organization> {
+    private final String orgIdSlug;
+
+    /**
+     * Constructor.
+     * @param orgIdSlug Organization to retrieve.
+     */
+    public GetOrganizationRequest(final String orgIdSlug) {
+        Objects.requireNonNull(orgIdSlug);
+        this.orgIdSlug = orgIdSlug;
+    }
+
+    @Override
+    public String getPath() {
+        return "/v2/organizations/" + orgIdSlug;
+    }
+
+    @Override
+    public ResponseParser<Organization> getResponseParser() {
+        return new GetOrganizationResponseParser();
+    }
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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.Organization;
+import org.sourcelab.buildkite.api.client.response.Pipeline;
+import org.sourcelab.buildkite.api.client.response.parser.GetPipelineResponseParser;
+import org.sourcelab.buildkite.api.client.response.parser.ResponseParser;
+
+import java.util.Objects;
+
+public class GetPipelineRequest extends GetRequest<Pipeline> {
+    private final String orgIdSlug;
+    private final String pipelineIdSlug;
+
+    /**
+     * Constructor.
+     *
+     * @param orgIdSlug Organization to retrieve pipeline for.
+     * @param pipelineIdSlug Pipeline to retrieve.
+     */
+    public GetPipelineRequest(final String orgIdSlug, final String pipelineIdSlug) {
+        this.pipelineIdSlug = Objects.requireNonNull(pipelineIdSlug);
+        this.orgIdSlug = Objects.requireNonNull(orgIdSlug);;
+    }
+
+    @Override
+    public String getPath() {
+        return "/v2/organizations/" + orgIdSlug + "/pipelines/" + pipelineIdSlug;
+    }
+
+    @Override
+    public ResponseParser<Pipeline> getResponseParser() {
+        return new GetPipelineResponseParser();
+    }
+}

src/main/java/org/sourcelab/buildkite/api/client/request/ListPipelinesRequest.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.response.ListOrganizationsResponse;
+import org.sourcelab.buildkite.api.client.response.ListPipelinesResponse;
+import org.sourcelab.buildkite.api.client.response.parser.ListOrganizationsResponseParser;
+import org.sourcelab.buildkite.api.client.response.parser.ListPipelinesResponseParser;
+import org.sourcelab.buildkite.api.client.response.parser.ResponseParser;
+
+import java.util.Objects;
+
+public class ListPipelinesRequest extends GetRequest<ListPipelinesResponse> implements PageableRequest<ListPipelinesResponse> {
+    private final PipelineFilters filters;
+    private PageOptions pageOptions;
+
+    /**
+     * Constructor.
+     * @param filters Search Criteria.
+     */
+    public ListPipelinesRequest(final PipelineFilters filters) {
+        Objects.requireNonNull(filters);
+        this.filters = filters;
+        this.pageOptions = filters.getPageOptions() == null ? PageOptions.getDefault() : filters.getPageOptions();
+    }
+
+    @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";
+    }
+
+    @Override
+    public RequestParameters getRequestParameters() {
+        final RequestParametersBuilder builder = RequestParameters.newBuilder();
+
+        // Paging options
+        builder.withParameter("per_page", pageOptions.getPerPage());
+        builder.withParameter("page", pageOptions.getPage());
+
+        return builder.build();
+    }
+
+    @Override
+    public ResponseParser<ListPipelinesResponse> getResponseParser() {
+        return new ListPipelinesResponseParser(this);
+    }
+
+    @Override
+    public void updatePageOptions(final PageOptions pageOptions) {
+        this.pageOptions = Objects.requireNonNull(pageOptions);
+    }
+}

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

@@ -0,0 +1,78 @@
+/**
+ * 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;
+
+/**
+ * Optional Properties to filter Organizations.
+ */
+public class PipelineFilters implements Filters {
+    private final PageOptions pageOptions;
+    private final String orgIdSlug;
+    private final String pipelineIdSlug;
+
+    /**
+     * Builder for {@link PipelineFilters}.
+     * @return Builder for {@link PipelineFilters}.
+     */
+    public static PipelineFiltersBuilder newBuilder() {
+        return new PipelineFiltersBuilder();
+    }
+
+    /**
+     * Constructor.
+     * Use {@link BuildFiltersBuilder} to create instances.
+     */
+    public PipelineFilters(
+        final PageOptions pageOptions,
+        final String orgIdSlug,
+        final String pipelineIdSlug
+    ) {
+        this.pageOptions = pageOptions == null ? PageOptions.getDefault() : pageOptions;
+        this.orgIdSlug = orgIdSlug;
+        this.pipelineIdSlug = pipelineIdSlug;
+    }
+
+    public String getOrgIdSlug() {
+        return orgIdSlug;
+    }
+
+    public boolean hasOrgIdSlug() {
+        return orgIdSlug != null;
+    }
+
+    public String getPipelineIdSlug() {
+        return pipelineIdSlug;
+    }
+
+    public boolean hasPipelineIdSlug() {
+        return pipelineIdSlug != null;
+    }
+
+    public PageOptions getPageOptions() {
+        return pageOptions;
+    }
+
+    @Override
+    public String toString() {
+        return "PipelineFilters{"
+                + "pageOptions=" + pageOptions
+                + ", orgIdSlug='" + orgIdSlug + '\''
+                + ", pipelineIdSlug='" + pipelineIdSlug + '\''
+                + '}';
+    }
+}