fs-gitlab 4.18.1

data/lib/gitlab/client/groups.rb

@@ -0,0 +1,358 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to groups.
+  # @see https://docs.gitlab.com/ce/api/groups.html
+  module Groups
+    # Gets a list of groups.
+    #
+    # @example
+    #   Gitlab.groups
+    #   Gitlab.groups({ per_page: 40, page: 2 })
+    #
+    # @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 groups(options = {})
+      get('/groups', query: options)
+    end
+
+    # Gets a single group.
+    #
+    # @example
+    #   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, options = {})
+      get("/groups/#{url_encode id}", query: options)
+    end
+
+    # Creates a new group.
+    #
+    # @example
+    #   Gitlab.create_group('new-group', 'group-path')
+    #   Gitlab.create_group('gitlab', 'gitlab-path', { description: 'New Gitlab project' })
+    #
+    # @param  [String] name The name of a group.
+    # @param  [String] path The path of a group.
+    # @return [Gitlab::ObjectifiedHash] Information about created group.
+    def create_group(name, path, options = {})
+      body = { name: name, path: path }.merge(options)
+      post('/groups', body: body)
+    end
+
+    # Delete's a group.
+    #
+    # @example
+    #   Gitlab.delete_group(42)
+    # @param  [Integer] id The ID of a group
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted group.
+    def delete_group(id)
+      delete("/groups/#{url_encode id}")
+    end
+
+    # Get a list of group members.
+    #
+    # @example
+    #   Gitlab.group_members(1)
+    #   Gitlab.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 group_members(id, options = {})
+      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
+    #   Gitlab.group_member(1, 10)
+    #
+    # @param  [Integer] team_id The ID of the group to find a member in.
+    # @param  [Integer] user_id The user id of the member to find.
+    # @return [Gitlab::ObjectifiedHash] (id, username, name, email, state, access_level ...)
+    def group_member(team_id, user_id)
+      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
+    #   Gitlab.add_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id to add a member to.
+    # @param  [Integer] user_id The user id of the user to add to the team.
+    # @param  [Integer] access_level Project access level.
+    # @return [Gitlab::ObjectifiedHash] Information about added team member.
+    def add_group_member(team_id, user_id, access_level)
+      post("/groups/#{url_encode team_id}/members", body: { user_id: user_id, access_level: access_level })
+    end
+
+    # Edit a user of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id of member to edit.
+    # @param  [Integer] user_id The user id of the user to edit.
+    # @param  [Integer] access_level Project access level.
+    # @return [Gitlab::ObjectifiedHash] Information about edited team member.
+    def edit_group_member(team_id, user_id, access_level)
+      put("/groups/#{url_encode team_id}/members/#{user_id}", body: { access_level: access_level })
+    end
+
+    # Removes user from user group.
+    #
+    # @example
+    #   Gitlab.remove_group_member(1, 2)
+    #
+    # @param  [Integer] team_id The group ID.
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash] Information about removed team member.
+    def remove_group_member(team_id, user_id)
+      delete("/groups/#{url_encode team_id}/members/#{user_id}")
+    end
+
+    # Transfers a project to a group
+    #
+    # @example
+    #   Gitlab.transfer_project_to_group(3, 50)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @param  [Integer] project_id The ID of a project.
+    def transfer_project_to_group(id, project_id)
+      body = { id: id, project_id: project_id }
+      post("/groups/#{url_encode id}/projects/#{project_id}", body: body)
+    end
+
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.group_search('gitlab')
+    #
+    # @param  [String] search A string to search for in group names and paths.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_search(search, options = {})
+      options[:search] = search
+      get('/groups', query: options)
+    end
+
+    # Get a list of projects under a group
+    # @example
+    #   Gitlab.group_projects(1)
+    #
+    # @param [Integer] id The ID of a group
+    # @return [Array<Gitlab::ObjectifiedHash>] List of projects under a group
+    def group_projects(id, options = {})
+      get("/groups/#{url_encode id}/projects", query: options)
+    end
+
+    # Get a list of subgroups under a group
+    # @example
+    #   Gitlab.group_subgroups(1)
+    #
+    # @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 subgroups under a group
+    def group_subgroups(id, options = {})
+      get("/groups/#{url_encode id}/subgroups", query: options)
+    end
+
+    # Updates an existing group.
+    #
+    # @example
+    #   Gitlab.edit_group(42)
+    #   Gitlab.edit_group(42, { name: 'Group Name' })
+    #
+    # @param  [Integer] group The ID.
+    # @param  [Hash] options A customizable set of options
+    # @option options [String] :name The name of the group.
+    # @option options [String] :path The path of the group.
+    # @option options [String] :description The description of the group.
+    # @option options [String] :visibility The visibility level of the group. Can be private, internal, or public
+    # @option options [String] :lfs_enabled Enable/disable Large File Storage (LFS) for the projects in this groupr.
+    # @option options [String] :request_access_enabled Allow users to request member access.
+    # @return [Gitlab::ObjectifiedHash] Information about the edited group.
+    def edit_group(id, options = {})
+      put("/groups/#{url_encode id}", body: options)
+    end
+
+    # Gets a list of issues of a group.
+    #
+    # @example
+    #   Gitlab.group_issues(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_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
+  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

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to issues.
+  # @see https://docs.gitlab.com/ce/api/issues.html
+  module Issues
+    # Gets a list of user's issues.
+    # Will return a list of project's issues if project ID passed.
+    #
+    # @example
+    #   Gitlab.issues
+    #   Gitlab.issues(5)
+    #   Gitlab.issues({ per_page: 40 })
+    #
+    # @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 issues(project = nil, options = {})
+      if project.to_s.empty? && project.to_i.zero?
+        get('/issues', query: options)
+      else
+        get("/projects/#{url_encode project}/issues", query: options)
+      end
+    end
+
+    # Gets a single issue.
+    #
+    # @example
+    #   Gitlab.issue(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash]
+    def issue(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}")
+    end
+
+    # Creates a new issue.
+    #
+    # @example
+    #   Gitlab.create_issue(5, 'New issue')
+    #   Gitlab.create_issue(5, 'New issue', { description: 'This is a new issue', assignee_id: 42 })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] title The title of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @option options [String] :labels Comma-separated label names for an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about created issue.
+    def create_issue(project, title, options = {})
+      body = { title: title }.merge(options)
+      post("/projects/#{url_encode project}/issues", body: body)
+    end
+
+    # Updates an issue.
+    #
+    # @example
+    #   Gitlab.edit_issue(6, 1, { title: 'Updated title' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of an issue.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @option options [String] :labels Comma-separated label names for an issue.
+    # @option options [String] :state_event The state event of an issue ('close' or 'reopen').
+    # @return [Gitlab::ObjectifiedHash] Information about updated issue.
+    def edit_issue(project, id, options = {})
+      put("/projects/#{url_encode project}/issues/#{id}", body: options)
+    end
+
+    # Closes an issue.
+    #
+    # @example
+    #   Gitlab.close_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about closed issue.
+    def close_issue(project, id)
+      put("/projects/#{url_encode project}/issues/#{id}", body: { state_event: 'close' })
+    end
+
+    # Reopens an issue.
+    #
+    # @example
+    #   Gitlab.reopen_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
+    def reopen_issue(project, id)
+      put("/projects/#{url_encode project}/issues/#{id}", body: { state_event: 'reopen' })
+    end
+
+    # Subscribe to an issue.
+    #
+    # @example
+    #   Gitlab.subscribe_to_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about subscribed issue.
+    def subscribe_to_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/subscribe")
+    end
+
+    # Unsubscribe from an issue.
+    #
+    # @example
+    #   Gitlab.unsubscribe_from_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about unsubscribed issue.
+    def unsubscribe_from_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/unsubscribe")
+    end
+
+    # Deletes  an issue.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted issue.
+    def delete_issue(project, id)
+      delete("/projects/#{url_encode project}/issues/#{id}")
+    end
+
+    # Move an issue.
+    #
+    # @example
+    #   Gitlab.move_issue(3, 42, { to_project_id: '4' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @option options [String] :to_project_id The ID of the new project.
+    # @return [Gitlab::ObjectifiedHash] Information about moved issue.
+    def move_issue(project, id, options = {})
+      post("/projects/#{url_encode project}/issues/#{id}/move", body: options)
+    end
+
+    # Sets an estimated time of work for an issue.
+    #
+    # @example
+    #   Gitlab.estimate_time_of_issue(3, 42, '3h30m')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [String] duration The duration in human format. e.g: 3h30m
+    def estimate_time_of_issue(project, id, duration)
+      post("/projects/#{url_encode project}/issues/#{id}/time_estimate", body: { duration: url_encode(duration) })
+    end
+
+    # Resets the estimated time for an issue to 0 seconds.
+    #
+    # @example
+    #   Gitlab.reset_time_estimate_of_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def reset_time_estimate_of_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/reset_time_estimate")
+    end
+
+    # Adds spent time for an issue
+    #
+    # @example
+    #   Gitlab.estimate_time_of_issue(3, 42, '3h30m')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @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: duration })
+    end
+
+    # Resets the total spent time for this issue to 0 seconds.
+    #
+    # @example
+    #   Gitlab.reset_time_spent_on_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def reset_time_spent_on_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/reset_spent_time")
+    end
+
+    # Get time tracking stats for an issue
+    #
+    # @example
+    #   @gitlab.time_stats_for_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def time_stats_for_issue(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/time_stats")
+    end
+
+    # Get participants on issue
+    #
+    # @example
+    #   @gitlab.participants_on_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def participants_on_issue(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/participants")
+    end
+
+    # List merge requests that will close issue on merge
+    #
+    # @example
+    #   Gitlab.merge_requests_closing_issue_on_merge(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def merge_requests_closing_issue_on_merge(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/closed_by")
+    end
+  end
+end