gitlab 4.5.0 → 5.1.0

data/lib/gitlab/cli_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 require 'base64'
@@ -5,7 +7,7 @@ require 'base64'
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
   module Helpers
-    extend self
+    module_function
 
     # Returns actions available to CLI & Shell
     #
@@ -18,7 +20,7 @@ class Gitlab::CLI
     #
     # @return [Gitlab::Client]
     def client
-      @client ||= Gitlab::Client.new(endpoint: (Gitlab.endpoint || ''))
+      @client ||= Gitlab::Client.new(endpoint: Gitlab.endpoint || '')
     end
 
     # Returns method names and their owners
@@ -37,22 +39,23 @@ class Gitlab::CLI
     #
     # @return [Array]
     def required_fields(args)
-      if args.any? && args.last.is_a?(String) && args.last.start_with?('--only=')
-        args.last.gsub('--only=', '').split(',')
-      else
-        []
-      end
+      filtered_fields(args, '--only=')
     end
 
     # Returns filtered excluded fields.
     #
     # @return [Array]
     def excluded_fields(args)
-      if args.any? && args.last.is_a?(String) && args.last.start_with?('--except=')
-        args.last.gsub('--except=', '').split(',')
-      else
-        []
-      end
+      filtered_fields(args, '--except=')
+    end
+
+    # Returns fields filtered by a keyword.
+    #
+    # @return [Array]
+    def filtered_fields(args, key)
+      return [] unless args.any? && args.last.is_a?(String) && args.last.start_with?(key)
+
+      args.last.gsub(key, '').split(',')
     end
 
     # Confirms command is valid.
@@ -71,7 +74,7 @@ class Gitlab::CLI
 
       puts 'Are you sure? (y/n)'
 
-      if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+      if %w[y yes].include?($stdin.gets.to_s.strip.downcase)
         puts 'Proceeding..'
       else
         puts 'Command aborted.'
@@ -82,7 +85,7 @@ class Gitlab::CLI
     # Gets defined help for a specific command/action.
     #
     # @return [String]
-    def help(cmd=nil, &block)
+    def help(cmd = nil, &block)
       if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
         Gitlab::Help.actions_table(cmd)
       else
@@ -90,14 +93,14 @@ class Gitlab::CLI
       end
     end
 
-    # Outputs a nicely formatted table or error msg.
+    # Outputs a nicely formatted table or error message.
     def output_table(cmd, args, data)
       case data
       when Gitlab::ObjectifiedHash, Gitlab::FileResponse
         puts record_table([data], cmd, args)
       when Gitlab::PaginatedResponse
         puts record_table(data, cmd, args)
-      else # probably just an error msg
+      else # probably just an error message
         puts data
       end
     end
@@ -108,7 +111,7 @@ class Gitlab::CLI
       else
         hash_result = case data
                       when Gitlab::ObjectifiedHash, Gitlab::FileResponse
-                        record_hash([data], cmd, args, true)
+                        record_hash([data], cmd, args, single_value: true)
                       when Gitlab::PaginatedResponse
                         record_hash(data, cmd, args)
                       else
@@ -159,7 +162,7 @@ class Gitlab::CLI
     # @param  [Array]  args         Options passed to the API call
     # @param  [bool]   single_value If set to true, a single result should be returned
     # @return [Hash]   Result hash
-    def record_hash(data, cmd, args, single_value=false)
+    def record_hash(data, cmd, args, single_value: false)
       if data.empty?
         result = nil
       else
@@ -169,21 +172,21 @@ class Gitlab::CLI
           row = {}
 
           keys.each do |key|
-            case hash[key]
-            when Hash
-              row[key] = 'Hash'
-            when StringIO
-              row[key] = Base64.encode64(hash[key].read)
-            when nil
-              row[key] = nil
-            else
-              row[key] = hash[key]
-            end
+            row[key] = case hash[key]
+                       when Hash
+                         'Hash'
+                       when StringIO
+                         Base64.encode64(hash[key].read)
+                       when nil
+                         nil
+                       else
+                         hash[key]
+                       end
           end
 
           result.push row
         end
-        result = result[0] if single_value && result.count > 0
+        result = result[0] if single_value && result.count.positive?
       end
 
       {
@@ -202,36 +205,37 @@ class Gitlab::CLI
     end
 
     # Helper function to call Gitlab commands with args.
-    def gitlab_helper(cmd, args=[])
-      begin
-        data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
-      rescue => e
-        puts e.message
-        yield if block_given?
-      end
-
-      data
+    def gitlab_helper(cmd, args = [])
+      args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
+    rescue StandardError => e
+      puts e.message
+      yield if block_given?
     end
 
     # Convert a hash (recursively) to use symbol hash keys
     # @return [Hash]
     def symbolize_keys(hash)
       if hash.is_a?(Hash)
-        hash = hash.each_with_object({}) do |(key, value), newhash|
-          begin
-            newhash[key.to_sym] = symbolize_keys(value)
-          rescue NoMethodError
-            raise "Error: cannot convert hash key to symbol: #{key}"
-          end
+        hash = hash.each_with_object({}) do |(key, value), new_hash|
+          new_hash[key.to_sym] = symbolize_keys(value)
+        rescue NoMethodError
+          raise "Error: cannot convert hash key to symbol: #{key}"
         end
       end
 
       hash
     end
 
+    # Check if arg is a color in 6-digit hex notation with leading '#' sign
+    def hex_color?(arg)
+      pattern = /\A#\h{6}\Z/
+
+      pattern.match(arg)
+    end
+
     # YAML::load on a single argument
     def yaml_load(arg)
-      YAML.safe_load(arg)
+      hex_color?(arg) ? arg : YAML.safe_load(arg)
     rescue Psych::SyntaxError
       raise "Error: Argument is not valid YAML syntax: #{arg}"
     end

data/lib/gitlab/client/access_requests.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to Award Emojis.
   # @see https://docs.gitlab.com/ce/api/access_requests.html
@@ -12,6 +14,7 @@ class Gitlab::Client
     def project_access_requests(project)
       get("/projects/#{url_encode project}/access_requests")
     end
+
     # Gets a list of access requests for a group viewable by the authenticated user.
     #
     # @example
@@ -22,6 +25,7 @@ class Gitlab::Client
     def group_access_requests(group)
       get("/groups/#{url_encode group}/access_requests")
     end
+
     # Requests access for the authenticated user to a project.
     #
     # @example
@@ -32,6 +36,7 @@ class Gitlab::Client
     def request_project_access(project)
       post("/projects/#{url_encode project}/access_requests")
     end
+
     # Requests access for the authenticated user to a group.
     #
     # @example
@@ -42,6 +47,7 @@ class Gitlab::Client
     def request_group_access(group)
       post("/groups/#{url_encode group}/access_requests")
     end
+
     # Approves a project access request for the given user.
     #
     # @example
@@ -55,6 +61,7 @@ class Gitlab::Client
     def approve_project_access_request(project, user_id, options = {})
       put("/projects/#{url_encode project}/access_requests/#{user_id}/approve", body: options)
     end
+
     # Approves a group access request for the given user.
     #
     # @example
@@ -68,6 +75,7 @@ class Gitlab::Client
     def approve_group_access_request(group, user_id, options = {})
       put("/groups/#{url_encode group}/access_requests/#{user_id}/approve", body: options)
     end
+
     # Denies a project access request for the given user.
     #
     # @example
@@ -79,6 +87,7 @@ class Gitlab::Client
     def deny_project_access_request(project, user_id)
       delete("/projects/#{url_encode project}/access_requests/#{user_id}")
     end
+
     # Denies a group access request for the given user.
     #
     # @example
@@ -91,4 +100,4 @@ class Gitlab::Client
       delete("/groups/#{url_encode group}/access_requests/#{user_id}")
     end
   end
-end
+end

data/lib/gitlab/client/application_settings.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to application settings.
+  # @see https://docs.gitlab.com/ee/api/settings.html
+  module ApplicationSettings
+    # Retrives the application settings of Gitlab.
+    #
+    # @example
+    #   Gitlab.application_settings
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def application_settings
+      get('/application/settings')
+    end
+
+    # Edit the applications settings of Gitlab.
+    #
+    # @example
+    #   Gitlab.edit_application_settings({ signup_enabled: false })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :admin_notification_email
+    # @option options [String] :after_sign_out_path
+    # @option options [String] :after_sign_up_text
+    # @option options [String] :akismet_api_key
+    # @option options [Boolean] :akismet_enabled
+    # @option options [Boolean] :allow_group_owners_to_manage_ldap
+    # @option options [Boolean] :allow_local_requests_from_hooks_and_services
+    # @option options [Boolean] :authorized_keys_enabled
+    # @option options [String] :auto_devops_domain
+    # @option options [Boolean] :auto_devops_enabled
+    # @option options [Boolean] :check_namespace_plan
+    # @option options [String] :clientside_sentry_dsn
+    # @option options [Boolean] :clientside_sentry_enabled
+    # @option options [Integer] :container_registry_token_expire_delay
+    # @option options [String] :default_artifacts_expire_in
+    # @option options [Integer] :default_branch_protection
+    # @option options [String] :default_group_visibility
+    # @option options [String] :default_project_visibility
+    # @option options [Integer] :default_projects_limit
+    # @option options [String] :default_snippet_visibility
+    # @option options [Array<String>] :disabled_oauth_sign_in_sources
+    # @option options [Array<String>] :domain_blacklist
+    # @option options [Boolean] :domain_blacklist_enabled
+    # @option options [Array<String>] :domain_whitelist
+    # @option options [Integer] :dsa_key_restriction
+    # @option options [Integer] :ecdsa_key_restriction
+    # @option options [Integer] :ed25519_key_restriction
+    # @option options [Boolean] :elasticsearch_aws
+    # @option options [String] :elasticsearch_aws_access_key
+    # @option options [String] :elasticsearch_aws_region
+    # @option options [String] :elasticsearch_aws_secret_access_key
+    # @option options [Boolean] :elasticsearch_experimental_indexer
+    # @option options [Boolean] :elasticsearch_indexing
+    # @option options [Boolean] :elasticsearch_search
+    # @option options [String] :elasticsearch_url
+    # @option options [Boolean] :elasticsearch_limit_indexing
+    # @option options [Array<Integer>] :elasticsearch_project_ids
+    # @option options [Array<Integer>] :elasticsearch_namespace_ids
+    # @option options [String] :email_additional_text
+    # @option options [Boolean] :email_author_in_body
+    # @option options [String] :enabled_git_access_protocol
+    # @option options [Boolean] :enforce_terms
+    # @option options [String] :external_auth_client_cert
+    # @option options [String] :external_auth_client_key
+    # @option options [String] :external_auth_client_key_pass
+    # @option options [Boolean] :external_authorization_service_enabled
+    # @option options [String] :external_authorization_service_default_label
+    # @option options [Float] :external_authorization_service_timeout float
+    # @option options [String] :external_authorization_service_url
+    # @option options [Integer] :file_template_project_id
+    # @option options [Integer] :first_day_of_week
+    # @option options [Integer] :geo_status_timeout
+    # @option options [Integer] :gitaly_timeout_default
+    # @option options [Integer] :gitaly_timeout_fast
+    # @option options [Integer] :gitaly_timeout_medium
+    # @option options [Boolean] :gravatar_enabled
+    # @option options [Boolean] :hashed_storage_enabled
+    # @option options [Boolean] :help_page_hide_commercial_content
+    # @option options [String] :help_page_support_url
+    # @option options [String] :help_page_text
+    # @option options [String] :help_text
+    # @option options [Boolean] :hide_third_party_offers
+    # @option options [String] :home_page_url
+    # @option options [Boolean] :housekeeping_bitmaps_enabled
+    # @option options [Boolean] :housekeeping_enabled
+    # @option options [Integer] :housekeeping_full_repack_period
+    # @option options [Integer] :housekeeping_gc_period
+    # @option options [Integer] :housekeeping_incremental_repack_period
+    # @option options [Boolean] :html_emails_enabled
+    # @option options [Boolean] :instance_statistics_visibility_private
+    # @option options [Array<String>] :import_sources
+    # @option options [Integer] :max_artifacts_size
+    # @option options [Integer] :max_attachment_size
+    # @option options [Integer] :max_pages_size
+    # @option options [Boolean] :metrics_enabled
+    # @option options [String] :metrics_host
+    # @option options [Integer] :metrics_method_call_threshold
+    # @option options [Integer] :metrics_packet_size
+    # @option options [Integer] :metrics_pool_size
+    # @option options [Integer] :metrics_port
+    # @option options [Integer] :metrics_sample_interval
+    # @option options [Integer] :metrics_timeout
+    # @option options [Boolean] :mirror_available
+    # @option options [Integer] :mirror_capacity_threshold
+    # @option options [Integer] :mirror_max_capacity
+    # @option options [Integer] :mirror_max_delay
+    # @option options [Boolean] :pages_domain_verification_enabled
+    # @option options [Boolean] :password_authentication_enabled_for_git
+    # @option options [Boolean] :password_authentication_enabled_for_web
+    # @option options [String] :performance_bar_allowed_group_id
+    # @option options [String] :performance_bar_allowed_group_path
+    # @option options [Boolean] :performance_bar_enabled
+    # @option options [Boolean] :plantuml_enabled
+    # @option options [String] :plantuml_url
+    # @option options [Float] :polling_interval_multiplier
+    # @option options [Boolean] :project_export_enabled
+    # @option options [Boolean] :prometheus_metrics_enabled
+    # @option options [Boolean] :pseudonymizer_enabled
+    # @option options [Boolean] :recaptcha_enabled
+    # @option options [String] :recaptcha_private_key
+    # @option options [String] :recaptcha_site_key
+    # @option options [Boolean] :repository_checks_enabled
+    # @option options [Integer] :repository_size_limit
+    # @option options [Array<String>] :repository_storages
+    # @option options [Boolean] :require_two_factor_authentication
+    # @option options [Array<String>] :restricted_visibility_levels
+    # @option options [Integer] :rsa_key_restriction
+    # @option options [Boolean] :send_user_confirmation_email
+    # @option options [String] :sentry_dsn
+    # @option options [Boolean] :sentry_enabled
+    # @option options [Integer] :session_expire_delay
+    # @option options [Boolean] :shared_runners_enabled
+    # @option options [Integer] :shared_runners_minutes
+    # @option options [String] :shared_runners_text
+    # @option options [String] :sign_in_text
+    # @option options [String] :signin_enabled
+    # @option options [Boolean] :signup_enabled
+    # @option options [Boolean] :slack_app_enabled
+    # @option options [String] :slack_app_id
+    # @option options [String] :slack_app_secret
+    # @option options [String] :slack_app_verification_token
+    # @option options [Integer] :terminal_max_session_time
+    # @option options [String] :terms
+    # @option options [Boolean] :throttle_authenticated_api_enabled
+    # @option options [Integer] :throttle_authenticated_api_period_in_seconds
+    # @option options [Integer] :throttle_authenticated_api_requests_per_period
+    # @option options [Boolean] :throttle_authenticated_web_enabled
+    # @option options [Integer] :throttle_authenticated_web_period_in_seconds
+    # @option options [Integer] :throttle_authenticated_web_requests_per_period
+    # @option options [Boolean] :throttle_unauthenticated_enabled
+    # @option options [Integer] :throttle_unauthenticated_period_in_seconds
+    # @option options [Integer] :throttle_unauthenticated_requests_per_period
+    # @option options [Integer] :two_factor_grace_period
+    # @option options [Boolean] :unique_ips_limit_enabled
+    # @option options [Integer] :unique_ips_limit_per_user
+    # @option options [Integer] :unique_ips_limit_time_window
+    # @option options [Boolean] :usage_ping_enabled
+    # @option options [Boolean] :user_default_external
+    # @option options [Boolean] :user_oauth_applications
+    # @option options [Boolean] :user_show_add_ssh_key_message
+    # @option options [Boolean] :version_check_enabled
+    # @option options [Integer] :local_markdown_version
+    # @option options [String] :geo_node_allowed_ips
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def edit_application_settings(options = {})
+      put('/application/settings', body: options)
+    end
+  end
+end

data/lib/gitlab/client/avatar.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to avatar.
+  # @see https://docs.gitlab.com/ce/api/avatar.html
+  module Avatar
+    # Get a single avatar URL for a user with the given email address.
+    #
+    # @example
+    #   Gitlab.avatar(email: 'admin@example.com')
+    #   Gitlab.avatar(email: 'admin@example.com', size: 32)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :email(required) Public email address of the user.
+    # @option options [Integer] :size(optional) Single pixel dimension (since images are squares). Only used for avatar lookups at Gravatar or at the configured Libravatar server.
+    # @return <Gitlab::ObjectifiedHash>
+    def avatar(options = {})
+      get('/avatar', query: options)
+    end
+  end
+end

data/lib/gitlab/client/award_emojis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to Award Emojis.
   # @see https://docs.gitlab.com/ce/api/award_emoji.html
@@ -79,7 +81,7 @@ class Gitlab::Client
     # @param [String] emoji_name The name of the emoji, without colons.
     # @return [Gitlab::ObjectifiedHash]
     def create_award_emoji(project, awardable_id, awardable_type, emoji_name)
-      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: {name: emoji_name})
+      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: { name: emoji_name })
     end
 
     # Awards a new emoji to a note on an awardable(issue, merge request or snippet)
@@ -96,7 +98,7 @@ class Gitlab::Client
     # @param [String] emoji_name The name of the emoji, without colons.
     # @return [Gitlab::ObjectifiedHash]
     def create_note_award_emoji(project, awardable_id, awardable_type, note_id, emoji_name)
-      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: {name: emoji_name})
+      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: { name: emoji_name })
     end
 
     # Deletes a single award emoji from an awardable(issue, merge request or snippet)
@@ -132,4 +134,4 @@ class Gitlab::Client
       delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
     end
   end
-end
+end

data/lib/gitlab/client/boards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Gitlab::Client
   # Defines methods related to issue boards.
   # @see https://docs.gitlab.com/ce/api/boards.html
@@ -13,10 +15,66 @@ class Gitlab::Client
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def boards(project, options={})
+    def boards(project, options = {})
       get("/projects/#{url_encode project}/boards", query: options)
     end
 
+    # Get a single board.
+    #
+    # @example
+    #   Gitlab.board(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [Gitlab::ObjectifiedHash] Returns information about the board
+    def board(project, id)
+      get("/projects/#{url_encode project}/boards/#{id}")
+    end
+
+    # Creates a new board.
+    #
+    # @example
+    #   Gitlab.create_board(5, 'newboard')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] name The name of the new board.
+    # @return [Gitlab::ObjectifiedHash] Information about created board.
+    def create_board(project, name)
+      body = { name: name }
+      post("/projects/#{url_encode project}/boards", body: body)
+    end
+
+    # Updates a board.
+    #
+    # @example
+    #   Gitlab.edit_board(5, 1, name: 'new_name')
+    #   Gitlab.edit_board(5, 1, name: 'new_name', assignee_id: 1, milestone_id: 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name(optional) The new name of the board.
+    # @option options [Integer] :assignee_id(optional) The assignee the board should be scoped to.
+    # @option options [Integer] :milestone_id(optional) The milestone the board should be scoped to.
+    # @option options [String] :labels(optional) Comma-separated list of label names which the board should be scoped to.
+    # @option options [Integer] :weight(optional) The weight range from 0 to 9, to which the board should be scoped to.
+    # @return [Gitlab::ObjectifiedHash] Information about updated board.
+    def edit_board(project, id, options = {})
+      put("/projects/#{url_encode project}/boards/#{id}", body: options)
+    end
+
+    # Deletes a board.
+    #
+    # @example
+    #   Gitlab.delete_board(5, 1)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [void] This API call returns an empty response body.
+    def delete_board(project, id)
+      delete("/projects/#{url_encode project}/boards/#{id}")
+    end
+
     # Gets a board lists
     #
     # @example
@@ -28,6 +86,7 @@ class Gitlab::Client
     def board_lists(project, id)
       get("/projects/#{url_encode project}/boards/#{id}/lists")
     end
+
     #
     # Gets a single board list
     #
@@ -53,7 +112,7 @@ class Gitlab::Client
     # @param  [Integer] label_id The ID of a label.
     # @return [Gitlab::ObjectifiedHash] Information about created list.
     def create_board_list(project, board_id, label_id)
-      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: {label_id: label_id})
+      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: { label_id: label_id })
     end
 
     # Updates a board list.
@@ -67,7 +126,7 @@ class Gitlab::Client
     # @param  [Integer] id The ID of a list.
     # @return [Gitlab::ObjectifiedHash] Information about updated board list.
     def edit_board_list(project, board_id, id, position)
-      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: {position: position})
+      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: { position: position })
     end
 
     # Deletes  a board list.
@@ -85,4 +144,3 @@ class Gitlab::Client
     end
   end
 end
-