gitlab 4.5.0 → 5.1.0

data/lib/gitlab/client/repositories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to repositories.
   # @see https://docs.gitlab.com/ce/api/repositories.html
@@ -11,12 +13,13 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :path The path inside repository.
-    # @option options [String] :ref_name The name of a repository branch or tag.
+    # @option options [String] :ref The name of a repository branch or tag.
+    # @option options [Integer] :per_page Number of results to show per page (default = 20)
     # @return [Gitlab::ObjectifiedHash]
-    def tree(project, options={})
+    def tree(project, options = {})
       get("/projects/#{url_encode project}/repository/tree", query: options)
     end
-    alias_method :repo_tree, :tree
+    alias repo_tree tree
 
     # Get project repository archive
     #
@@ -26,9 +29,10 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] ref The commit sha, branch, or tag to download.
+    # @param  [String] format The archive format. Options are: tar.gz (default), tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip
     # @return [Gitlab::FileResponse]
-    def repo_archive(project, ref = 'master')
-      get("/projects/#{url_encode project}/repository/archive",
+    def repo_archive(project, ref = 'master', format = 'tar.gz')
+      get("/projects/#{url_encode project}/repository/archive.#{format}",
           format: nil,
           headers: { Accept: 'application/octet-stream' },
           query: { sha: ref },
@@ -54,6 +58,73 @@ class Gitlab::Client
     def compare(project, from, to)
       get("/projects/#{url_encode project}/repository/compare", query: { from: from, to: to })
     end
-    alias_method :repo_compare, :compare
+    alias repo_compare compare
+
+    # Get the common ancestor for 2 refs (commit SHAs, branch names or tags).
+    #
+    # @example
+    #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+    #   Gitlab.merge_base(42, ['master', 'feature/branch'])
+    #
+    # @param [Integer, String] project The ID or URL-encoded path of the project.
+    # @param [Array] refs Array containing 2 commit SHAs, branch names, or tags.
+    # @return [Gitlab::ObjectifiedHash]
+    def merge_base(project, refs)
+      get("/projects/#{url_encode project}/repository/merge_base", query: { refs: refs })
+    end
+
+    # Get project repository contributors.
+    #
+    # @example
+    #   Gitlab.contributors(42)
+    #   Gitlab.contributors(42, { order: 'name' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :order_by Order by name, email or commits (default = commits).
+    # @option options [String] :sort Sort order asc or desc (default = asc).
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def contributors(project, options = {})
+      get("/projects/#{url_encode project}/repository/contributors", query: options)
+    end
+    alias repo_contributors contributors
+
+    # Generate changelog data
+    #
+    # @example
+    #   Gitlab.generate_changelog(42, 'v1.0.0')
+    #   Gitlab.generate_changelog(42, 'v1.0.0', branch: 'main')
+    #
+    # @param [Integer, String] project The ID or name of a project
+    # @param [String] version The version to generate the changelog for
+    # @param [Hash] options A customizable set of options
+    # @option options [String] :from The start of the range of commits (SHA)
+    # @option options [String] :to The end of the range of commits (as a SHA) to use for the changelog
+    # @option options [String] :date The date and time of the release, defaults to the current time
+    # @option options [String] :branch The branch to commit the changelog changes to
+    # @option options [String] :trailer The Git trailer to use for including commits
+    # @option options [String] :file The file to commit the changes to
+    # @option options [String] :message The commit message to produce when committing the changes
+    # @return [bool]
+    def generate_changelog(project, version, options = {})
+      post("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
+    end
+
+    # Get changelog data
+    #
+    # @example
+    #   Gitlab.get_changelog(42, 'v1.0.0')
+    #
+    # @param [Integer, String] project The ID or name of a project
+    # @param [String] version The version to generate the changelog for
+    # @param [Hash] options A customizable set of options
+    # @option options [String] :from The start of the range of commits (SHA)
+    # @option options [String] :to The end of the range of commits (as a SHA) to use for the changelog
+    # @option options [String] :date The date and time of the release, defaults to the current time
+    # @option options [String] :trailer The Git trailer to use for including commits
+    # @return [Gitlab::ObjectifiedHash]
+    def get_changelog(project, version, options = {})
+      get("/projects/#{url_encode project}/repository/changelog", body: options.merge(version: version))
+    end
   end
 end

data/lib/gitlab/client/repository_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 class Gitlab::Client
@@ -14,14 +16,30 @@ class Gitlab::Client
     # @param  [String] filepath The relative path of the file in the repository
     # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
     # @return [String]
-    def file_contents(project, filepath, ref='master')
+    def file_contents(project, filepath, ref = 'master')
       get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
-          query: { ref: ref},
+          query: { ref: ref },
           format: nil,
           headers: { Accept: 'text/plain' },
           parser: ::Gitlab::Request::Parser
     end
-    alias_method :repo_file_contents, :file_contents
+    alias repo_file_contents file_contents
+
+    # Get file blame from repository
+    #
+    # @example
+    #   Gitlab.get_file_blame(42, "README.md", "master")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] file_path The full path of the file.
+    # @param  [String] ref The name of branch, tag or commit.
+    # @return [Gitlab::ObjectifiedHash]
+    #
+    def get_file_blame(project, file_path, ref)
+      get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}/blame", query: {
+            ref: ref
+          })
+    end
 
     # Gets a repository file.
     #

data/lib/gitlab/client/repository_submodules.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to repository submodules.
+  # @see https://docs.gitlab.com/ce/api/repository_submodules.html
+  module RepositorySubmodules
+    # Edits an existing repository submodule.
+    #
+    # @example
+    #   Gitlab.edit_file(42, "submodule", {
+    #     branch: "branch",
+    #     commit_sha: "3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88",
+    #     commit_message: "commit message"
+    #   })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] submodule full path of submodule to update.
+    # @param  [Hash] options A customizable set of options.
+    # @param  options [String] :branch the name of the branch to commit changes to.
+    # @param  options [String] :commit_sha commit SHA to update the submodule to.
+    # @param  options [String] :commit_message commit message text.
+    # @return [Gitlab::ObjectifiedHash]
+    def edit_submodule(project, submodule, options = {})
+      put("/projects/#{url_encode project}/repository/submodules/#{url_encode submodule}", body: options)
+    end
+  end
+end

data/lib/gitlab/client/resource_label_events.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to resource label events.
+  # @see https://docs.gitlab.com/ee/api/resource_label_events.html
+  module ResourceLabelEvents
+    # Gets a list of all label events for a single issue.
+    #
+    # @example
+    #   Gitlab.issue_label_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_label_events(project, issue_iid)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific project issue
+    #
+    # @example
+    #   Gitlab.issue_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def issue_label_event(project, issue_iid, id)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_label_events/#{id}")
+    end
+
+    # Gets a list of all label events for a single epic.
+    #
+    # @example
+    #   Gitlab.epic_label_events(5, 42)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic_id The ID of an epic.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def epic_label_events(group, epic_id)
+      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific group epic
+    #
+    # @example
+    #   Gitlab.epic_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer] epic_id The ID of an epic.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def epic_label_event(group, epic_id, id)
+      get("/groups/#{url_encode group}/epics/#{epic_id}/resource_label_events/#{id}")
+    end
+
+    # Gets a list of all label events for a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_label_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_label_events(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events")
+    end
+
+    # Returns a single label event for a specific project merge request
+    #
+    # @example
+    #   Gitlab.merge_request_label_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of an merge request.
+    # @param  [Integer] id The ID of a label event.
+    # @return Gitlab::ObjectifiedHash
+    def merge_request_label_event(project, merge_request_iid, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_label_events/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/resource_state_events.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to resource state events.
+  # @see https://docs.gitlab.com/ee/api/resource_state_events.html
+  module ResourceStateEvents
+    # Gets a list of all state events for a single issue.
+    #
+    # @example
+    #   Gitlab.issue_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_state_events(project, issue_iid)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project issue
+    #
+    # @example
+    #   Gitlab.issue_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] issue_iid The IID of an issue.
+    # @param  [Integer] id The ID of a resource event.
+    # @return Gitlab::ObjectifiedHash
+    def issue_state_event(project, issue_iid, id)
+      get("/projects/#{url_encode project}/issues/#{issue_iid}/resource_state_events/#{id}")
+    end
+
+    # Gets a list of all state events for a single merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_state_events(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_state_events(project, merge_request_iid)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events")
+    end
+
+    # Returns a single state event for a specific project merge request
+    #
+    # @example
+    #   Gitlab.merge_request_state_event(5, 42, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] merge_request_iid The IID of an merge request.
+    # @param  [Integer] id The ID of a state event.
+    # @return Gitlab::ObjectifiedHash
+    def merge_request_state_event(project, merge_request_iid, id)
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_iid}/resource_state_events/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/runners.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to runners.
   # @see https://docs.gitlab.com/ce/api/runners.html
   module Runners
-
     # Get a list of specific runners available to the user.
     # @see https://docs.gitlab.com/ce/api/runners.html#list-owned-runners
     #
     # @example
     #   Gitlab.runners
-    #   Gitlab.runners(:active)
-    #   Gitlab.runners(:paused)
+    #   Gitlab.runners(type: 'instance_type', status: 'active')
+    #   Gitlab.runners(tag_list: 'tag1,tag2')
     #
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :scope The scope of specific runners to show, one of: active, paused, online; showing all runners if none provided
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def runners(options = {})
-      get("/runners", query: options)
+      get('/runners', query: options)
     end
 
     # Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
@@ -23,12 +26,16 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.all_runners
+    #   Gitlab.all_runners(type: 'instance_type', status: 'active')
+    #   Gitlab.all_runners(tag_list: 'tag1,tag2')
     #
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :scope The scope of runners to show, one of: specific, shared, active, paused, online; showing all runners if none provided
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def all_runners(options = {})
-      get("/runners/all", query: options)
+      get('/runners/all', query: options)
     end
 
     # Get details of a runner..
@@ -49,15 +56,19 @@ class Gitlab::Client
     # @example
     #   Gitlab.update_runner(42, { description: 'Awesome runner' })
     #   Gitlab.update_runner(42, { active: false })
-    #   Gitlab.update_runner(42, { tag_list: [ 'awesome', 'runner' ] })
     #
     # @param  [Integer, String] id The ID of a runner
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :active The state of a runner; can be set to true or false.
-    # @option options [String] :tag_list The list of tags for a runner; put array of tags, that should be finally assigned to a runner
+    # @option options [String] :description(optional) The description of a runner
+    # @option options [Boolean] :active(optional) The state of a runner; can be set to true or false
+    # @option options [String] :tag_list(optional) The list of tags for a runner; put array of tags, that should be finally assigned to a runner(separated by comma)
+    # @option options [Boolean] :run_untagged(optional) Flag indicating the runner can execute untagged jobs
+    # @option options [Boolean] :locked(optional) Flag indicating the runner is locked
+    # @option options [String] :access_level(optional) The access_level of the runner; not_protected or ref_protected
+    # @option options [Integer] :maximum_timeout(optional) Maximum timeout set when this runner will handle the job
     # @return <Gitlab::ObjectifiedHash>
-    def update_runner(id, options={})
-      put("/runners/#{id}", query: options)
+    def update_runner(id, options = {})
+      put("/runners/#{id}", body: options)
     end
 
     # Remove a runner.
@@ -67,20 +78,26 @@ class Gitlab::Client
     #   Gitlab.delete_runner(42)
     #
     # @param  [Integer, String] id The ID of a runner
-    # @return <Gitlab::ObjectifiedHash>
+    # @return [nil] This API call returns an empty response body.
     def delete_runner(id)
       delete("/runners/#{id}")
     end
 
-    # Gets a list of Jobs for a Runner
+    # List jobs that are being processed or were processed by specified runner.
     #
     # @example
     #   Gitlab.runner_jobs(1)
+    #   Gitlab.runner_jobs(1, status: 'success')
+    #   Gitlab.runner_jobs(1, sort: 'desc')
     #
     # @param  [Integer] id The ID of a runner.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :status(optional) Status of the job; one of: running, success, failed, canceled
+    # @option options [String] :order_by(optional) Order jobs by id.
+    # @option options [String] :sort(optional) Sort jobs in asc or desc order (default: desc)
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def runner_jobs(runner_id)
-      get("/runners/#{url_encode runner_id}/jobs")
+    def runner_jobs(runner_id, options = {})
+      get("/runners/#{url_encode runner_id}/jobs", query: options)
     end
 
     # List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project's settings.
@@ -88,11 +105,17 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.project_runners(42)
+    #   Gitlab.project_runners(42, type: 'instance_type', status: 'active')
+    #   Gitlab.project_runners(42, tag_list: 'tag1,tag2')
     #
     # @param  [Integer, String] id The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def project_runners(project_id)
-      get("/projects/#{url_encode project_id}/runners")
+    def project_runners(project_id, options = {})
+      get("/projects/#{url_encode project_id}/runners", query: options)
     end
 
     # Enable an available specific runner in the project.
@@ -122,5 +145,134 @@ class Gitlab::Client
       delete("/projects/#{url_encode id}/runners/#{runner_id}")
     end
 
+    # List all runners (specific and shared) available in the group as well its ancestor groups. Shared runners are listed if at least one shared runner is defined.
+    # @see https://docs.gitlab.com/ee/api/runners.html#list-groups-runners
+    #
+    # @example
+    #   Gitlab.group_runners(9)
+    #   Gitlab.group_runners(9, type: 'instance_type', status: 'active')
+    #   Gitlab.group_runners(9, tag_list: 'tag1,tag2')
+    #
+    # @param  [Integer, String] id The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :type(optional) The type of runners to show, one of: instance_type, group_type, project_type
+    # @option options [String] :status(optional) The status of runners to show, one of: active, paused, online, offline
+    # @option options [String] :tag_list(optional) List of the runners tags (separated by comma)
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_runners(group, options = {})
+      get("/groups/#{url_encode group}/runners", query: options)
+    end
+
+    # Register a new Runner for the instance.
+    #
+    # @example
+    #   Gitlab.register_runner('9142c16ea169eaaea3d752313a434a6e')
+    #   Gitlab.register_runner('9142c16ea169eaaea3d752313a434a6e', description: 'Some Description', active: true, locked: false)
+    #
+    # @param  [String] token(required) Registration token.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description(optional) Runner description.
+    # @option options [Hash] :info(optional) Runner metadata.
+    # @option options [Boolean] :active(optional) Whether the Runner is active.
+    # @option options [Boolean] :locked(optional) Whether the Runner should be locked for current project.
+    # @option options [Boolean] :run_untagged(optional) Whether the Runner should handle untagged jobs.
+    # @option options [Array<String>] :tag_list(optional) List of Runner tags.
+    # @option options [Integer] :maximum_timeout(optional) Maximum timeout set when this Runner will handle the job.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def register_runner(token, options = {})
+      body = { token: token }.merge(options)
+      post('/runners', body: body)
+    end
+
+    # Deletes a registed Runner.
+    #
+    # @example
+    #   Gitlab.delete_registered_runner('9142c16ea169eaaea3d752313a434a6e')
+    #
+    # @param  [String] token Runner authentication token.
+    # @return [nil] This API call returns an empty response body.
+    def delete_registered_runner(token)
+      body = { token: token }
+      delete('/runners', body: body)
+    end
+
+    # Validates authentication credentials for a registered Runner.
+    #
+    # @example
+    #   Gitlab.verify_auth_registered_runner('9142c16ea169eaaea3d752313a434a6e')
+    #
+    # @param  [String] token Runner authentication token.
+    # @return [nil] This API call returns an empty response body.
+    def verify_auth_registered_runner(token)
+      body = { token: token }
+      post('/runners/verify', body: body)
+    end
+
+    # Creates a new group runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    # You must use an access token with the create_runner scope
+    #
+    # @example
+    #   Gitlab.create_group_runner(9, tag_list: ['one', 'two'])
+    #   Gitlab.create_group_runner(9, paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] group(required) Group ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_group_runner(group, options = {})
+      create_runner({ runner_type: 'group_type', group_id: group }.merge(options))
+    end
+
+    # Creates a new project runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    # You must use an access token with the create_runner scope
+    #
+    # @example
+    #   Gitlab.create_project_runner(12, tag_list: ['one', 'two'])
+    #   Gitlab.create_project_runner(12, paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] project(required) Project ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_project_runner(project, options = {})
+      create_runner({ runner_type: 'project_type', project_id: project }.merge(options))
+    end
+
+    # Creates a new instance runner with the new Gitlab approach (v16.0+) and returns the id/token information
+    # You must be an administrator of the GitLab instance
+    # You must use an access token with the create_runner scope
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    #
+    # @example
+    #   Gitlab.create_instance_runner(tag_list: ['one', 'two'])
+    #   Gitlab.create_instance_runner(paused: false, description: 'A note', run_untagged: true)
+    #
+    # @param  [String] group(required) Project ID.
+    # @param  [Hash] options A customizable set of options.
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration
+    def create_instance_runner(options = {})
+      create_runner({ runner_type: 'instance_type' }.merge(options))
+    end
+
+    private
+
+    # Creates a runner linked to the current user.
+    # You must use an access token with the create_runner scope
+    # https://docs.gitlab.com/ee/api/users.html#create-a-runner
+    #
+    # @param  [Hash] options(required) A customizable set of options.
+    # @option options [String] :description(optional) Runner description.
+    # @option options [Hash] :info(optional) Runner metadata.
+    # @option options [Boolean] :paused(optional) Whether the Runner ignores new jobs.
+    # @option options [Boolean] :locked(optional) Whether the Runner should be locked for current project.
+    # @option options [Boolean] :run_untagged(optional) Whether the Runner should handle untagged jobs.
+    # @option options [Array<String>] :tag_list(optional) List of Runner tags.
+    # @option options [String] :access_level(optional) Access level of the runner; not_protected or ref_protected.
+    # @option options [Integer] :maximum_timeout(optional) Maximum timeout set when this Runner will handle the job.
+    # @option options [String] :maintenance_note(optional) Free-form maintenance notes for the runner (1024 characters).
+    # @return <Gitlab::ObjectifiedHash> Response against runner registration {"id": 1, "token": foo "token_expires_at": null}
+    def create_runner(options)
+      post('/user/runners', body: options)
+    end
   end
 end

data/lib/gitlab/client/search.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to global searches, searching in projects and searching in groups.
+  # @see https://docs.gitlab.com/ce/api/search.html
+  module Search
+    # Search globally across the GitLab instance.
+    #
+    # @example
+    #   Gitlab.search_globally('projects', 'gitlab')
+    #   Gitlab.search_globally('issues', 'gitlab')
+    #   Gitlab.search_globally('merge_requests', 'gitlab')
+    #   Gitlab.search_globally('milestones', 'gitlab')
+    #   Gitlab.search_globally('snippet_titles', 'gitlab')
+    #   Gitlab.search_globally('snippet_blobs', 'gitlab')
+    #
+    # @param  [String] scope The scope to search in. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs.
+    # @param  [String] search The search query.
+    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
+    def search_globally(scope, search)
+      options = { scope: scope, search: search }
+      get('/search', query: options)
+    end
+
+    # Search within the specified group.
+    #
+    # @example
+    #   Gitlab.search_in_group(1, 'projects', 'gitlab')
+    #   Gitlab.search_in_group(1, 'issues', 'gitlab')
+    #   Gitlab.search_in_group(1, 'merge_requests', 'gitlab')
+    #   Gitlab.search_in_group(1, 'milestones', 'gitlab')
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] scope The scope to search in. Currently these scopes are supported: projects, issues, merge_requests, milestones.
+    # @param  [String] search The search query.
+    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
+    def search_in_group(group, scope, search)
+      options = { scope: scope, search: search }
+      get("/groups/#{url_encode group}/search", query: options)
+    end
+
+    # Search within the specified project.
+    #
+    # @example
+    #   Gitlab.search_in_project(1, 'issues', 'gitlab')
+    #   Gitlab.search_in_project(1, 'merge_requests', 'gitlab')
+    #   Gitlab.search_in_project(1, 'milestones', 'gitlab')
+    #   Gitlab.search_in_project(1, 'notes', 'gitlab')
+    #   Gitlab.search_in_project(1, 'wiki_blobs', 'gitlab')
+    #   Gitlab.search_in_project(1, 'commits', 'gitlab')
+    #   Gitlab.search_in_project(1, 'blobs', 'gitlab')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] scope The scope to search in. Currently these scopes are supported: issues, merge_requests, milestones, notes, wiki_blobs, commits, blobs.
+    # @param  [String] search The search query.
+    # @return [Array<Gitlab::ObjectifiedHash>] Returns a list of responses depending on the requested scope.
+    def search_in_project(project, scope, search, ref = nil)
+      options = { scope: scope, search: search }
+
+      # Add ref filter if provided - backward compatible with main project
+      options[:ref] = ref unless ref.nil?
+
+      get("/projects/#{url_encode project}/search", query: options)
+    end
+  end
+end

data/lib/gitlab/client/services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Third party services connected to a project.
   # @see https://docs.gitlab.com/ce/api/services.html
@@ -43,8 +45,9 @@ class Gitlab::Client
     end
 
     private
+
     def correct_service_name(service)
-      service.to_s.gsub('_', '-')
+      service.to_s.tr('_', '-')
     end
   end
 end

data/lib/gitlab/client/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to sidekiq metrics.
   # @see https://docs.gitlab.com/ce/api/sidekiq_metrics.html