gitlab 4.6.0 → 4.6.1

data/lib/gitlab/client/deployments.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 
-# Defines methods related to deployments.
-# @see https://docs.gitlab.com/ce/api/deployments.html
-module Deployments
-  # Gets a list of project deployments.
-  #
-  # @example
-  #   Gitlab.deployments(5)
-  #   Gitlab.deployments(5, { per_page: 10, page:  2 })
-  #
-  # @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 deployments(project, options = {})
-    get("/projects/#{url_encode project}/deployments", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to deployments.
+  # @see https://docs.gitlab.com/ce/api/deployments.html
+  module Deployments
+    # Gets a list of project deployments.
+    #
+    # @example
+    #   Gitlab.deployments(5)
+    #   Gitlab.deployments(5, { per_page: 10, page:  2 })
+    #
+    # @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 deployments(project, options = {})
+      get("/projects/#{url_encode project}/deployments", query: options)
+    end
 
-  # Gets a single deployment.
-  #
-  # @example
-  #   Gitlab.deployment(5, 36)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of an deployment.
-  # @return [Gitlab::ObjectifiedHash]
-  def deployment(project, id)
-    get("/projects/#{url_encode project}/deployments/#{id}")
+    # Gets a single deployment.
+    #
+    # @example
+    #   Gitlab.deployment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an deployment.
+    # @return [Gitlab::ObjectifiedHash]
+    def deployment(project, id)
+      get("/projects/#{url_encode project}/deployments/#{id}")
+    end
   end
 end

data/lib/gitlab/client/environments.rb

@@ -1,87 +1,89 @@
 # frozen_string_literal: true
 
-# Defines methods related to environments.
-# @see https://docs.gitlab.com/ce/api/environments.html
-module Environments
-  # Gets a list of project environments.
-  #
-  # @example
-  #   Gitlab.environments(5)
-  #   Gitlab.environments(5, { per_page: 10, page:  2 })
-  #
-  # @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 environments(project, options = {})
-    get("/projects/#{url_encode project}/environments", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to environments.
+  # @see https://docs.gitlab.com/ce/api/environments.html
+  module Environments
+    # Gets a list of project environments.
+    #
+    # @example
+    #   Gitlab.environments(5)
+    #   Gitlab.environments(5, { per_page: 10, page:  2 })
+    #
+    # @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 environments(project, options = {})
+      get("/projects/#{url_encode project}/environments", query: options)
+    end
 
-  # Gets a single environment.
-  #
-  # @example
-  #   Gitlab.environment(5, 36)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of an environment.
-  # @return [Gitlab::ObjectifiedHash]
-  def environment(project, id)
-    get("/projects/#{url_encode project}/environments/#{id}")
-  end
+    # Gets a single environment.
+    #
+    # @example
+    #   Gitlab.environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash]
+    def environment(project, id)
+      get("/projects/#{url_encode project}/environments/#{id}")
+    end
 
-  # Create an environment.
-  #
-  # @examples
-  #   Gitlab.create_environment(5, 'test-branch')
-  #   Gitlab.create_environment(5, 'test-branch', external_url: 'https://test-branch.example.host.com')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [String] env_name Name for the environment
-  # @option options [String] :external_url Optional URL for viewing the deployed project in this environment
-  # @return [Gitlab::ObjectifiedHash] The updated environment.
-  def create_environment(project, env_name, options = {})
-    body = { name: env_name }.merge(options)
-    post("/projects/#{url_encode project}/environments", body: body)
-  end
+    # Create an environment.
+    #
+    # @examples
+    #   Gitlab.create_environment(5, 'test-branch')
+    #   Gitlab.create_environment(5, 'test-branch', external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] env_name Name for the environment
+    # @option options [String] :external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def create_environment(project, env_name, options = {})
+      body = { name: env_name }.merge(options)
+      post("/projects/#{url_encode project}/environments", body: body)
+    end
 
-  # Update an environment.
-  #
-  # @examples
-  #   Gitlab.edit_environment(5, 36, name: 'test-branch')
-  #   Gitlab.edit_environment(5, 36, external_url: 'https://test-branch.example.host.com')
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of an environment.
-  # @param  [Hash] options A hash of the attribute keys & values to update.
-  # @option options [String] env_name Name for the environment
-  # @option options [String] external_url Optional URL for viewing the deployed project in this environment
-  # @return [Gitlab::ObjectifiedHash] The updated environment.
-  def edit_environment(project, id, options = {})
-    put("/projects/#{url_encode project}/environments/#{id}", body: options)
-  end
+    # Update an environment.
+    #
+    # @examples
+    #   Gitlab.edit_environment(5, 36, name: 'test-branch')
+    #   Gitlab.edit_environment(5, 36, external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @param  [Hash] options A hash of the attribute keys & values to update.
+    # @option options [String] env_name Name for the environment
+    # @option options [String] external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def edit_environment(project, id, options = {})
+      put("/projects/#{url_encode project}/environments/#{id}", body: options)
+    end
 
-  # Deletes an environment.
-  #
-  # @example
-  #   Gitlab.delete_environment(5, 36)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of an environment.
-  # @return [Gitlab::ObjectifiedHash] Information about the deleted environment.
-  def delete_environment(project, id)
-    delete("/projects/#{url_encode project}/environments/#{id}")
-  end
+    # Deletes an environment.
+    #
+    # @example
+    #   Gitlab.delete_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted environment.
+    def delete_environment(project, id)
+      delete("/projects/#{url_encode project}/environments/#{id}")
+    end
 
-  # Stop an environment.
-  #
-  # @example
-  #   Gitlab.stop_environment(5, 36)
-  #
-  # @param  [Integer, String] project The ID or name of a project.
-  # @param  [Integer] id The ID of an environment.
-  # @return [Array<Gitlab::ObjectifiedHash>] The stopped environment.
-  def stop_environment(project, id)
-    post("/projects/#{url_encode project}/environments/#{id}/stop")
+    # Stop an environment.
+    #
+    # @example
+    #   Gitlab.stop_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Array<Gitlab::ObjectifiedHash>] The stopped environment.
+    def stop_environment(project, id)
+      post("/projects/#{url_encode project}/environments/#{id}/stop")
+    end
   end
 end

data/lib/gitlab/client/events.rb

@@ -1,58 +1,60 @@
 # frozen_string_literal: true
 
-# Defines methods related to events.
-# @see https://docs.gitlab.com/ce/api/events.html
-module Events
-  # Gets a list of authenticated user's events
-  #
-  # @example
-  #   Gitlab.events()
-  #   Gitlab.events({ action: 'created', target_type: 'issue' })
-  #
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :action Only events of specific action type
-  # @option options [String] :target_type Only events of specific target type
-  # @option options [String] :before Only events created before YYYY-MM-DD
-  # @option options [String] :after Only events created after YYYY-MM-DD
-  # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def events(options = {})
-    get('/events', query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to events.
+  # @see https://docs.gitlab.com/ce/api/events.html
+  module Events
+    # Gets a list of authenticated user's events
+    #
+    # @example
+    #   Gitlab.events()
+    #   Gitlab.events({ action: 'created', target_type: 'issue' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def events(options = {})
+      get('/events', query: options)
+    end
 
-  # Gets a list of user contribution events
-  #
-  # @example
-  #   Gitlab.user_events(1)
-  #   Gitlab.user_events(1, { action: created})
-  #
-  # @param  [Integer, String] user The ID or username of user
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :action Only events of specific action type
-  # @option options [String] :target_type Only events of specific target type
-  # @option options [String] :before Only events created before YYYY-MM-DD
-  # @option options [String] :after Only events created after YYYY-MM-DD
-  # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def user_events(user, options = {})
-    get("/users/#{url_encode user}/events", query: options)
-  end
+    # Gets a list of user contribution events
+    #
+    # @example
+    #   Gitlab.user_events(1)
+    #   Gitlab.user_events(1, { action: created})
+    #
+    # @param  [Integer, String] user The ID or username of user
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_events(user, options = {})
+      get("/users/#{url_encode user}/events", query: options)
+    end
 
-  # Gets a list of visible project events
-  #
-  # @example
-  #   Gitlab.project_events(1)
-  #   Gitlab.project_events(1, { action: created })
-  #
-  # @param  [Integer] project The ID of project
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :action Only events of specific action type
-  # @option options [String] :target_type Only events of specific target type
-  # @option options [String] :before Only events created before YYYY-MM-DD
-  # @option options [String] :after Only events created after YYYY-MM-DD
-  # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def project_events(project, options = {})
-    get("/projects/#{url_encode project}/events", query: options)
+    # Gets a list of visible project events
+    #
+    # @example
+    #   Gitlab.project_events(1)
+    #   Gitlab.project_events(1, { action: created })
+    #
+    # @param  [Integer] project The ID of project
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :action Only events of specific action type
+    # @option options [String] :target_type Only events of specific target type
+    # @option options [String] :before Only events created before YYYY-MM-DD
+    # @option options [String] :after Only events created after YYYY-MM-DD
+    # @option options [String] :sort Sort by created_at either 'asc' or 'desc'
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def project_events(project, options = {})
+      get("/projects/#{url_encode project}/events", query: options)
+    end
   end
 end

data/lib/gitlab/client/group_milestones.rb

@@ -1,92 +1,94 @@
 # frozen_string_literal: true
 
-# Defines methods related to group milestones.
-# @see https://docs.gitlab.com/ee/api/group_milestones.html
-module GroupMilestones
-  # Gets a list of a group's milestones.
-  #
-  # @example
-  #   Gitlab.group_milestones(5)
-  #
-  # @param  [Integer, String] id The ID or name 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_milestones(id, options = {})
-    get("/groups/#{url_encode id}/milestones", query: options)
-  end
+class Gitlab::Client
+  # Defines methods related to group milestones.
+  # @see https://docs.gitlab.com/ee/api/group_milestones.html
+  module GroupMilestones
+    # Gets a list of a group's milestones.
+    #
+    # @example
+    #   Gitlab.group_milestones(5)
+    #
+    # @param  [Integer, String] id The ID or name 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_milestones(id, options = {})
+      get("/groups/#{url_encode id}/milestones", query: options)
+    end
 
-  # Gets a single group milestone.
-  #
-  # @example
-  #   Gitlab.group_milestone(5, 36)
-  #
-  # @param  [Integer, String] id The ID or name of a group.
-  # @param  [Integer] milestone_id The ID of a milestone.
-  # @return [Gitlab::ObjectifiedHash]
-  def group_milestone(id, milestone_id)
-    get("/groups/#{url_encode id}/milestones/#{milestone_id}")
-  end
+    # Gets a single group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone(5, 36)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_id The ID of a milestone.
+    # @return [Gitlab::ObjectifiedHash]
+    def group_milestone(id, milestone_id)
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}")
+    end
 
-  # Creates a new group milestone.
-  #
-  # @example
-  #   Gitlab.create_group_milestone(5, 'v1.0')
-  #
-  # @param  [Integer, String] id The ID or name of a group.
-  # @param  [String] title The title of a milestone.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :description The description of a milestone.
-  # @option options [String] :due_date The due date of a milestone.
-  # @return [Gitlab::ObjectifiedHash] Information about created milestone.
-  def create_group_milestone(id, title, options = {})
-    body = { title: title }.merge(options)
-    post("/groups/#{url_encode id}/milestones", body: body)
-  end
+    # Creates a new group milestone.
+    #
+    # @example
+    #   Gitlab.create_group_milestone(5, 'v1.0')
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [String] title The title of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @return [Gitlab::ObjectifiedHash] Information about created milestone.
+    def create_group_milestone(id, title, options = {})
+      body = { title: title }.merge(options)
+      post("/groups/#{url_encode id}/milestones", body: body)
+    end
 
-  # Updates a group milestone.
-  #
-  # @example
-  #   Gitlab.edit_group_milestone(5, 2, { state_event: 'activate' })
-  #
-  # @param  [Integer, String] id The ID or name of a group.
-  # @param  [Integer] milestone_id The ID of a milestone.
-  # @param  [Hash] options A customizable set of options.
-  # @option options [String] :title The title of a milestone.
-  # @option options [String] :description The description of a milestone.
-  # @option options [String] :due_date The due date of a milestone.
-  # @option options [String] :state_event The state of a milestone ('close' or 'activate').
-  # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
-  def edit_group_milestone(id, milestone_id, options = {})
-    put("/groups/#{url_encode id}/milestones/#{milestone_id}", body: options)
-  end
+    # Updates a group milestone.
+    #
+    # @example
+    #   Gitlab.edit_group_milestone(5, 2, { state_event: 'activate' })
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer] milestone_id The ID of a milestone.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a milestone.
+    # @option options [String] :description The description of a milestone.
+    # @option options [String] :due_date The due date of a milestone.
+    # @option options [String] :state_event The state of a milestone ('close' or 'activate').
+    # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
+    def edit_group_milestone(id, milestone_id, options = {})
+      put("/groups/#{url_encode id}/milestones/#{milestone_id}", body: options)
+    end
 
-  # Gets the issues of a given group milestone.
-  #
-  # @example
-  #   Gitlab.group_milestone_issues(5, 2)
-  #
-  # @param  [Integer, String] id The ID or name of a group.
-  # @param  [Integer, String] milestone_id The ID of a milestone.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def group_milestone_issues(id, milestone_id, options = {})
-    get("/groups/#{url_encode id}/milestones/#{milestone_id}/issues", query: options)
-  end
+    # Gets the issues of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_issues(5, 2)
+    #
+    # @param  [Integer, String] id The ID or name of a group.
+    # @param  [Integer, String] milestone_id The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_milestone_issues(id, milestone_id, options = {})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/issues", query: options)
+    end
 
-  # Gets the merge_requests of a given group milestone.
-  #
-  # @example
-  #   Gitlab.group_milestone_merge_requests(5, 2)
-  #
-  # @param  [Integer, String] group The ID or name of a group.
-  # @param  [Integer, String] milestone_id The ID of a milestone.
-  # @option options [Integer] :page The page number.
-  # @option options [Integer] :per_page The number of results per page.
-  # @return [Array<Gitlab::ObjectifiedHash>]
-  def group_milestone_merge_requests(id, milestone_id, options = {})
-    get("/groups/#{url_encode id}/milestones/#{milestone_id}/merge_requests", query: options)
+    # Gets the merge_requests of a given group milestone.
+    #
+    # @example
+    #   Gitlab.group_milestone_merge_requests(5, 2)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [Integer, String] milestone_id The ID of a milestone.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_milestone_merge_requests(id, milestone_id, options = {})
+      get("/groups/#{url_encode id}/milestones/#{milestone_id}/merge_requests", query: options)
+    end
   end
 end