gitlab 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 507d4fdc41c5f184840d8831d07c3127220f813c2ff52d8f061b82b579515d2a
-  data.tar.gz: 8e84cda29938364f23063f6762d15d7d0a3f4b81a2cdfb5a7a8fcba56cd1071f
+  metadata.gz: 3b704b0067388d9f794505c41aff708ee8b6e3fc1a9d810a046bb9bfd9ef912c
+  data.tar.gz: a550009e3cb5478f42088268c93b7e800339dcccf071b8d81c223ad4261fdcc5
 SHA512:
-  metadata.gz: '04025787441bfba125d1f60c918e9fb01cbe215f4bdddfcca56253201237e73fdd18153117e49c91147089436b923106853b9a43548463ebb5a3c6764b1fecac'
-  data.tar.gz: 7a3e9cf4f21b93ce1eb8ddf0fc413aab2f3a7e48f2da53455e174ead9ea208da503b1418cd1f20a3c6913a93bf4be5d2aff5bcbb17a4036d54216c05f04d0be6
+  metadata.gz: 18d6a12ea3927fb06da8b86777288a48706b4fc5e1385293f0988485636caa41831bce320ed69fea92660f0dc6de2d70feafb22e5a57a7b10f08cf22e0d905ef
+  data.tar.gz: ab8da4935f0f68c37e8529af7070f9e478e33cab037714b60035796070f143cdf154214be1516713475b044c81986d0e967ab6fae3497f2086e721d5f64e06da

data/README.md

@@ -7,7 +7,7 @@
 [![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/NARKOZ/gitlab/blob/master/LICENSE.txt)
 
 [website](https://narkoz.github.io/gitlab) |
-[documentation](https://rubydoc.info/gems/gitlab/frames) |
+[documentation](https://www.rubydoc.info/gems/gitlab/frames) |
 [gitlab-live](https://github.com/NARKOZ/gitlab-live)
 
 Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://docs.gitlab.com/ce/api/README.html).  
@@ -110,7 +110,7 @@ end
 projects.auto_paginate
 ```
 
-For more information, refer to [documentation](https://rubydoc.info/gems/gitlab/frames).
+For more information, refer to [documentation](https://www.rubydoc.info/gems/gitlab/frames).
 
 ## CLI
 

data/lib/gitlab/cli.rb

@@ -8,9 +8,6 @@ require_relative 'shell'
 class Gitlab::CLI
   extend Helpers
 
-  # If set to true, JSON will be rendered as output
-  @render_json = false
-
   # Starts a new CLI session.
   #
   # @example

data/lib/gitlab/cli_helpers.rb

@@ -39,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.

data/lib/gitlab/client.rb

@@ -7,6 +7,7 @@ module Gitlab
 
     # Please keep in alphabetical order
     include AccessRequests
+    include ApplicationSettings
     include Avatar
     include AwardEmojis
     include Boards

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/projects.rb

@@ -67,7 +67,7 @@ class Gitlab::Client
     # @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :snippets_enabled The snippets integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true).
-    # @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true).
+    # @option options [String] :visibility The setting for making a project public ('private', 'internal', 'public').
     # @option options [Integer] :user_id The user/owner id of a project.
     # @return [Gitlab::ObjectifiedHash] Information about created project.
     def create_project(name, options = {})
@@ -570,5 +570,27 @@ class Gitlab::Client
     def project_template(project, type, key, options = {})
       get("/projects/#{url_encode project}/templates/#{type}/#{key}", query: options)
     end
+
+    # Archives a project.
+    #
+    # @example
+    #   Gitlab.archive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about archived project.
+    def archive_project(id)
+      post("/projects/#{url_encode id}/archive")
+    end
+
+    # Unarchives a project.
+    #
+    # @example
+    #   Gitlab.unarchive_project(4)
+    #
+    # @param  [Integer, String] id The ID or path of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about unarchived project.
+    def unarchive_project(id)
+      post("/projects/#{url_encode id}/unarchive")
+    end
   end
 end

data/lib/gitlab/client/repositories.rb

@@ -28,9 +28,10 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] ref The commit sha, branch, or tag to download.
+    # @param  [String] format The archive format. Options are: tar.gz (default), tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip
     # @return [Gitlab::FileResponse]
-    def repo_archive(project, ref = 'master')
-      get("/projects/#{url_encode project}/repository/archive",
+    def repo_archive(project, ref = 'master', format = 'tar.gz')
+      get("/projects/#{url_encode project}/repository/archive.#{format}",
           format: nil,
           headers: { Accept: 'application/octet-stream' },
           query: { sha: ref },

data/lib/gitlab/error.rb

@@ -95,6 +95,9 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 405.
     class MethodNotAllowed < ResponseError; end
 
+    # Raised when API endpoint returns the HTTP status code 406.
+    class NotAcceptable < ResponseError; end
+
     # Raised when API endpoint returns the HTTP status code 409.
     class Conflict < ResponseError; end
 
@@ -112,5 +115,21 @@ module Gitlab
 
     # Raised when API endpoint returns the HTTP status code 503.
     class ServiceUnavailable < ResponseError; end
+
+    # HTTP status codes mapped to error classes.
+    STATUS_MAPPINGS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable
+    }.freeze
   end
 end

data/lib/gitlab/paginated_response.rb

@@ -56,6 +56,25 @@ module Gitlab
       response
     end
 
+    def paginate_with_limit(limit)
+      response = block_given? ? nil : []
+      count = 0
+      each_page do |page|
+        if block_given?
+          page.each do |item|
+            yield item
+            count += 1
+            break if count >= limit
+          end
+        else
+          response += page[0, limit - count]
+          count = response.length
+        end
+        break if count >= limit
+      end
+      response
+    end
+
     def last_page?
       !(@links.nil? || @links.last.nil?)
     end

data/lib/gitlab/request.rb

@@ -50,20 +50,7 @@ module Gitlab
     # Checks the response code for common errors.
     # Returns parsed response for successful requests.
     def validate(response)
-      error_klass = case response.code
-                    when 400 then Error::BadRequest
-                    when 401 then Error::Unauthorized
-                    when 403 then Error::Forbidden
-                    when 404 then Error::NotFound
-                    when 405 then Error::MethodNotAllowed
-                    when 409 then Error::Conflict
-                    when 422 then Error::Unprocessable
-                    when 429 then Error::TooManyRequests
-                    when 500 then Error::InternalServerError
-                    when 502 then Error::BadGateway
-                    when 503 then Error::ServiceUnavailable
-                    end
-
+      error_klass = Error::STATUS_MAPPINGS[response.code]
       raise error_klass, response if error_klass
 
       parsed = response.parsed_response

data/lib/gitlab/shell_history.rb

@@ -30,12 +30,8 @@ class Gitlab::Shell
     private
 
     def history_file
-      if defined?(@history_file)
-        @history_file
-      else
-        @history_file = File.open(history_file_path, 'w', 0o600).tap do |file|
-          file.sync = true
-        end
+      @history_file ||= File.open(history_file_path, 'w', 0o600).tap do |file|
+        file.sync = true
       end
     rescue Errno::EACCES
       warn 'History not saved; unable to open your history file for writing.'

data/lib/gitlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gitlab
-  VERSION = '4.11.0'
+  VERSION = '4.12.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -140,6 +140,7 @@ files:
 - lib/gitlab/cli_helpers.rb
 - lib/gitlab/client.rb
 - lib/gitlab/client/access_requests.rb
+- lib/gitlab/client/application_settings.rb
 - lib/gitlab/client/avatar.rb
 - lib/gitlab/client/award_emojis.rb
 - lib/gitlab/client/boards.rb
@@ -223,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API