gitlab 4.5.0 → 4.6.0

data/lib/gitlab/client/services.rb

@@ -1,50 +1,51 @@
-class Gitlab::Client
-  # Third party services connected to a project.
-  # @see https://docs.gitlab.com/ce/api/services.html
-  module Services
-    # Create/Edit service
-    # Full service params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/services.md
-    #
-    # @example
-    #   Gitlab.change_service(42, :redmine, { new_issue_url: 'https://example.com/projects/test_project/issues/new',
-    #                                         project_url: 'https://example.com/projects/test_project/issues',
-    #                                         issues_url: 'https://example.com/issues/:id' })
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] service A service code name.
-    # @param  [Hash] params A service parameters.
-    # @return [Boolean]
-    def change_service(project, service, params)
-      put("/projects/#{url_encode project}/services/#{correct_service_name(service)}", body: params)
-    end
+# frozen_string_literal: true
 
-    # Delete service
-    #
-    # @example
-    #   Gitlab.delete_service(42, :redmine)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] service A service code name.
-    # @return [Boolean]
-    def delete_service(project, service)
-      delete("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
-    end
+# Third party services connected to a project.
+# @see https://docs.gitlab.com/ce/api/services.html
+module Services
+  # Create/Edit service
+  # Full service params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/services.md
+  #
+  # @example
+  #   Gitlab.change_service(42, :redmine, { new_issue_url: 'https://example.com/projects/test_project/issues/new',
+  #                                         project_url: 'https://example.com/projects/test_project/issues',
+  #                                         issues_url: 'https://example.com/issues/:id' })
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] service A service code name.
+  # @param  [Hash] params A service parameters.
+  # @return [Boolean]
+  def change_service(project, service, params)
+    put("/projects/#{url_encode project}/services/#{correct_service_name(service)}", body: params)
+  end
+
+  # Delete service
+  #
+  # @example
+  #   Gitlab.delete_service(42, :redmine)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] service A service code name.
+  # @return [Boolean]
+  def delete_service(project, service)
+    delete("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
+  end
+
+  # Get service
+  #
+  # @example
+  #   Gitlab.service(42, :redmine)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [String] service A service code name.
+  # @return [Gitlab::ObjectifiedHash]
+  def service(project, service)
+    get("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
+  end
 
-    # Get service
-    #
-    # @example
-    #   Gitlab.service(42, :redmine)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] service A service code name.
-    # @return [Gitlab::ObjectifiedHash]
-    def service(project, service)
-      get("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
-    end
+  private
 
-    private
-    def correct_service_name(service)
-      service.to_s.gsub('_', '-')
-    end
+  def correct_service_name(service)
+    service.to_s.tr('_', '-')
   end
 end

data/lib/gitlab/client/sidekiq.rb

@@ -1,37 +1,37 @@
-class Gitlab::Client
-  # Defines methods related to sidekiq metrics.
-  # @see https://docs.gitlab.com/ce/api/sidekiq_metrics.html
-  module Sidekiq
-    # Get the current Queue Metrics
-    #
-    # @example
-    #   Gitlab.sidekiq_queue_metrics
-    def sidekiq_queue_metrics
-      get('/sidekiq/queue_metrics')
-    end
+# frozen_string_literal: true
 
-    # Get the current Process Metrics
-    #
-    # @example
-    #   Gitlab.sidekiq_process_metrics
-    def sidekiq_process_metrics
-      get('/sidekiq/process_metrics')
-    end
+# Defines methods related to sidekiq metrics.
+# @see https://docs.gitlab.com/ce/api/sidekiq_metrics.html
+module Sidekiq
+  # Get the current Queue Metrics
+  #
+  # @example
+  #   Gitlab.sidekiq_queue_metrics
+  def sidekiq_queue_metrics
+    get('/sidekiq/queue_metrics')
+  end
+
+  # Get the current Process Metrics
+  #
+  # @example
+  #   Gitlab.sidekiq_process_metrics
+  def sidekiq_process_metrics
+    get('/sidekiq/process_metrics')
+  end
 
-    # Get the current Job Statistics
-    #
-    # @example
-    #   Gitlab.sidekiq_job_stats
-    def sidekiq_job_stats
-      get('/sidekiq/job_stats')
-    end
+  # Get the current Job Statistics
+  #
+  # @example
+  #   Gitlab.sidekiq_job_stats
+  def sidekiq_job_stats
+    get('/sidekiq/job_stats')
+  end
 
-    # Get a compound response of all the previously mentioned metrics
-    #
-    # @example
-    #   Gitlab.sidekiq_compound_metrics
-    def sidekiq_compound_metrics
-      get('/sidekiq/compound_metrics')
-    end
+  # Get a compound response of all the previously mentioned metrics
+  #
+  # @example
+  #   Gitlab.sidekiq_compound_metrics
+  def sidekiq_compound_metrics
+    get('/sidekiq/compound_metrics')
   end
 end

data/lib/gitlab/client/snippets.rb

@@ -1,93 +1,93 @@
-class Gitlab::Client
-  # Defines methods related to snippets.
-  # @see https://docs.gitlab.com/ce/api/project_snippets.html
-  module Snippets
-    # Gets a list of project's snippets.
-    #
-    # @example
-    #   Gitlab.snippets(42)
-    #
-    # @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 [Gitlab::ObjectifiedHash]
-    def snippets(project, options={})
-      get("/projects/#{url_encode project}/snippets", query: options)
-    end
+# frozen_string_literal: true
 
-    # Gets information about a snippet.
-    #
-    # @example
-    #   Gitlab.snippet(2, 14)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Integer] id The ID of a snippet.
-    # @return [Gitlab::ObjectifiedHash]
-    def snippet(project, id)
-      get("/projects/#{url_encode project}/snippets/#{id}")
-    end
+# Defines methods related to snippets.
+# @see https://docs.gitlab.com/ce/api/project_snippets.html
+module Snippets
+  # Gets a list of project's snippets.
+  #
+  # @example
+  #   Gitlab.snippets(42)
+  #
+  # @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 [Gitlab::ObjectifiedHash]
+  def snippets(project, options = {})
+    get("/projects/#{url_encode project}/snippets", query: options)
+  end
+
+  # Gets information about a snippet.
+  #
+  # @example
+  #   Gitlab.snippet(2, 14)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Integer] id The ID of a snippet.
+  # @return [Gitlab::ObjectifiedHash]
+  def snippet(project, id)
+    get("/projects/#{url_encode project}/snippets/#{id}")
+  end
 
-    # Creates a new snippet.
-    #
-    # @example
-    #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code', visibility: 'public'})
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :title (required) The title of a snippet.
-    # @option options [String] :file_name (required) The name of a snippet file.
-    # @option options [String] :code (required) The content of a snippet.
-    # @option options [String] :lifetime (optional) The expiration date of a snippet.
-    # @option options [String] :visibility (required) The visibility of a snippet
-    # @return [Gitlab::ObjectifiedHash] Information about created snippet.
-    def create_snippet(project, options={})
-      post("/projects/#{url_encode project}/snippets", body: options)
-    end
+  # Creates a new snippet.
+  #
+  # @example
+  #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code', visibility: 'public'})
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :title (required) The title of a snippet.
+  # @option options [String] :file_name (required) The name of a snippet file.
+  # @option options [String] :code (required) The content of a snippet.
+  # @option options [String] :lifetime (optional) The expiration date of a snippet.
+  # @option options [String] :visibility (required) The visibility of a snippet
+  # @return [Gitlab::ObjectifiedHash] Information about created snippet.
+  def create_snippet(project, options = {})
+    post("/projects/#{url_encode project}/snippets", body: options)
+  end
 
-    # Updates a snippet.
-    #
-    # @example
-    #   Gitlab.edit_snippet(42, 34, { file_name: 'README.txt' })
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Integer] id The ID of a snippet.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :title The title of a snippet.
-    # @option options [String] :file_name The name of a snippet file.
-    # @option options [String] :code The content of a snippet.
-    # @option options [String] :lifetime The expiration date of a snippet.
-    # @option options [String] :visibility (optional) The visibility of a snippet
-    # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
-    def edit_snippet(project, id, options={})
-      put("/projects/#{url_encode project}/snippets/#{id}", body: options)
-    end
+  # Updates a snippet.
+  #
+  # @example
+  #   Gitlab.edit_snippet(42, 34, { file_name: 'README.txt' })
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Integer] id The ID of a snippet.
+  # @param  [Hash] options A customizable set of options.
+  # @option options [String] :title The title of a snippet.
+  # @option options [String] :file_name The name of a snippet file.
+  # @option options [String] :code The content of a snippet.
+  # @option options [String] :lifetime The expiration date of a snippet.
+  # @option options [String] :visibility (optional) The visibility of a snippet
+  # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
+  def edit_snippet(project, id, options = {})
+    put("/projects/#{url_encode project}/snippets/#{id}", body: options)
+  end
 
-    # Deletes a snippet.
-    #
-    # @example
-    #   Gitlab.delete_snippet(2, 14)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Integer] id The ID of a snippet.
-    # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
-    def delete_snippet(project, id)
-      delete("/projects/#{url_encode project}/snippets/#{id}")
-    end
+  # Deletes a snippet.
+  #
+  # @example
+  #   Gitlab.delete_snippet(2, 14)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Integer] id The ID of a snippet.
+  # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
+  def delete_snippet(project, id)
+    delete("/projects/#{url_encode project}/snippets/#{id}")
+  end
 
-    # Returns raw project snippet content as plain text.
-    #
-    # @example
-    #   Gitlab.snippet_content(2, 14)
-    #
-    # @param  [Integer, String] project The ID or name of a project.
-    # @param  [Integer] id The ID of a snippet.
-    # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
-    def snippet_content(project, id)
-      get("/projects/#{url_encode project}/snippets/#{id}/raw",
-          format: nil,
-          headers: { Accept: 'text/plain' },
-          parser: ::Gitlab::Request::Parser)
-    end
+  # Returns raw project snippet content as plain text.
+  #
+  # @example
+  #   Gitlab.snippet_content(2, 14)
+  #
+  # @param  [Integer, String] project The ID or name of a project.
+  # @param  [Integer] id The ID of a snippet.
+  # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
+  def snippet_content(project, id)
+    get("/projects/#{url_encode project}/snippets/#{id}/raw",
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser)
   end
 end

data/lib/gitlab/client/system_hooks.rb

@@ -1,62 +1,62 @@
-class Gitlab::Client
-  # Defines methods related to system hooks.
-  # @see https://docs.gitlab.com/ce/api/system_hooks.html
-  module SystemHooks
-    # Gets a list of system hooks.
-    #
-    # @example
-    #   Gitlab.hooks
-    #   Gitlab.system_hooks
-    #
-    # @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 hooks(options={})
-      get("/hooks", query: options)
-    end
-    alias_method :system_hooks, :hooks
+# frozen_string_literal: true
 
-    # Adds a new system hook.
-    #
-    # @example
-    #   Gitlab.add_hook('http://example.com/hook')
-    #   Gitlab.add_system_hook('https://api.example.net/v1/hook')
-    #
-    # @param  [String] url The hook URL.
-    # @param  [Hash] options Additional options, as allowed by Gitlab API, including but not limited to:
-    # @option options [String] :token A secret token for Gitlab to send in the `X-Gitlab-Token` header for authentication.
-    # @option options [boolean] :enable_ssl_verification `false` will cause Gitlab to ignore invalid/unsigned certificate errors (default is `true`)
-    # @return [Gitlab::ObjectifiedHash]
-    def add_hook(url, options = {})
-      post("/hooks", body: options.merge(url: url))
-    end
-    alias_method :add_system_hook, :add_hook
+# Defines methods related to system hooks.
+# @see https://docs.gitlab.com/ce/api/system_hooks.html
+module SystemHooks
+  # Gets a list of system hooks.
+  #
+  # @example
+  #   Gitlab.hooks
+  #   Gitlab.system_hooks
+  #
+  # @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 hooks(options = {})
+    get('/hooks', query: options)
+  end
+  alias system_hooks hooks
+
+  # Adds a new system hook.
+  #
+  # @example
+  #   Gitlab.add_hook('http://example.com/hook')
+  #   Gitlab.add_system_hook('https://api.example.net/v1/hook')
+  #
+  # @param  [String] url The hook URL.
+  # @param  [Hash] options Additional options, as allowed by Gitlab API, including but not limited to:
+  # @option options [String] :token A secret token for Gitlab to send in the `X-Gitlab-Token` header for authentication.
+  # @option options [boolean] :enable_ssl_verification `false` will cause Gitlab to ignore invalid/unsigned certificate errors (default is `true`)
+  # @return [Gitlab::ObjectifiedHash]
+  def add_hook(url, options = {})
+    post('/hooks', body: options.merge(url: url))
+  end
+  alias add_system_hook add_hook
 
-    # Tests a system hook.
-    #
-    # @example
-    #   Gitlab.hook(3)
-    #   Gitlab.system_hook(12)
-    #
-    # @param  [Integer] id The ID of a system hook.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def hook(id)
-      get("/hooks/#{id}")
-    end
-    alias_method :system_hook, :hook
+  # Tests a system hook.
+  #
+  # @example
+  #   Gitlab.hook(3)
+  #   Gitlab.system_hook(12)
+  #
+  # @param  [Integer] id The ID of a system hook.
+  # @return [Array<Gitlab::ObjectifiedHash>]
+  def hook(id)
+    get("/hooks/#{id}")
+  end
+  alias system_hook hook
 
-    # Deletes a new system hook.
-    #
-    # @example
-    #   Gitlab.delete_hook(3)
-    #   Gitlab.delete_system_hook(12)
-    #
-    # @param  [Integer] id The ID of a system hook.
-    # @return [Gitlab::ObjectifiedHash]
-    def delete_hook(id)
-      delete("/hooks/#{id}")
-    end
-    alias_method :delete_system_hook, :delete_hook
+  # Deletes a new system hook.
+  #
+  # @example
+  #   Gitlab.delete_hook(3)
+  #   Gitlab.delete_system_hook(12)
+  #
+  # @param  [Integer] id The ID of a system hook.
+  # @return [Gitlab::ObjectifiedHash]
+  def delete_hook(id)
+    delete("/hooks/#{id}")
   end
+  alias delete_system_hook delete_hook
 end