gitlab 4.8.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fef48a733afd37fc66b1b532365e9ec319f9c851be914a9f98396d02f185a90e
-  data.tar.gz: 6c11890061b7f83d161b9d3e18432192e01900c2edde6ce9124db5e9e0d2671f
+  metadata.gz: eea71e433b574497741d1e8f523d6a2a61c4fb423d821b7d3424a4cde6adadc3
+  data.tar.gz: ec2829e6dc0a9efa88568389bb11dba0290b4e7bec476d790203afa915e633f9
 SHA512:
-  metadata.gz: 8feed2cfadd99b265276e07b3aa16a0b32b2cf51fb79f00fa290b044c993c812148cdd563bea0524edc32c42e3693bb293129a8b1589e429880e7e46825f67d7
-  data.tar.gz: 7b2219621584d7ecb2ad3c6359adaab056c7d63b1c9a8cd805cd79eb3e39c2a353ddf762c5e55907e958b76b90fc5515463ae77275a7e87e181dd39d2ce688c8
+  metadata.gz: 14a2e907533256d02b6b1524c6cd25ced84dfe16ed8bed1298c85ae024adcf2c939548eedba23cd3a34865e435aaee8ed2de2cc05d6ad5e5aa9899ef01e81abc
+  data.tar.gz: 03ece4a5d5801a7e263c450c6164d260b0abd92f8973cf352f729e66740464f64b9836c85d3ad111a8234bb99ff3eea2738cc2f9e213d85dc8eada4f50852174

data/README.md

@@ -7,11 +7,11 @@
 [![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).  
-As of version `4.0.0` this gem only supports Ruby 2.0+ and GitLab API v4.
+As of version `4.0.0` this gem only supports GitLab API v4.
 
 ## Installation
 
@@ -40,7 +40,7 @@ Configuration example:
 
 ```ruby
 Gitlab.configure do |config|
-  config.endpoint       = 'https://example.net/api/v4' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
+  config.endpoint       = 'https://example.net/api/v4' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
   config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
   # Optional
   # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Gitlab Ruby Gem [version]'
@@ -72,8 +72,14 @@ ENV['GITLAB_API_HTTPARTY_OPTIONS'] = '{read_timeout: 60}'
 Gitlab.projects(per_page: 5)
 # => [#<Gitlab::ObjectifiedHash:0x000000023326e0 @data={"id"=>1, "code"=>"brute", "name"=>"Brute", "description"=>nil, "path"=>"brute", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002331600 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:56Z"}>, #<Gitlab::ObjectifiedHash:0x000000023450d8 @data={"id"=>2, "code"=>"mozart", "name"=>"Mozart", "description"=>nil, "path"=>"mozart", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x00000002344ca0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:57Z"}>, #<Gitlab::ObjectifiedHash:0x00000002344958 @data={"id"=>3, "code"=>"gitlab", "name"=>"Gitlab", "description"=>nil, "path"=>"gitlab", "default_branch"=>nil, "owner"=>#<Gitlab::ObjectifiedHash:0x000000023447a0 @data={"id"=>1, "email"=>"john@example.com", "name"=>"John Smith", "blocked"=>false, "created_at"=>"2012-09-17T09:41:56Z"}>, "private"=>true, "issues_enabled"=>true, "merge_requests_enabled"=>true, "wall_enabled"=>true, "wiki_enabled"=>true, "created_at"=>"2012-09-17T09:41:58Z"}>]
 
-# initialize a new client
-g = Gitlab.client(endpoint: 'https://api.example.com', private_token: 'qEsq1pt6HJPaNciie3MG')
+# initialize a new client with custom headers
+g = Gitlab.client(
+  endpoint: 'https://example.com/api/v4',
+  private_token: 'qEsq1pt6HJPaNciie3MG',
+  httparty: {
+    headers: { 'Cookie' => 'gitlab_canary=true' }
+  }
+)
 # => #<Gitlab::Client:0x00000001e62408 @endpoint="https://api.example.com", @private_token="qEsq1pt6HJPaNciie3MG", @user_agent="Gitlab Ruby Gem 2.0.0">
 
 # get a user
@@ -110,14 +116,14 @@ 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
 
 It is possible to use this gem as a command line interface to GitLab. In order to make that work you need to set a few environment variables:
 ```sh
 export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
-export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
+export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account or /profile/personal_access_tokens in newer version>
 # This one is optional and can be used to set any HTTParty option you may need
 # using YAML hash syntax. For example, this is how you would disable SSL
 # verification (useful if using a self-signed cert).

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,8 @@ module Gitlab
 
     # Please keep in alphabetical order
     include AccessRequests
+    include ApplicationSettings
+    include Avatar
     include AwardEmojis
     include Boards
     include Branches
@@ -14,15 +16,23 @@ module Gitlab
     include BuildVariables
     include Builds
     include Commits
+    include ContainerRegistry
     include Deployments
     include Environments
+    include Epics
     include Events
+    include Features
+    include GroupBoards
+    include GroupLabels
     include GroupMilestones
     include Groups
+    include IssueLinks
     include Issues
     include Jobs
     include Keys
     include Labels
+    include Lint
+    include Markdown
     include MergeRequestApprovals
     include MergeRequests
     include Milestones
@@ -32,12 +42,17 @@ module Gitlab
     include PipelineTriggers
     include Pipelines
     include ProjectBadges
+    include ProjectClusters
+    include ProjectReleaseLinks
+    include ProjectReleases
     include Projects
     include ProtectedTags
     include Repositories
     include RepositoryFiles
     include RepositorySubmodules
+    include ResourceLabelEvents
     include Runners
+    include Search
     include Services
     include Sidekiq
     include Snippets

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

@@ -19,6 +19,62 @@ class Gitlab::Client
       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

data/lib/gitlab/client/build_variables.rb

@@ -2,8 +2,8 @@
 
 class Gitlab::Client
   # Defines methods related to builds.
-  # @see https://docs.gitlab.com/ce/api/build_variables.html
-  # @see https://docs.gitlab.com/ee/api/group_level_variables.html
+  # @see https://docs.gitlab.com/ce/api/project_level_variables.html
+  # @see https://docs.gitlab.com/ce/api/group_level_variables.html
   module BuildVariables
     # Gets a list of the project's build variables
     #
@@ -36,9 +36,10 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
     # @param  [String] value The value of a variable
+    # @param  [Hash] opts optional parameters
     # @return [Gitlab::ObjectifiedHash] The variable.
-    def create_variable(project, key, value)
-      post("/projects/#{url_encode project}/variables", body: { key: key, value: value })
+    def create_variable(project, key, value, **opts)
+      post("/projects/#{url_encode project}/variables", body: opts.merge(key: key, value: value))
     end
 
     # Update a project's build variable.
@@ -49,9 +50,10 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] key The key of a variable
     # @param  [String] value The value of a variable
+    # @param  [Hash] opts optional parameters
     # @return [Gitlab::ObjectifiedHash] The variable.
-    def update_variable(project, key, value)
-      put("/projects/#{url_encode project}/variables/#{key}", body: { value: value })
+    def update_variable(project, key, value, **opts)
+      put("/projects/#{url_encode project}/variables/#{key}", body: opts.merge(value: value))
     end
 
     # Remove a project's build variable.
@@ -97,9 +99,10 @@ class Gitlab::Client
     # @param  [Integer, String] group The ID or name of a group.
     # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
     # @param  [String] value The value of a variable
+    # @param  [Hash] opts optional parameters
     # @return [Gitlab::ObjectifiedHash] The variable.
-    def create_group_variable(group, key, value)
-      post("/groups/#{url_encode group}/variables", body: { key: key, value: value })
+    def create_group_variable(group, key, value, **opts)
+      post("/groups/#{url_encode group}/variables", body: opts.merge(key: key, value: value))
     end
 
     # Update a group's build variable.
@@ -110,9 +113,10 @@ class Gitlab::Client
     # @param  [Integer, String] group The ID or name of a group.
     # @param  [String] key The key of a variable
     # @param  [String] value The value of a variable
+    # @param  [Hash] opts optional parameters
     # @return [Gitlab::ObjectifiedHash] The variable.
-    def update_group_variable(group, key, value)
-      put("/groups/#{url_encode group}/variables/#{key}", body: { value: value })
+    def update_group_variable(group, key, value, **opts)
+      put("/groups/#{url_encode group}/variables/#{key}", body: opts.merge(value: value))
     end
 
     # Remove a group's build variable.