gitlab 4.5.0 → 4.6.0

data/lib/gitlab/client/jobs.rb

@@ -1,162 +1,162 @@
-class Gitlab::Client
-  # Defines methods related to projects.
-  # @see https://docs.gitlab.com/ee/api/jobs.html
-  module Jobs
-    # Gets a list of Jobs for a Project
-    #
-    # @example
-    #   Gitlab.jobs(1)
-    #   Gitlab.jobs("project")
-    #
-    # @param  [Integer, String] id The ID or name of a project.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [Array] :scope The scope of jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all jobs if none provided.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def jobs(project_id, options = {})
-      get("/projects/#{url_encode project_id}/jobs", query: options)
-    end
+# frozen_string_literal: true
 
-    # Gets a list of Jobs from a pipeline
-    #
-    # @example
-    #   Gitlab.pipeline_jobs(1, 2)
-    #   Gitlab.pipeline_jobs("project", 2)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the pipeline
-    # @param  [Hash] options A customizable set of options.
-    # @option options [Array] :scope The scope of jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all jobs if none provided.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def pipeline_jobs(project_id, pipeline_id, options = {})
-      get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/jobs", query: options)
-    end
+# Defines methods related to projects.
+# @see https://docs.gitlab.com/ee/api/jobs.html
+module Jobs
+  # Gets a list of Jobs for a Project
+  #
+  # @example
+  #   Gitlab.jobs(1)
+  #   Gitlab.jobs("project")
+  #
+  # @param  [Integer, String] id The ID or name of a project.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [Array] :scope The scope of jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all jobs if none provided.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def jobs(project_id, options = {})
+    get("/projects/#{url_encode project_id}/jobs", query: options)
+  end
 
-    # Gets a single job
-    #
-    # @example
-    #   Gitlab.job(1, 2)
-    #   Gitlab.job("project", 2)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    def job(project_id, job_id)
-      get("/projects/#{url_encode project_id}/jobs/#{job_id}")
-    end
+  # Gets a list of Jobs from a pipeline
+  #
+  # @example
+  #   Gitlab.pipeline_jobs(1, 2)
+  #   Gitlab.pipeline_jobs("project", 2)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the pipeline
+  # @param  [Hash] options A customizable set of options.
+  # @option options [Array] :scope The scope of jobs to show, one or array of: created, pending, running, failed, success, canceled, skipped, manual; showing all jobs if none provided.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def pipeline_jobs(project_id, pipeline_id, options = {})
+    get("/projects/#{url_encode project_id}/pipelines/#{pipeline_id}/jobs", query: options)
+  end
 
-    # Gets artifacts from a job
-    #
-    # @example
-    #   Gitlab.job_artifacts(1, 2)
-    #   Gitlab.job_artifacts("project", 2)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_artifacts(project_id, job_id)
-      get("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts",
-          format: nil,
-          headers: { Accept: 'text/plain' },
-          parser: ::Gitlab::Request::Parser)
-    end
+  # Gets a single job
+  #
+  # @example
+  #   Gitlab.job(1, 2)
+  #   Gitlab.job("project", 2)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  def job(project_id, job_id)
+    get("/projects/#{url_encode project_id}/jobs/#{job_id}")
+  end
 
-    # Download Job Artifact
-    #
-    # @example
-    #   Gitlab.job_artifacts_download(1, "master", "release")
-    #   Gitlab.job_artifacts_download("project", "master", "release")
-    #
-    # @param  [Integer, String] id, The ID or name of a project.
-    # @param  [String]  ref, Ref Name
-    # @param  [String]  job, jobname
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_artifacts_download(project_id, ref_name, job_name)
-      get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download", query: { job: job_name },
-                                                                                    format: nil,
-                                                                                    headers: { Accept: 'text/plain' },
-                                                                                    parser: ::Gitlab::Request::Parser)
-    end
+  # Gets artifacts from a job
+  #
+  # @example
+  #   Gitlab.job_artifacts(1, 2)
+  #   Gitlab.job_artifacts("project", 2)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_artifacts(project_id, job_id)
+    get("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts",
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser)
+  end
 
-    # Get Job Trace
-    #
-    # @example
-    #   Gitlab.job_trace(1,1)
-    #   Gitlab.job_trace("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_trace(project_id, job_id)
-      get("/projects/#{url_encode project_id}/jobs/#{job_id}/trace",
-          format: nil,
-          headers: { Accept: 'text/plain' },
-          parser: ::Gitlab::Request::Parser)
-    end
+  # Download Job Artifact
+  #
+  # @example
+  #   Gitlab.job_artifacts_download(1, "master", "release")
+  #   Gitlab.job_artifacts_download("project", "master", "release")
+  #
+  # @param  [Integer, String] id, The ID or name of a project.
+  # @param  [String]  ref, Ref Name
+  # @param  [String]  job, jobname
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_artifacts_download(project_id, ref_name, job_name)
+    get("/projects/#{url_encode project_id}/jobs/artifacts/#{ref_name}/download", query: { job: job_name },
+                                                                                  format: nil,
+                                                                                  headers: { Accept: 'text/plain' },
+                                                                                  parser: ::Gitlab::Request::Parser)
+  end
 
-    # Cancel a job
-    #
-    # @example
-    #   Gitlab.job_cancel(1,1)
-    #   Gitlab.job_cancel("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_cancel(project_id, job_id)
-      post("/projects/#{url_encode project_id}/jobs/#{job_id}/cancel")
-    end
+  # Get Job Trace
+  #
+  # @example
+  #   Gitlab.job_trace(1,1)
+  #   Gitlab.job_trace("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_trace(project_id, job_id)
+    get("/projects/#{url_encode project_id}/jobs/#{job_id}/trace",
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser)
+  end
 
-    # Retry a job
-    #
-    # @example
-    #   Gitlab.job_retry(1,1)
-    #   Gitlab.job_retry("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_retry(project_id, job_id)
-      post("/projects/#{url_encode project_id}/jobs/#{job_id}/retry")
-    end
+  # Cancel a job
+  #
+  # @example
+  #   Gitlab.job_cancel(1,1)
+  #   Gitlab.job_cancel("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_cancel(project_id, job_id)
+    post("/projects/#{url_encode project_id}/jobs/#{job_id}/cancel")
+  end
 
-    # Erase Job
-    #
-    # @example
-    #   Gitlab.job_erase(1,1)
-    #   Gitlab.job_erase("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_erase(project_id, job_id)
-      post("/projects/#{url_encode project_id}/jobs/#{job_id}/erase")
-    end
+  # Retry a job
+  #
+  # @example
+  #   Gitlab.job_retry(1,1)
+  #   Gitlab.job_retry("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_retry(project_id, job_id)
+    post("/projects/#{url_encode project_id}/jobs/#{job_id}/retry")
+  end
 
-    # Play a Job
-    # Triggers a manual action to start a job.
-    #
-    # @example
-    #   Gitlab.job_play(1,1)
-    #   Gitlab.job_play("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_play(project_id, job_id)
-      post("/projects/#{url_encode project_id}/jobs/#{job_id}/play")
-    end
+  # Erase Job
+  #
+  # @example
+  #   Gitlab.job_erase(1,1)
+  #   Gitlab.job_erase("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_erase(project_id, job_id)
+    post("/projects/#{url_encode project_id}/jobs/#{job_id}/erase")
+  end
+
+  # Play a Job
+  # Triggers a manual action to start a job.
+  #
+  # @example
+  #   Gitlab.job_play(1,1)
+  #   Gitlab.job_play("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_play(project_id, job_id)
+    post("/projects/#{url_encode project_id}/jobs/#{job_id}/play")
+  end
 
-    # Keep Artifacts
-    # Prevents artifacts from being deleted when expiration is set.
-    #
-    # @example
-    #   Gitlab.job_artifacts_keep(1,1)
-    #   Gitlab.job_artifacts_keep("project", 1)
-    #
-    # @param  [Integer, String] The ID or name of a project.
-    # @param  [Integer]  the id of the job
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def job_artifacts_keep(project_id, job_id)
-      post("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts/keep")
-    end
+  # Keep Artifacts
+  # Prevents artifacts from being deleted when expiration is set.
+  #
+  # @example
+  #   Gitlab.job_artifacts_keep(1,1)
+  #   Gitlab.job_artifacts_keep("project", 1)
+  #
+  # @param  [Integer, String] The ID or name of a project.
+  # @param  [Integer]  the id of the job
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def job_artifacts_keep(project_id, job_id)
+    post("/projects/#{url_encode project_id}/jobs/#{job_id}/artifacts/keep")
   end
 end

data/lib/gitlab/client/keys.rb

@@ -1,16 +1,16 @@
-class Gitlab::Client
-  # Defines methods related to keys.
-  # @see https://docs.gitlab.com/ce/api/keys.html
-  module Keys
-    # Gets information about a key.
-    #
-    # @example
-    #   Gitlab.key(1)
-    #
-    # @param  [Integer] id The ID of a key.
-    # @return [Gitlab::ObjectifiedHash]
-    def key(id)
-      get("/keys/#{id}")
-    end
+# frozen_string_literal: true
+
+# Defines methods related to keys.
+# @see https://docs.gitlab.com/ce/api/keys.html
+module Keys
+  # Gets information about a key.
+  #
+  # @example
+  #   Gitlab.key(1)
+  #
+  # @param  [Integer] id The ID of a key.
+  # @return [Gitlab::ObjectifiedHash]
+  def key(id)
+    get("/keys/#{id}")
   end
 end

data/lib/gitlab/client/labels.rb

@@ -1,86 +1,86 @@
-class Gitlab::Client
-  # Defines methods related to labels.
-  # @see https://docs.gitlab.com/ce/api/labels.html
-  module Labels
-    # Gets a list of project's labels.
-    #
-    # @example
-    #   Gitlab.labels(5)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def labels(project, options={})
-      get("/projects/#{url_encode project}/labels", query: options)
-    end
+# frozen_string_literal: true
 
-    # Creates a new label.
-    #
-    # @example
-    #   Gitlab.create_label(42, "Backlog", '#DD10AA')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] name The name of a label.
-    # @param  [String] color The color of a label.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :description The description of the label.
-    # @option options [String] :priority The priority of the label. Must be greater or equal than zero or null to remove the priority.
-    # @return [Gitlab::ObjectifiedHash] Information about created label.
-    def create_label(project, name, color, options = {})
-      post("/projects/#{url_encode project}/labels", body: options.merge(name: name, color: color))
-    end
+# Defines methods related to labels.
+# @see https://docs.gitlab.com/ce/api/labels.html
+module Labels
+  # Gets a list of project's labels.
+  #
+  # @example
+  #   Gitlab.labels(5)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def labels(project, options = {})
+    get("/projects/#{url_encode project}/labels", query: options)
+  end
+
+  # Creates a new label.
+  #
+  # @example
+  #   Gitlab.create_label(42, "Backlog", '#DD10AA')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] name The name of a label.
+  # @param  [String] color The color of a label.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :description The description of the label.
+  # @option options [String] :priority The priority of the label. Must be greater or equal than zero or null to remove the priority.
+  # @return [Gitlab::ObjectifiedHash] Information about created label.
+  def create_label(project, name, color, options = {})
+    post("/projects/#{url_encode project}/labels", body: options.merge(name: name, color: color))
+  end
 
-    # Updates a label.
-    #
-    # @example
-    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO' })
-    #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO', color: '#DD10AA' })
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] name The name of a label.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :new_name The new name of a label.
-    # @option options [String] :color The color of a label.
-    # @option options [String] :description The description of the label.
-    # @option options [String] :priority The priority of the label. Must be greater or equal than zero or null to remove the priority.
-    # @return [Gitlab::ObjectifiedHash] Information about updated label.
-    def edit_label(project, name, options={})
-      put("/projects/#{url_encode project}/labels", body: options.merge(name: name))
-    end
+  # Updates a label.
+  #
+  # @example
+  #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO' })
+  #   Gitlab.edit_label(42, "Backlog", { new_name: 'TODO', color: '#DD10AA' })
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] name The name of a label.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :new_name The new name of a label.
+  # @option options [String] :color The color of a label.
+  # @option options [String] :description The description of the label.
+  # @option options [String] :priority The priority of the label. Must be greater or equal than zero or null to remove the priority.
+  # @return [Gitlab::ObjectifiedHash] Information about updated label.
+  def edit_label(project, name, options = {})
+    put("/projects/#{url_encode project}/labels", body: options.merge(name: name))
+  end
 
-    # Deletes a label.
-    #
-    # @example
-    #   Gitlab.delete_label(2, 'Backlog')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] name The name of a label.
-    # @return [Gitlab::ObjectifiedHash] Information about deleted label.
-    def delete_label(project, name)
-      delete("/projects/#{url_encode project}/labels", body: { name: name })
-    end
+  # Deletes a label.
+  #
+  # @example
+  #   Gitlab.delete_label(2, 'Backlog')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] name The name of a label.
+  # @return [Gitlab::ObjectifiedHash] Information about deleted label.
+  def delete_label(project, name)
+    delete("/projects/#{url_encode project}/labels", body: { name: name })
+  end
 
-    # Subscribes the user to a label to receive notifications
-    #
-    # @example
-    #   Gitlab.subscribe_to_label(2, 'Backlog')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] name The name of a label.
-    # @return [Gitlab::ObjectifiedHash] Information about the label subscribed to.
-    def subscribe_to_label(project, name)
-      post("/projects/#{url_encode project}/labels/#{url_encode name}/subscribe")
-    end
+  # Subscribes the user to a label to receive notifications
+  #
+  # @example
+  #   Gitlab.subscribe_to_label(2, 'Backlog')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] name The name of a label.
+  # @return [Gitlab::ObjectifiedHash] Information about the label subscribed to.
+  def subscribe_to_label(project, name)
+    post("/projects/#{url_encode project}/labels/#{url_encode name}/subscribe")
+  end
 
-    # Unsubscribes the user from a label to not receive notifications from it
-    #
-    # @example
-    #   Gitlab.unsubscribe_from_label(2, 'Backlog')
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] name The name of a label.
-    # @return [Gitlab::ObjectifiedHash] Information about the label unsubscribed from.
-    def unsubscribe_from_label(project, name)
-      post("/projects/#{url_encode project}/labels/#{url_encode name}/unsubscribe")
-    end
+  # Unsubscribes the user from a label to not receive notifications from it
+  #
+  # @example
+  #   Gitlab.unsubscribe_from_label(2, 'Backlog')
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] name The name of a label.
+  # @return [Gitlab::ObjectifiedHash] Information about the label unsubscribed from.
+  def unsubscribe_from_label(project, name)
+    post("/projects/#{url_encode project}/labels/#{url_encode name}/unsubscribe")
   end
 end