gitlab 4.9.0 → 4.13.1

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/labels.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Gitlab::Client
-  # Defines methods related to labels.
+  # Defines methods related to project labels.
   # @see https://docs.gitlab.com/ce/api/labels.html
   module Labels
     # Gets a list of project's labels.

data/lib/gitlab/client/lint.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to lint/validations.
+  # @see https://docs.gitlab.com/ce/api/lint.html
+  module Lint
+    # Checks if your .gitlab-ci.yml file is valid.
+    #
+    # @example
+    #   Gitlab.validate_gitlab_ci_yml("{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}")
+    #
+    # @param  [String] content the .gitlab-ci.yaml content.
+    # @return <Gitlab::ObjectifiedHash> Returns information about validity of the yml.
+    def validate_gitlab_ci_yml(content)
+      body = { content: content }
+      post('/lint', body: body)
+    end
+  end
+end

data/lib/gitlab/client/markdown.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to markdown.
+  # @see https://docs.gitlab.com/ce/api/markdown.html
+  module Markdown
+    # Render an arbitrary Markdown document
+    #
+    # @example
+    #   Gitlab.markdown('Hello world! :tada:')
+    #   Gitlab.markdown('Hello world! :tada:', gfm: true, project: 'group_example/project_example')
+    #
+    # @param  [String] text The markdown text to render.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :gfm(optional) Render text using GitLab Flavored Markdown. Default is false.
+    # @option options [String] :project(optional) Use project as a context when creating references using GitLab Flavored Markdown. Authentication is required if a project is not public.
+    # @return <Gitlab::ObjectifiedHash> Returns the rendered markdown as response
+    def markdown(text, options = {})
+      body = { text: text }.merge(options)
+      post('/markdown', body: body)
+    end
+  end
+end

data/lib/gitlab/client/merge_request_approvals.rb

@@ -37,11 +37,11 @@ class Gitlab::Client
     #    Gitlab.edit_project_approvers(1, {approver_ids: [5], approver_groups: [1]})
     #
     # @param [Integer] project(required) The ID of a project.
-    # @option options [Array] :approver_ids(optional) An array of User IDs that can approve MRs
-    # @option options [Array] :approver_group_ids(optional) An array of Group IDs whose members can approve MRs
+    # @option options [Array] :approver_ids(required, nil if none) An array of User IDs that can approve MRs
+    # @option options [Array] :approver_group_ids(required, nil if none) An array of Group IDs whose members can approve MRs
     # @return [Gitlab::ObjectifiedHash] MR approval configuration information about the project
     def edit_project_approvers(project, options = {})
-      put("/projects/#{url_encode project}/approvals", body: options)
+      put("/projects/#{url_encode project}/approvers", body: options)
     end
 
     # Get Configuration for approvals on a specific Merge Request.
@@ -76,8 +76,8 @@ class Gitlab::Client
     #
     # @param [Integer] project(required) The ID of a project.
     # @param [Integer] merge_request(required) The IID of a merge_request.
-    # @option options [Array] :approver_ids(optional) An array of User IDs that can approve MRs
-    # @option options [Array] :approver_group_ids(optional) An array of Group IDs whose members can approve MRs
+    # @option options [Array] :approver_ids(required, nil if none) An array of User IDs that can approve MRs
+    # @option options [Array] :approver_group_ids(required, nil if none) An array of Group IDs whose members can approve MRs
     # @return [Gitlab::ObjectifiedHash] MR approval configuration information about the project
     def edit_merge_request_approvers(project, merge_request, options = {})
       put("/projects/#{url_encode project}/merge_requests/#{merge_request}/approvers", body: options)
@@ -104,9 +104,10 @@ class Gitlab::Client
     #
     # @param [Integer] project(required) The ID of a project.
     # @param [Integer] merge_request(required) The IID of a merge request.
+    # @option options [String] :sudo(optional) The username of the user you want to remove the approval for
     # @return [void] This API call returns an empty response body.
-    def unapprove_merge_request(project, merge_request)
-      post("/projects/#{url_encode project}/merge_requests/#{merge_request}/unapprove")
+    def unapprove_merge_request(project, merge_request, options = {})
+      post("/projects/#{url_encode project}/merge_requests/#{merge_request}/unapprove", body: options)
     end
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -55,6 +55,18 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/merge_requests/#{id}/pipelines")
     end
 
+    # Get a list of merge request participants.
+    #
+    # @example
+    #   Gitlab.merge_request_participants(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def merge_request_participants(project, id)
+      get("/projects/#{url_encode project}/merge_requests/#{id}/participants")
+    end
+
     # Creates a merge request.
     #
     # @example

data/lib/gitlab/client/notes.rb

@@ -276,7 +276,7 @@ class Gitlab::Client
     # in the 'else'.
     def note_content(body)
       if body.is_a?(Hash)
-        STDERR.puts 'Passing the note body as a Hash is deprecated.  You should just pass the String.'
+        warn 'Passing the note body as a Hash is deprecated.  You should just pass the String.'
         body
       else
         { body: body }

data/lib/gitlab/client/projects.rb

@@ -67,7 +67,7 @@ class Gitlab::Client
     # @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :snippets_enabled The snippets integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true).
-    # @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true).
+    # @option options [String] :visibility The setting for making a project public ('private', 'internal', 'public').
     # @option options [Integer] :user_id The user/owner id of a project.
     # @return [Gitlab::ObjectifiedHash] Information about created project.
     def create_project(name, options = {})
@@ -529,14 +529,13 @@ class Gitlab::Client
     # @see https://docs.gitlab.com/ee/api/projects.html#upload-a-file
     #
     # @example
-    #   Gitlab.upload_file(1, File.open(File::NULL, 'r'))
-    #   File.open('myfile') { |file| Gitlab.upload_file(1, file) }
+    #   Gitlab.upload_file(1, '/full/path/to/avatar.jpg')
     #
     # @param  [Integer, String] id The ID or path of a project.
-    # @param  [File] The file you are interested to upload.
+    # @param  [String] file_fullpath The fullpath of the file you are interested to upload.
     # @return [Gitlab::ObjectifiedHash]
-    def upload_file(id, file)
-      post("/projects/#{url_encode id}/uploads", body: { file: file })
+    def upload_file(id, file_fullpath)
+      post("/projects/#{url_encode id}/uploads", body: { file: File.open(file_fullpath, 'r') })
     end
 
     # Get all project templates of a particular type
@@ -570,5 +569,27 @@ class Gitlab::Client
     def project_template(project, type, key, options = {})
       get("/projects/#{url_encode project}/templates/#{type}/#{key}", query: options)
     end
+
+    # Archives a project.
+    #
+    # @example
+    #   Gitlab.archive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about archived project.
+    def archive_project(id)
+      post("/projects/#{url_encode id}/archive")
+    end
+
+    # Unarchives a project.
+    #
+    # @example
+    #   Gitlab.unarchive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about unarchived project.
+    def unarchive_project(id)
+      post("/projects/#{url_encode id}/unarchive")
+    end
   end
 end

data/lib/gitlab/client/repositories.rb

@@ -13,7 +13,8 @@ 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 = {})
       get("/projects/#{url_encode project}/repository/tree", query: options)
@@ -28,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 },

data/lib/gitlab/client/repository_files.rb

@@ -25,6 +25,22 @@ class Gitlab::Client
     end
     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.
     #
     # @example

data/lib/gitlab/client/runners.rb

@@ -79,9 +79,11 @@ class Gitlab::Client
     #   Gitlab.runner_jobs(1)
     #
     # @param  [Integer] id The ID of a runner.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :status Status of the job; one of: running, success, failed, canceled
     # @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.
@@ -122,5 +124,50 @@ class Gitlab::Client
     def project_disable_runner(id, runner_id)
       delete("/projects/#{url_encode id}/runners/#{runner_id}")
     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 Registration token.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description Runner description.
+    # @option options [Hash] :info Runner metadata.
+    # @option options [Boolean] :active Whether the Runner is active.
+    # @option options [Boolean] :locked Whether the Runner should be locked for current project.
+    # @option options [Boolean] :run_untagged Whether the Runner should handle untagged jobs.
+    # @option options [Array<String>] :tag_list List of Runner tags.
+    # @option options [Integer] :maximum_timeout 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
   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/users.rb

@@ -37,11 +37,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', { name: 'Joe Smith' })
     #   or
-    #   Gitlab.create_user('joe@foo.org', 'secret')
+    #   Gitlab.create_user('joe@foo.org', 'secret', 'joe')
     #
-    # @param  [String] email The email of a user.
-    # @param  [String] password The password of a user.
-    # @param  [String] username The username of a user.
+    # @param  [String] email(required) The email of a user.
+    # @param  [String] password(required) The password of a user.
+    # @param  [String] username(required) The username of a user.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :name The name of a user. Defaults to email.
     # @option options [String] :skype The skype of a user.
@@ -51,11 +51,9 @@ class Gitlab::Client
     # @return [Gitlab::ObjectifiedHash] Information about created user.
     def create_user(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
-      body = if args[2]
-               { email: args[0], password: args[1], username: args[2] }
-             else
-               { email: args[0], password: args[1], name: args[0] }
-             end
+      raise ArgumentError, 'Missing required parameters' unless args[2]
+
+      body = { email: args[0], password: args[1], username: args[2], name: args[0] }
       body.merge!(options)
       post('/users', body: body)
     end

data/lib/gitlab/configuration.rb

@@ -35,7 +35,7 @@ module Gitlab
 
     # Resets all configuration options to the defaults.
     def reset
-      self.endpoint       = ENV['GITLAB_API_ENDPOINT']
+      self.endpoint       = ENV['GITLAB_API_ENDPOINT'] || ENV['CI_API_V4_URL']
       self.private_token  = ENV['GITLAB_API_PRIVATE_TOKEN'] || ENV['GITLAB_API_AUTH_TOKEN']
       self.httparty       = get_httparty_config(ENV['GITLAB_API_HTTPARTY_OPTIONS'])
       self.sudo           = nil