gitlab 4.12.0 → 4.20.1

data/lib/gitlab/client/groups.rb

@@ -24,9 +24,12 @@ class Gitlab::Client
     #   Gitlab.group(42)
     #
     # @param  [Integer] id The ID of a group.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :with_custom_attributes Include custom attributes in response (admins only)
+    # @option options [Boolean] :with_projects Include details about group projects (default: true)
     # @return [Gitlab::ObjectifiedHash]
-    def group(id)
-      get("/groups/#{url_encode id}")
+    def group(id, options = {})
+      get("/groups/#{url_encode id}", query: options)
     end
 
     # Creates a new group.
@@ -68,6 +71,55 @@ class Gitlab::Client
       get("/groups/#{url_encode id}/members", query: options)
     end
 
+    # Gets a list of all group members including inherited members.
+    #
+    # @example
+    #   Gitlab.all_group_members(1)
+    #   Gitlab.all_group_members(1, { per_page: 40 })
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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 all_group_members(id, options = {})
+      get("/groups/#{url_encode id}/members/all", query: options)
+    end
+
+    # Get a list of descendant groups of a group.
+    #
+    # @example
+    #   Gitlab.group_descendants(42)
+    #
+    # @param [Integer] id the ID of a group
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :skip_groups Skip the group IDs passed.
+    # @option options [String] :all_available Show all the groups you have access to (defaults to false for authenticated users).
+    # @option options [String] :search Return the list of authorized groups matching the search criteria.
+    # @option options [String] :order_by Order groups by name or path. Default is name.
+    # @option options [String] :sort Order groups in asc or desc order. Default is asc.
+    # @option options [String] :statistics Include group statistics (admins only).
+    # @option options [String] :owned Limit to groups owned by the current user.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all subgroups under a group
+    def group_descendants(id, options = {})
+      get("/groups/#{url_encode id}/descendant_groups", query: options)
+    end
+
+    # Get a list of group members that are billable.
+    #
+    # @example
+    #   Gitlab.group_billable_members(1)
+    #   Gitlab.group_billable_members(1, { per_page: 40 })
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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 group_billable_members(id, options = {})
+      get("/groups/#{url_encode id}/billable_members", query: options)
+    end
+
     # Get details of a single group member.
     #
     # @example
@@ -80,6 +132,18 @@ class Gitlab::Client
       get("/groups/#{url_encode team_id}/members/#{user_id}")
     end
 
+    # Gets a list of merge requests of a group.
+    #
+    # @example
+    #   Gitlab.group_merge_requests(5)
+    #
+    # @param  [Integer, String] group_id The ID or name of a group.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_merge_requests(group, options = {})
+      get("/groups/#{group}/merge_requests", query: options)
+    end
+
     # Adds a user to group.
     #
     # @example
@@ -203,5 +267,186 @@ class Gitlab::Client
     def group_issues(group, options = {})
       get("/groups/#{group}/issues", query: options)
     end
+
+    # Sync group with LDAP
+    #
+    # @example
+    #   Gitlab.sync_ldap_group(1)
+    #
+    # @param [Integer] id The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def sync_ldap_group(id)
+      post("/groups/#{url_encode id}/ldap_sync")
+    end
+
+    # Add LDAP group link
+    #
+    # @example
+    #   Gitlab.add_ldap_group_links(1, 'all', 50, 'ldap')
+    #
+    # @param  [Integer] id The ID of a group
+    # @param  [String] cn The CN of a LDAP group
+    # @param  [Integer] group_access Minimum access level for members of the LDAP group.
+    # @param  [String] provider LDAP provider for the LDAP group
+    # @return [Gitlab::ObjectifiedHash] Information about added ldap group link
+    def add_ldap_group_links(id, commonname, group_access, provider)
+      post("/groups/#{url_encode id}/ldap_group_links", body: { cn: commonname, group_access: group_access, provider: provider })
+    end
+
+    # Delete LDAP group link
+    #
+    # @example
+    #   Gitlab.delete_ldap_group_links(1, 'all')
+    #
+    # @param  [Integer] id The ID of a group
+    # @param  [String] cn The CN of a LDAP group
+    # @return [Gitlab::ObjectifiedHash] Empty hash
+    def delete_ldap_group_links(id, commonname, provider)
+      delete("/groups/#{url_encode id}/ldap_group_links/#{url_encode provider}/#{url_encode commonname}")
+    end
+
+    # Gets group custom_attributes.
+    #
+    # @example
+    #   Gitlab.group_custom_attributes(2)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_custom_attributes(group_id)
+      get("/groups/#{group_id}/custom_attributes")
+    end
+
+    # Gets single group custom_attribute.
+    #
+    # @example
+    #   Gitlab.group_custom_attribute('key', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_custom_attribute(key, group_id)
+      get("/groups/#{group_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_group_custom_attribute(key, value, group_id)
+      url = "/groups/#{group_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_group_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Boolean]
+    def delete_group_custom_attribute(key, group_id = nil)
+      delete("/groups/#{group_id}/custom_attributes/#{key}")
+    end
+
+    # List all the specified groups hooks
+    #
+    # @example
+    #   Gitlab.list_group_hooks(3)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @return [Gitlab::PaginatedResponse] List of registered hooks https://docs.gitlab.com/ee/api/groups.html#hooks
+    def list_group_hooks(group_id)
+      get("/groups/#{group_id}/hooks")
+    end
+
+    # get specified group hook
+    #
+    # @example
+    #   Gitlab.group_hook(3, 1)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of the hook.
+    # @return [Gitlab::ObjectifiedHash] The hook https://docs.gitlab.com/ee/api/groups.html#get-group-hook
+    def group_hook(group_id, hook_id)
+      get("/groups/#{group_id}/hooks/#{hook_id}")
+    end
+
+    # Add a new group hook
+    #
+    # @example
+    #   Gitlab.add_group_hook(3, "https://example.com/my-hook-receiver", {token: "verify me"})
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [String] the hook url which will receive the selected events
+    # @option options [Boolean] :name The name of the group.
+    # @option options [Boolean] :push_events Trigger hook on push events
+    # @potion options [String] :push_events_branch_filter	Trigger hook on push events for matching branches only.
+    # @option options [Boolean] :issues_events Trigger hook on issues events
+    # @option options [Boolean] :confidential_issues_events Trigger hook on confidential issues events
+    # @option options [Boolean] :merge_requests_events Trigger hook on merge requests events
+    # @option options [Boolean] :tag_push_events Trigger hook on tag push events
+    # @option options [Boolean] :note_events Trigger hook on note events
+    # @option options [Boolean] :confidential_note_events Trigger hook on confidential note events
+    # @option options [Boolean] :job_events Trigger hook on job events
+    # @option options [Boolean] :pipeline_events Trigger hook on pipeline events
+    # @option options [Boolean] :wiki_page_events Trigger hook on wiki page events
+    # @option options [Boolean] :deployment_events Trigger hook on deployment events
+    # @option options [Boolean] :releases_events Trigger hook on release events
+    # @option options [Boolean] :subgroup_events Trigger hook on subgroup events
+    # @option options [Boolean] :enable_ssl_verification Do SSL verification when triggering the hook
+    # @option options [String] :token	Secret token to validate received payloads; not returned in the response
+    # @return [Gitlab::ObjectifiedHash] Response body matches https://docs.gitlab.com/ee/api/groups.html#get-group-hook
+    def add_group_hook(group_id, url, options = {})
+      post("/groups/#{group_id}/hooks", body: options.merge(url: url))
+    end
+
+    # Edit a group hook
+    #
+    # @example
+    #   Gitlab.edit_group_hook(3, 1, "https://example.com/my-hook-receiver", {token: "verify me"})
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of a group.
+    # @param  [String] the hook url which will receive the selected events
+    # @option options [Boolean] :name The name of the group.
+    # @option options [Boolean] :push_events Trigger hook on push events
+    # @potion options [String] :push_events_branch_filter	Trigger hook on push events for matching branches only.
+    # @option options [Boolean] :issues_events Trigger hook on issues events
+    # @option options [Boolean] :confidential_issues_events Trigger hook on confidential issues events
+    # @option options [Boolean] :merge_requests_events Trigger hook on merge requests events
+    # @option options [Boolean] :tag_push_events Trigger hook on tag push events
+    # @option options [Boolean] :note_events Trigger hook on note events
+    # @option options [Boolean] :confidential_note_events Trigger hook on confidential note events
+    # @option options [Boolean] :job_events Trigger hook on job events
+    # @option options [Boolean] :pipeline_events Trigger hook on pipeline events
+    # @option options [Boolean] :wiki_page_events Trigger hook on wiki page events
+    # @option options [Boolean] :deployment_events Trigger hook on deployment events
+    # @option options [Boolean] :releases_events Trigger hook on release events
+    # @option options [Boolean] :subgroup_events Trigger hook on subgroup events
+    # @option options [Boolean] :enable_ssl_verification Do SSL verification when triggering the hook
+    # @option options [String] :token	Secret token to validate received payloads; not returned in the response
+    # @return [Gitlab::ObjectifiedHash] Response body matches https://docs.gitlab.com/ee/api/groups.html#edit-group-hook
+    def edit_group_hook(group_id, hook_id, url, options = {})
+      post("/groups/#{group_id}/hooks/#{hook_id}", body: options.merge(url: url))
+    end
+
+    # Delete a group hook
+    #
+    # @example
+    #   Gitlab.delete_group_hook(3, 1)
+    #
+    # @param  [Integer] group_id The ID of a group.
+    # @param  [Integer] hook_id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash] no body, will evaluate to an empty hash. https://docs.gitlab.com/ee/api/groups.html#delete-group-hook
+    def delete_group_hook(group_id, hook_id)
+      delete("/groups/#{group_id}/hooks/#{hook_id}")
+    end
   end
 end

data/lib/gitlab/client/issue_links.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to issue links.
+  # @see https://docs.gitlab.com/ee/api/issue_links.html
+  module IssueLinks
+    # Gets a list of links for a issue.
+    #
+    # @example
+    #   Gitlab.issue_links(5, 10)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_links(project, issue, options = {})
+      get("/projects/#{url_encode project}/issues/#{issue}/links", query: options)
+    end
+
+    # Creates a new issue link.
+    #
+    # @example
+    #   Gitlab.create_issue_link(6, 1, 6, 2)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue The ID of an issue.
+    # @param  [Integer] target_project_id Project ID the target issue is located in.
+    # @param  [Integer] target_issue_iid The ID of the target issue.
+    # @return [Gitlab::ObjectifiedHash] Information about created link.
+    def create_issue_link(project, issue, target_project_id, target_issue_iid)
+      post("/projects/#{url_encode project}/issues/#{issue}/links", body: { target_project_id: target_project_id, target_issue_iid: target_issue_iid })
+    end
+
+    # Deletes an issue link.
+    #
+    # @example
+    #   Gitlab.delete_issue_link(5, 10, 123)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a link.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_issue_link(project, issue, id)
+      delete("/projects/#{url_encode project}/issues/#{issue}/links/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/issues.rb

@@ -181,7 +181,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of an issue.
     # @param  [String] duration The time spent in human format. e.g: 3h30m
     def add_time_spent_on_issue(project, id, duration)
-      post("/projects/#{url_encode project}/issues/#{id}/add_spent_time", body: { duration: url_encode(duration) })
+      post("/projects/#{url_encode project}/issues/#{id}/add_spent_time", body: { duration: duration })
     end
 
     # Resets the total spent time for this issue to 0 seconds.
@@ -227,5 +227,16 @@ class Gitlab::Client
     def merge_requests_closing_issue_on_merge(project, id)
       get("/projects/#{url_encode project}/issues/#{id}/closed_by")
     end
+
+    # List related merge requests
+    #
+    # @example
+    #   Gitlab.related_merge_requests(3, 42)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] id The ID of an issue.
+    def related_merge_requests(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/related_merge_requests")
+    end
   end
 end

data/lib/gitlab/client/jobs.rb

@@ -36,6 +36,21 @@ class Gitlab::Client
       get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/jobs", query: options)
     end
 
+    # Gets a list of Bridge Jobs from a pipeline
+    #
+    # @example
+    #   Gitlab.pipeline_bridges(1, 2)
+    #   Gitlab.pipeline_bridges("project", 2)
+    #
+    # @param  [Integer, String] The ID or name of a project.
+    # @param  [Integer]  the id of the pipeline
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Array] :scope The scope of bridge jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all bridge jobs if none provided.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_bridges(project_id, pipeline_id, options = {})
+      get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/bridges", query: options)
+    end
+
     # Gets a single job
     #
     # @example
@@ -70,17 +85,71 @@ class Gitlab::Client
     #   Gitlab.job_artifacts_download(1, "master", "release")
     #   Gitlab.job_artifacts_download("project", "master", "release")
     #
-    # @param  [Integer, String] id, The ID or name of a project.
-    # @param  [String]  ref, Ref Name
-    # @param  [String]  job, jobname
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @param  [Integer, String] project_id The ID or name of a project.
+    # @param  [String]  ref Ref Name
+    # @param  [String]  job jobname
+    # @return [Gitlab::FileResponse]
     def job_artifacts_download(project_id, ref_name, job_name)
-      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download", query: { job: job_name },
-                                                                                    format: nil,
-                                                                                    headers: { Accept: 'text/plain' },
-                                                                                    parser: ::Gitlab::Request::Parser)
+      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download",
+          query: { job: job_name },
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          parser: proc { |body, _|
+                    if body.encoding == Encoding::ASCII_8BIT # binary response
+                      ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+                    else # error with json response
+                      ::Gitlab::Request.parse(body)
+                    end
+                  })
     end
 
+    # Download a single artifact file by job ID
+    #
+    # @example
+    #   Gitlab.download_job_artifact_file(1, 5, "some/release/file.pdf")
+    #
+    # @param  [Integer, String] project_id(required) The ID or name of a project.
+    # @param  [String]  job_id(required) The unique job identifier.
+    # @param  [String]  artifact_path(required) Path to a file inside the artifacts archive.
+    # @return [Gitlab::FileResponse]
+    def download_job_artifact_file(project_id, job_id, artifact_path)
+      get("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts/#{artifact_path}",
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          parser: proc { |body, _|
+                    if body.encoding == Encoding::ASCII_8BIT # binary response
+                      ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+                    else # error with json response
+                      ::Gitlab::Request.parse(body)
+                    end
+                  })
+    end
+
+    # Download a single artifact file from specific tag or branch
+    #
+    # @example
+    #   Gitlab.download_branch_artifact_file(1, "master", "some/release/file.pdf", 'pdf')
+    #
+    # @param  [Integer, String] project_id(required) The ID or name of a project.
+    # @param  [String]  ref_name(required) Branch or tag name in repository. HEAD or SHA references are not supported.
+    # @param  [String]  artifact_path(required) Path to a file inside the artifacts archive.
+    # @param  [String]  job(required) The name of the job.
+    # @return [Gitlab::FileResponse]
+    def download_branch_artifact_file(project_id, ref_name, artifact_path, job)
+      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/raw/#{artifact_path}",
+          query: { job: job },
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          parser: proc { |body, _|
+                    if body.encoding == Encoding::ASCII_8BIT # binary response
+                      ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+                    else # error with json response
+                      ::Gitlab::Request.parse(body)
+                    end
+                  })
+    end
+    alias download_tag_artifact_file download_branch_artifact_file
+
     # Get Job Trace
     #
     # @example
@@ -163,5 +232,19 @@ class Gitlab::Client
     def job_artifacts_keep(project_id, job_id)
       post("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts/keep")
     end
+
+    # Delete Artifacts
+    # Deletes the artifacts associated with a job.
+    #
+    # @example
+    #   Gitlab.job_artifacts_delete(1,1)
+    #   Gitlab.job_artifacts_delete("project", 1)
+    #
+    # @param  [Integer, String] The ID or name of a project.
+    # @param  [Integer]  the id of the job
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def job_artifacts_delete(project_id, job_id)
+      delete("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts")
+    end
   end
 end

data/lib/gitlab/client/keys.rb

@@ -14,5 +14,16 @@ class Gitlab::Client
     def key(id)
       get("/keys/#{id}")
     end
+
+    # Gets information about a key by key fingerprint.
+    #
+    # @example
+    #   Gitlab.key_by_fingerprint("9f:70:33:b3:50:4d:9a:a3:ef:ea:13:9b:87:0f:7f:7e")
+    #
+    # @param  [String] fingerprint The Fingerprint of a key.
+    # @return [Gitlab::ObjectifiedHash]
+    def key_by_fingerprint(fingerprint)
+      get('/keys', query: { fingerprint: fingerprint })
+    end
   end
 end

data/lib/gitlab/client/labels.rb

@@ -58,7 +58,7 @@ class Gitlab::Client
     # @param  [String] name The name of a label.
     # @return [Gitlab::ObjectifiedHash] Information about deleted label.
     def delete_label(project, name)
-      delete("/projects/#{url_encode project}/labels", body: { name: name })
+      delete("/projects/#{url_encode project}/labels/#{name}")
     end
 
     # Subscribes the user to a label to receive notifications