fs-gitlab 4.18.1

data/lib/gitlab/client/pipelines.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to pipelines.
+  # @see https://docs.gitlab.com/ce/api/pipelines.html
+  module Pipelines
+    # Gets a list of project pipelines.
+    #
+    # @example
+    #   Gitlab.pipelines(5)
+    #   Gitlab.pipelines(5, { per_page: 10, page:  2 })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipelines(project, options = {})
+      get("/projects/#{url_encode project}/pipelines", query: options)
+    end
+
+    # Gets a single pipeline.
+    #
+    # @example
+    #   Gitlab.pipeline(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline(project, id)
+      get("/projects/#{url_encode project}/pipelines/#{id}")
+    end
+
+    # Gets a single pipeline's test report.
+    #
+    # @example
+    #   Gitlab.pipeline_test_report(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline_test_report(project, id)
+      get("/projects/#{url_encode project}/pipelines/#{id}/test_report")
+    end
+
+    # Create a pipeline.
+    #
+    # @example
+    #   Gitlab.create_pipeline(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] ref Reference to commit.
+    # @param  [Hash] variables Variables passed to pipelines
+    # @return [Gitlab::ObjectifiedHash] The pipelines changes.
+    def create_pipeline(project, ref, variables = {})
+      body = {}
+
+      # This mapping is necessary, cause the API expects an array with objects (with `key` and `value` keys)
+      # See: https://docs.gitlab.com/ee/api/pipelines.html#create-a-new-pipeline
+      body[:variables] = variables.map { |(key, value)| { key: key, value: value } } if variables.any?
+
+      post(
+        "/projects/#{url_encode project}/pipeline",
+        query: { ref: ref },
+        body: body
+      )
+    end
+
+    # Cancels a pipeline.
+    #
+    # @example
+    #   Gitlab.cancel_pipeline(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Gitlab::ObjectifiedHash] The pipelines changes.
+    def cancel_pipeline(project, id)
+      post("/projects/#{url_encode project}/pipelines/#{id}/cancel")
+    end
+
+    # Retry a pipeline.
+    #
+    # @example
+    #   Gitlab.retry_pipeline(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [Array<Gitlab::ObjectifiedHash>] The pipelines changes.
+    def retry_pipeline(project, id)
+      post("/projects/#{url_encode project}/pipelines/#{id}/retry")
+    end
+
+    # Delete a pipeline
+    #
+    # @example
+    #   Gitlab.delete_pipeline(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a pipeline.
+    # @return [void] This API call returns an empty response body.
+    def delete_pipeline(project, id)
+      delete("/projects/#{url_encode project}/pipelines/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/project_badges.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project badges.
+  # @see https://docs.gitlab.com/ee/api/project_badges.html
+  module ProjectBadges
+    # Gets a list of a projects badges and its group badges.
+    #
+    # @example
+    #   Gitlab.project_badges(5)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all badges of a project
+    def project_badges(project)
+      get("/projects/#{url_encode project}/badges")
+    end
+
+    # Gets a badge of a project.
+    #
+    # @example
+    #   Gitlab.project_badge(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @return [Gitlab::ObjectifiedHash] Information about the requested badge
+    def project_badge(project, badge_id)
+      get("/projects/#{url_encode project}/badges/#{badge_id}")
+    end
+
+    # Adds a badge to a project.
+    #
+    # @example
+    #   Gitlab.add_project_badge(5, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :link_url(required) URL of the badge link
+    # @option options [String] :image_url(required) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the added project badge.
+    def add_project_badge(project, options = {})
+      post("/projects/#{url_encode project}/badges", body: options)
+    end
+
+    # Updates a badge of a project..
+    #
+    # @example
+    #   Gitlab.edit_project_badge(5, 1, { link_url: 'https://abc.com/gitlab/gitlab-ce/commits/master', image_url: 'https://shields.io/my/badge1' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :link_url(optional) URL of the badge link
+    # @option options [String] :image_url(optional) URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Information about the updated project badge.
+    def edit_project_badge(project, badge_id, options = {})
+      put("/projects/#{url_encode project}/badges/#{badge_id}", body: options)
+    end
+
+    # Removes a badge from a project. Only projects badges will be removed by using this endpoint.
+    #
+    # @example
+    #   Gitlab.remove_project_badge(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] badge_id The badge ID.
+    # @return [nil] This API call returns an empty response body.
+    def remove_project_badge(project, badge_id)
+      delete("/projects/#{url_encode project}/badges/#{badge_id}")
+    end
+
+    # Preview a badge from a project.
+    #
+    # @example
+    #   Gitlab.preview_project_badge(3, 'https://abc.com/gitlab/gitlab-ce/commits/master', 'https://shields.io/my/badge1')
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] :link_url URL of the badge link
+    # @param [String] :image_url URL of the badge image
+    # @return [Gitlab::ObjectifiedHash] Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.
+    def preview_project_badge(project, link_url, image_url)
+      query = { link_url: link_url, image_url: image_url }
+      get("/projects/#{url_encode project}/badges/render", query: query)
+    end
+  end
+end

data/lib/gitlab/client/project_clusters.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project clusters.
+  # @see https://docs.gitlab.com/ce/api/project_clusters.html
+  module ProjectClusters
+    # Returns a list of project clusters.
+    #
+    # @example
+    #   Gitlab.project_clusters(5)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all clusters of a project
+    def project_clusters(project)
+      get("/projects/#{url_encode project}/clusters")
+    end
+
+    # Gets a single project cluster.
+    #
+    # @example
+    #   Gitlab.project_cluster(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] cluster_id  The ID of the cluster.
+    # @return [Gitlab::ObjectifiedHash] Information about the requested cluster
+    def project_cluster(project, cluster_id)
+      get("/projects/#{url_encode project}/clusters/#{cluster_id}")
+    end
+
+    # Adds an existing Kubernetes cluster to the project.
+    #
+    # @example
+    #   Gitlab.add_project_cluster(5, 'cluster-5', { enabled: false, platform_kubernetes_attributes: { api_url: 'https://35.111.51.20', token: '12345', ca_cert: "-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----", namespace: 'cluster-5-namespace', authorization_type: 'rbac' } })
+    #   Gitlab.add_project_cluster(5, 'cluster-5', { platform_kubernetes_attributes: { api_url: 'https://35.111.51.20', token: '12345' } })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] name  The name of the existing cluster.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :enabled(optional)  Determines if cluster is active or not, defaults to true
+    # @option options [Hash] :platform_kubernetes_attributes A customizable set of Kubernetes platform attributes
+    # @suboption platform_kubernetes_attributes [String] :api_url(required)  The URL to access the Kubernetes API
+    # @suboption platform_kubernetes_attributes [String] :token(required)  The token to authenticate against Kubernetes
+    # @suboption platform_kubernetes_attributes [String] :ca_cert(optional)   TLS certificate (needed if API is using a self-signed TLS certificate
+    # @suboption platform_kubernetes_attributes [String] :namespace(optional)   The unique namespace related to the project
+    # @suboption platform_kubernetes_attributes [String] :authorization_type(optional)  The cluster authorization type: rbac, abac or unknown_authorization. Defaults to rbac.
+    # @return [Gitlab::ObjectifiedHash] Information about the added project cluster.
+    def add_project_cluster(project, name, options = {})
+      body = { name: name }.merge(options)
+      post("/projects/#{url_encode project}/clusters/user", body: body)
+    end
+
+    # Updates an existing project cluster.
+    #
+    # @example
+    #   Gitlab.edit_project_cluster(5, 1, { name: 'cluster-6', platform_kubernetes_attributes: { api_url: 'https://35.111.51.20', token: '12345', ca_cert: "-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----", namespace: 'cluster-6-namespace' } })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] cluster_id  The ID of the cluster.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name(optional) The name of the cluster
+    # @option options [Hash] :platform_kubernetes_attributes A customizable set of Kubernetes platform attributes
+    # @suboption platform_kubernetes_attributes [String] :api_url(required)  The URL to access the Kubernetes API
+    # @suboption platform_kubernetes_attributes [String] :token(required)  The token to authenticate against Kubernetes
+    # @suboption platform_kubernetes_attributes [String] :ca_cert(optional)   TLS certificate (needed if API is using a self-signed TLS certificate
+    # @suboption platform_kubernetes_attributes [String] :namespace(optional)   The unique namespace related to the project
+    # @return [Gitlab::ObjectifiedHash] Information about the updated project cluster.
+    def edit_project_cluster(project, cluster_id, options = {})
+      put("/projects/#{url_encode project}/clusters/#{cluster_id}", body: options)
+    end
+
+    # Deletes an existing project cluster.
+    #
+    # @example
+    #   Gitlab.delete_project_cluster(5, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] cluster_id The ID of the cluster.
+    # @return [nil] This API call returns an empty response body.
+    def delete_project_cluster(project, cluster_id)
+      delete("/projects/#{url_encode project}/clusters/#{cluster_id}")
+    end
+  end
+end

data/lib/gitlab/client/project_release_links.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project release links.
+  # @see https://docs.gitlab.com/ce/api/releases/links.html
+  module ProjectReleaseLinks
+    # Get assets as links from a Release.
+    #
+    # @example
+    #   Gitlab.project_release_links(5, 'v0.3')
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name The tag associated with the Release.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of assets as links from a Release.
+    def project_release_links(project, tag_name)
+      get("/projects/#{url_encode project}/releases/#{tag_name}/assets/links")
+    end
+
+    # Get an asset as link from a Release.
+    #
+    # @example
+    #   Gitlab.project_release_link(5, 'v0.3', 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name The tag associated with the Release.
+    # @param [Integer] link_id The id of the link.
+    # @return [Gitlab::ObjectifiedHash] Information about the release link
+    def project_release_link(project, tag_name, link_id)
+      get("/projects/#{url_encode project}/releases/#{tag_name}/assets/links/#{link_id}")
+    end
+
+    # Create an asset as a link from a Release.
+    #
+    # @example
+    #   Gitlab.create_project_release_link(5, 'v0.1', { name: 'awesome-v0.2.dmg', url: 'http://192.168.10.15:3000' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name The tag associated with the Release.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name(required)  The name of the link.
+    # @option options [String] :url(required)  The URL of the link.
+    # @return [Gitlab::ObjectifiedHash] Information about the created release link.
+    def create_project_release_link(project, tag_name, options = {})
+      post("/projects/#{url_encode project}/releases/#{tag_name}/assets/links", body: options)
+    end
+
+    # Update an asset as a link from a Release. You have to specify at least one of name or url
+    #
+    # @example
+    #   Gitlab.update_project_release_link(5, 'v0.3', 1, { name: 'awesome-v0.2.dmg', url: 'http://192.168.10.15:3000' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name  The tag where the release will be created from.
+    # @param [Integer] link_id The id of the link.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name(optional)  The name of the link.
+    # @option options [String] :url(optional)  The URL of the link.
+    # @return [Gitlab::ObjectifiedHash] Information about the updated release link.
+    def update_project_release_link(project, tag_name, link_id, options = {})
+      put("/projects/#{url_encode project}/releases/#{tag_name}/assets/links/#{link_id}", body: options)
+    end
+
+    # Delete an asset as a link from a Release.
+    #
+    # @example
+    #   Gitlab.delete_project_release_link(5, 'v0.3', 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name  The tag where the release will be created from.
+    # @param [Integer] link_id The id of the link.
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted release link.
+    def delete_project_release_link(project, tag_name, link_id)
+      delete("/projects/#{url_encode project}/releases/#{tag_name}/assets/links/#{link_id}")
+    end
+  end
+end

data/lib/gitlab/client/project_releases.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to project releases.
+  # @see https://docs.gitlab.com/ce/api/releases/
+  module ProjectReleases
+    # Returns Paginated list of a project's releases, sorted by created_at.
+    #
+    # @example
+    #   Gitlab.project_releases(5)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] Paginated list of Releases, sorted by created_at.
+    def project_releases(project)
+      get("/projects/#{url_encode project}/releases")
+    end
+
+    # Gets a Release by a tag name
+    #
+    # @example
+    #   Gitlab.project_release(5, 'v0.1')
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name  The tag where the release will be created from..
+    # @return [Gitlab::ObjectifiedHash] Information about the release
+    def project_release(project, tag_name)
+      get("/projects/#{url_encode project}/releases/#{tag_name}")
+    end
+
+    # Creates a Release. You need push access to the repository to create a Release.
+    #
+    # @example
+    #   Gitlab.create_project_release(5, { name: 'New Release', tag_name: 'v0.3', description: 'Super nice release' })
+    #   Gitlab.create_project_release(5, { name: 'New Release', tag_name: 'v0.3', description: 'Super nice release', assets: { links: [{ name: 'hoge', url: 'https://google.com' }] } })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name(required)  The release name.
+    # @option options [String] :tag_name(required)  The tag where the release will be created from.
+    # @option options [String] :description(required)  The description of the release. You can use markdown.
+    # @option options [String] :ref(optional)  If tag_name does not exist, the release will be created from ref. It can be a commit SHA, another tag name, or a branch name.
+    # @option options [Hash] :assets(optional) A customizable set of options for release assets
+    # @asset assets [Array<link>] :links(optional)  An array of assets links as hashes.
+    # @link links [Hash] link_elements A combination of a link name and a link url
+    # @link_element [String] :name The name of the link.
+    # @link_element [String] :url The url of the link.
+    # @return [Gitlab::ObjectifiedHash] Information about the created release.
+    def create_project_release(project, options = {})
+      post("/projects/#{url_encode project}/releases", body: options)
+    end
+
+    # Updates a release.
+    #
+    # @example
+    #   Gitlab.update_project_release(5, 'v0.3', { name: 'New Release', description: 'Super nice release' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name  The tag where the release will be created from.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name(optional)  The release name.
+    # @option options [String] :description(optional)  The description of the release. You can use markdown.
+    # @return [Gitlab::ObjectifiedHash] Information about the updated release.
+    def update_project_release(project, tag_name, options = {})
+      put("/projects/#{url_encode project}/releases/#{tag_name}", body: options)
+    end
+
+    # Delete a Release. Deleting a Release will not delete the associated tag.
+    #
+    # @example
+    #   Gitlab.delete_project_release(5, 'v0.3')
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [String] tag_name  The tag where the release will be created from.
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted release.
+    def delete_project_release(project, tag_name)
+      delete("/projects/#{url_encode project}/releases/#{tag_name}")
+    end
+  end
+end