fs-gitlab 4.18.1

data/lib/gitlab/cli.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+require 'terminal-table/import'
+require_relative 'cli_helpers'
+require_relative 'shell'
+
+class Gitlab::CLI
+  extend Helpers
+
+  # Starts a new CLI session.
+  #
+  # @example
+  #   Gitlab::CLI.start(['help'])
+  #   Gitlab::CLI.start(['help', 'issues'])
+  #
+  # @param [Array] args The command and it's optional arguments.
+  def self.start(args)
+    command = begin
+      args.shift.strip
+    rescue StandardError
+      'help'
+    end
+    run(command, args)
+  end
+
+  # Processes a CLI command and outputs a result to the stream (stdout).
+  #
+  # @example
+  #   Gitlab::CLI.run('help')
+  #   Gitlab::CLI.run('help', ['issues'])
+  #
+  # @param [String] cmd The name of a command.
+  # @param [Array] args The optional arguments for a command.
+  # @return [nil]
+  def self.run(cmd, args = [])
+    case cmd
+    when 'help'
+      puts help(args.shift) { |out| out.gsub!(/Gitlab\./, 'gitlab ') }
+    when 'info'
+      endpoint = Gitlab.endpoint || 'not set'
+      private_token = Gitlab.private_token || 'not set'
+      puts "Gitlab endpoint is #{endpoint}"
+      puts "Gitlab private token is #{private_token}"
+      puts "Ruby Version is #{RUBY_VERSION}"
+      puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+    when '-v', '--version'
+      puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+    when 'shell'
+      Gitlab::Shell.start
+    else
+      if args.include? '--json'
+        @json_output = true
+        args.delete '--json'
+      end
+
+      unless valid_command?(cmd)
+        puts 'Unknown command. Run `gitlab help` for a list of available commands.'
+        exit(0) if ENV['CI'] # FIXME: workaround to exit with 0 on passed specs
+        exit(1)
+      end
+
+      command_args = args.any? && args.last.start_with?('--only=', '--except=') ? args[0..-2] : args
+
+      begin
+        command_args.map! { |arg| symbolize_keys(yaml_load(arg)) }
+      rescue StandardError => e
+        puts e.message
+        exit 1
+      end
+
+      confirm_command(cmd)
+
+      data = gitlab_helper(cmd, command_args) { exit(1) }
+
+      render_output(cmd, args, data)
+    end
+  end
+
+  # Helper method that checks whether we want to get the output as json
+  # @return [nil]
+  def self.render_output(cmd, args, data)
+    if defined?(@json_output) && @json_output
+      output_json(cmd, args, data)
+    else
+      output_table(cmd, args, data)
+    end
+  end
+end

data/lib/gitlab/cli_helpers.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'json'
+require 'base64'
+
+class Gitlab::CLI
+  # Defines methods related to CLI output and formatting.
+  module Helpers
+    module_function
+
+    # Returns actions available to CLI & Shell
+    #
+    # @return [Array]
+    def actions
+      @actions ||= Gitlab.actions
+    end
+
+    # Returns Gitlab::Client instance
+    #
+    # @return [Gitlab::Client]
+    def client
+      @client ||= Gitlab::Client.new(endpoint: (Gitlab.endpoint || ''))
+    end
+
+    # Returns method names and their owners
+    #
+    # @return [Array<Hash>]
+    def method_owners
+      @method_owners ||= actions.map do |action|
+        {
+          name: action.to_s,
+          owner: client.method(action).owner.to_s
+        }
+      end
+    end
+
+    # Returns filtered required fields.
+    #
+    # @return [Array]
+    def required_fields(args)
+      filtered_fields(args, '--only=')
+    end
+
+    # Returns filtered excluded fields.
+    #
+    # @return [Array]
+    def excluded_fields(args)
+      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.
+    #
+    # @return [Boolean]
+    def valid_command?(cmd)
+      command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
+      Gitlab.actions.include?(command)
+    end
+
+    # Confirms command with a desctructive action.
+    #
+    # @return [String]
+    def confirm_command(cmd)
+      return unless cmd.start_with?('remove_', 'delete_')
+
+      puts 'Are you sure? (y/n)'
+
+      if %w[y yes].include?($stdin.gets.to_s.strip.downcase)
+        puts 'Proceeding..'
+      else
+        puts 'Command aborted.'
+        exit(1)
+      end
+    end
+
+    # Gets defined help for a specific command/action.
+    #
+    # @return [String]
+    def help(cmd = nil, &block)
+      if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
+        Gitlab::Help.actions_table(cmd)
+      else
+        Gitlab::Help.get_help(cmd, &block)
+      end
+    end
+
+    # 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 message
+        puts data
+      end
+    end
+
+    def output_json(cmd, args, data)
+      if data.respond_to?(:empty?) && data.empty?
+        puts '{}'
+      else
+        hash_result = case data
+                      when Gitlab::ObjectifiedHash, Gitlab::FileResponse
+                        record_hash([data], cmd, args, single_value: true)
+                      when Gitlab::PaginatedResponse
+                        record_hash(data, cmd, args)
+                      else
+                        { cmd: cmd, data: data, args: args }
+                      end
+        puts JSON.pretty_generate(hash_result)
+      end
+    end
+
+    # Table to display records.
+    #
+    # @return [Terminal::Table]
+    def record_table(data, cmd, args)
+      return 'No data' if data.empty?
+
+      arr, keys = get_keys(args, data)
+
+      table do |t|
+        t.title = "Gitlab.#{cmd} #{args.join(', ')}"
+        t.headings = keys
+
+        arr.each_with_index do |hash, index|
+          values = []
+
+          keys.each do |key|
+            case value = hash[key]
+            when Hash
+              value = value.key?('id') ? value['id'] : 'Hash'
+            when StringIO
+              value = 'File'
+            when nil
+              value = 'null'
+            end
+
+            values << value
+          end
+
+          t.add_row values
+          t.add_separator unless arr.size - 1 == index
+        end
+      end
+    end
+
+    # Renders the result of given commands and arguments into a Hash
+    #
+    # @param  [Array]  data         Resultset from the API call
+    # @param  [String] cmd          The command passed to the API
+    # @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)
+      if data.empty?
+        result = nil
+      else
+        arr, keys = get_keys(args, data)
+        result = []
+        arr.each do |hash|
+          row = {}
+
+          keys.each do |key|
+            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.positive?
+      end
+
+      {
+        cmd: "Gitlab.#{cmd} #{args.join(', ')}".strip,
+        result: result
+      }
+    end
+
+    # Helper function to get rows and keys from data returned from API call
+    def get_keys(args, data)
+      arr = data.map(&:to_h)
+      keys = arr.first.keys.sort_by(&:to_s)
+      keys &= required_fields(args) if required_fields(args).any?
+      keys -= excluded_fields(args)
+      [arr, keys]
+    end
+
+    # Helper function to call Gitlab commands with args.
+    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), 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)
+      hex_color?(arg) ? arg : YAML.safe_load(arg)
+    rescue Psych::SyntaxError
+      raise "Error: Argument is not valid YAML syntax: #{arg}"
+    end
+  end
+end

data/lib/gitlab/client/access_requests.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to Award Emojis.
+  # @see https://docs.gitlab.com/ce/api/access_requests.html
+  module AccessRequests
+    # Gets a list of access requests for a project viewable by the authenticated user.
+    #
+    # @example
+    #   Gitlab.project_access_requests(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of project access requests
+    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
+    #   Gitlab.group_access_requests(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of group access requests
+    def group_access_requests(group)
+      get("/groups/#{url_encode group}/access_requests")
+    end
+
+    # Requests access for the authenticated user to a project.
+    #
+    # @example
+    #    Gitlab.request_project_access(1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested project access
+    def request_project_access(project)
+      post("/projects/#{url_encode project}/access_requests")
+    end
+
+    # Requests access for the authenticated user to a group.
+    #
+    # @example
+    #    Gitlab.request_group_access(1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @return <Gitlab::ObjectifiedHash] Information about the requested group access
+    def request_group_access(group)
+      post("/groups/#{url_encode group}/access_requests")
+    end
+
+    # Approves a project access request for the given user.
+    #
+    # @example
+    #    Gitlab.approve_project_access_request(1, 1)
+    #    Gitlab.approve_project_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved project access request
+    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
+    #    Gitlab.approve_group_access_request(1, 1)
+    #    Gitlab.approve_group_access_request(1, 1, {access_level: '30'})
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @option options [Integer] :access_level(optional) A valid access level (defaults: 30, developer access level)
+    # @return <Gitlab::ObjectifiedHash] Information about the approved group access request
+    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
+    #    Gitlab.deny_project_access_request(1, 1)
+    #
+    # @param  [Integer, String] :project(required) The ID or name of a project.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    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
+    #    Gitlab.deny_group_access_request(1, 1)
+    #
+    # @param  [Integer, String] :group(required) The ID or name of a group.
+    # @param  [Integer] :user_id(required) The user ID of the access requester
+    # @return [void] This API call returns an empty response body.
+    def deny_group_access_request(group, user_id)
+      delete("/groups/#{url_encode group}/access_requests/#{user_id}")
+    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