gitlab 4.8.0 → 4.13.0

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/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/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

data/lib/gitlab/error.rb

@@ -40,7 +40,7 @@ module Gitlab
       #
       # @return [String]
       def build_error_message
-        parsed_response = @response.parsed_response
+        parsed_response = classified_response
         message = check_error_keys(parsed_response)
         "Server responded with code #{@response.code}, message: " \
         "#{handle_message(message)}. " \
@@ -54,6 +54,17 @@ module Gitlab
         key ? resp.send(key) : resp
       end
 
+      # Parse the body based on the classification of the body content type
+      #
+      # @return parsed response
+      def classified_response
+        if @response.respond_to?('headers')
+          @response.headers['content-type'] == 'text/plain' ? { message: @response.to_s } : @response.parsed_response
+        else
+          @response.parsed_response
+        end
+      end
+
       # Handle error response message in case of nested hashes
       def handle_message(message)
         case message
@@ -67,6 +78,18 @@ module Gitlab
           message
         end
       end
+
+      def method_missing(method, *args, &block)
+        if @response.parsed_response.key?(method)
+          @response.parsed_response[method]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        super || @response.parsed_response.key?(method, include_private)
+      end
     end
 
     # Raised when API endpoint returns the HTTP status code 400.
@@ -84,12 +107,18 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 405.
     class MethodNotAllowed < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 406.
+    class NotAcceptable < ResponseError; end
+
     # Raised when API endpoint returns the HTTP status code 409.
     class Conflict < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 422.
     class Unprocessable < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 429.
+    class TooManyRequests < ResponseError; end
+
     # Raised when API endpoint returns the HTTP status code 500.
     class InternalServerError < ResponseError; end
 
@@ -98,5 +127,21 @@ module Gitlab
 
     # Raised when API endpoint returns the HTTP status code 503.
     class ServiceUnavailable < ResponseError; end
+
+    # HTTP status codes mapped to error classes.
+    STATUS_MAPPINGS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable
+    }.freeze
   end
 end

data/lib/gitlab/paginated_response.rb

@@ -56,6 +56,25 @@ module Gitlab
       response
     end
 
+    def paginate_with_limit(limit)
+      response = block_given? ? nil : []
+      count = 0
+      each_page do |page|
+        if block_given?
+          page.each do |item|
+            yield item
+            count += 1
+            break if count >= limit
+          end
+        else
+          response += page[0, limit - count]
+          count = response.length
+        end
+        break if count >= limit
+      end
+      response
+    end
+
     def last_page?
       !(@links.nil? || @links.last.nil?)
     end