gitlab 5.1.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1453623fe0d87a006492342f5726338aba971afcc6b693295f537a037d7e2e9
-  data.tar.gz: ab5e4e4d81bdeeef8802dc03bc8b7c912c6b41f1d4ac25ab5ca752b4af53121b
+  metadata.gz: 3d3b231261621f73bdfcb46e2609bf5190494736aef0de757a2fa259d440d9d7
+  data.tar.gz: 5c33a995fa9eadca8ac096fa95431c98dd8abcd9851a9a6d1f22f19fbc2b4beb
 SHA512:
-  metadata.gz: 54dae253ce896dcbf3e612fdd4bb3e092373557e5959292e5a949108679d4ead1ac69e34e45f9d15c795e826d19b55175ad234598aa68f2e51c8384289af7267
-  data.tar.gz: 14ab36332c58d98f43216df49bfa6e1cbe8aa6a540ef83cb4b1d2090cad66c9eb8351172f1d13feb369f7f32b8d65503094be358d855b1d5636f01418b129f4f
+  metadata.gz: 76a5f90b660a6186f2948bd69187269c9f03be79a9359e8f37dc855bf83410f203f74e9c27fca512b66244f736617f93912f84077498920d1bc468f57d028a8d
+  data.tar.gz: 77a4e11963a719227f536412ad13ecc70737961eca68075b3f69a7e91d650b4a4ed592af13062da85b07e973495229ac8ef6ff5388bb470aaceb29629492f22a

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2024 Nihad Abbasov <nihad@42na.in>
+Copyright (c) 2012-2025 Nihad Abbasov <nihad@42na.in>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -42,6 +42,7 @@ Gitlab.configure do |config|
   # Optional
   # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Gitlab Ruby Gem [version]'
   # config.sudo         = 'user'                       # username for sudo mode, default: nil
+  # config.body_as_json = false                        # use application/json for all requests with a body, default: false
 end
 ```
 

data/lib/gitlab/cli.rb

@@ -16,12 +16,13 @@ class Gitlab::CLI
   #
   # @param [Array] args The command and it's optional arguments.
   def self.start(args)
+    args_dup = args.dup
     command = begin
-      args.shift.strip
+      args_dup.shift.strip
     rescue StandardError
       'help'
     end
-    run(command, args)
+    run(command, args_dup)
   end
 
   # Processes a CLI command and outputs a result to the stream (stdout).

data/lib/gitlab/cli_helpers.rb

@@ -3,6 +3,7 @@
 require 'yaml'
 require 'json'
 require 'base64'
+require 'stringio'
 
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.

data/lib/gitlab/client/commits.rb

@@ -172,14 +172,14 @@ class Gitlab::Client
 
     # Creates a single commit with one or more changes
     #
-    # @see https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions
+    # @see https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions
     # Introduced in Gitlab 8.13
     #
     # @example
-    # Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'create', file_path: '/foo.txt', content: 'bar'}])
-    # Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'delete', file_path: '/foo.txt'}])
+    #   Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'create', file_path: '/foo.txt', content: 'bar'}])
+    #   Gitlab.create_commit(2726132, 'master', 'refactors everything', [{action: 'delete', file_path: '/foo.txt'}])
     #
-    # @param  [Integer, String] project The ID or name of a project.
+    # @param [Integer, String] project The ID or name of a project.
     # @param [String] branch the branch name you wish to commit to
     # @param [String] message the commit message
     # @param [Array[Hash]] An array of action hashes to commit as a batch. See the next table for what attributes it can take.

data/lib/gitlab/client/container_registry.rb

@@ -10,9 +10,14 @@ class Gitlab::Client
     #   Gitlab.registry_repositories(5)
     #
     # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :tags Return tags array in the response.
+    # @option options [Boolean] :tags_count Return tags count in the response.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>] Returns list of registry repositories in a project.
-    def registry_repositories(project)
-      get("/projects/#{url_encode project}/registry/repositories")
+    def registry_repositories(project, options = {})
+      get("/projects/#{url_encode project}/registry/repositories", query: options)
     end
 
     # Delete a repository in registry.

data/lib/gitlab/client/groups.rb

@@ -148,26 +148,45 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.add_group_member(1, 2, 40)
+    #   Gitlab.add_group_member(1, 2, 40, member_role_id: 5)
     #
     # @param  [Integer] team_id The group id to add a member to.
     # @param  [Integer] user_id The user id of the user to add to the team.
     # @param  [Integer] access_level Project access level.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :member_role_id The id of a custom member role.
     # @return [Gitlab::ObjectifiedHash] Information about added team member.
-    def add_group_member(team_id, user_id, access_level)
-      post("/groups/#{url_encode team_id}/members", body: { user_id: user_id, access_level: access_level })
+    def add_group_member(team_id, user_id, access_level, options = {})
+      body = { user_id: user_id, access_level: access_level }.merge(options)
+      post("/groups/#{url_encode team_id}/members", body: body)
+    end
+
+    # Set LDAP override flag for a member of a group
+    #
+    # @example
+    #   Gitlab.override_group_member(1, 2)
+    #
+    # @param  [Integer] team_id The group id into which LDAP syncs the user.
+    # @param  [Integer] user_id The user id of the user.
+    def override_group_member(team_id, user_id)
+      post("/groups/#{url_encode team_id}/members/#{user_id}/override")
     end
 
     # Edit a user of a group.
     #
     # @example
     #   Gitlab.edit_group_member(1, 2, 40)
+    #   Gitlab.edit_group_member(1, 2, 40, member_role_id: 5)
     #
     # @param  [Integer] team_id The group id of member to edit.
     # @param  [Integer] user_id The user id of the user to edit.
     # @param  [Integer] access_level Project access level.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :member_role_id The id of a custom member role.
     # @return [Gitlab::ObjectifiedHash] Information about edited team member.
-    def edit_group_member(team_id, user_id, access_level)
-      put("/groups/#{url_encode team_id}/members/#{user_id}", body: { access_level: access_level })
+    def edit_group_member(team_id, user_id, access_level, options = {})
+      body = { access_level: access_level }.merge(options)
+      put("/groups/#{url_encode team_id}/members/#{user_id}", body: body)
     end
 
     # Removes user from user group.

data/lib/gitlab/client/merge_requests.rb

@@ -365,9 +365,12 @@ class Gitlab::Client
     #   Gitlab.merge_request_diffs('gitlab', 1)
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a merge request.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @option options [Boolean] :unidiff Present diffs in the unified diff format.
     # @return [Gitlab::ObjectifiedHash] A list of the merge request diffs.
-    def merge_request_diffs(project, merge_request_id)
-      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/diffs")
+    def merge_request_diffs(project, merge_request_id, options = {})
+      get("/projects/#{url_encode project}/merge_requests/#{merge_request_id}/diffs", query: options)
     end
 
     # Gets a list of merge request diff versions

data/lib/gitlab/client/project_releases.rb

@@ -24,7 +24,7 @@ class Gitlab::Client
     # @param [String] tag_name  The tag where the release will be created from..
     # @return [Gitlab::ObjectifiedHash] Information about the release
     def project_release(project, tag_name)
-      get("/projects/#{url_encode project}/releases/#{tag_name}")
+      get("/projects/#{url_encode project}/releases/#{url_encode tag_name}")
     end
 
     # Creates a Release. You need push access to the repository to create a Release.
@@ -61,7 +61,7 @@ class Gitlab::Client
     # @option options [String] :description(optional)  The description of the release. You can use markdown.
     # @return [Gitlab::ObjectifiedHash] Information about the updated release.
     def update_project_release(project, tag_name, options = {})
-      put("/projects/#{url_encode project}/releases/#{tag_name}", body: options)
+      put("/projects/#{url_encode project}/releases/#{url_encode tag_name}", body: options)
     end
 
     # Delete a Release. Deleting a Release will not delete the associated tag.
@@ -73,7 +73,7 @@ class Gitlab::Client
     # @param [String] tag_name  The tag where the release will be created from.
     # @return [Gitlab::ObjectifiedHash] Information about the deleted release.
     def delete_project_release(project, tag_name)
-      delete("/projects/#{url_encode project}/releases/#{tag_name}")
+      delete("/projects/#{url_encode project}/releases/#{url_encode tag_name}")
     end
 
     # Gets Latest Release

data/lib/gitlab/client/projects.rb

@@ -138,12 +138,14 @@ class Gitlab::Client
     # @example
     #   Gitlab.add_team_member('gitlab', 2, 40)
     #   Gitlab.add_team_member('gitlab', 2, 40, { expires_at: "2018-12-31"})
+    #   Gitlab.add_team_member('gitlab', 2, 40, { member_role_id: 5 })
     #
     # @param  [Integer, String] project The ID or path of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
+    # @option options [Integer] :member_role_id The id of a custom member role.
     # @return [Gitlab::ObjectifiedHash] Information about added team member.
     def add_team_member(project, id, access_level, options = {})
       body = { user_id: id, access_level: access_level }.merge(options)
@@ -155,12 +157,14 @@ class Gitlab::Client
     # @example
     #   Gitlab.edit_team_member('gitlab', 3, 20)
     #   Gitlab.edit_team_member('gitlab', 3, 20, { expires_at: "2018-12-31"})
+    #   Gitlab.edit_team_member('gitlab', 3, 20, { member_role_id: 5 })
     #
     # @param  [Integer, String] project The ID or path of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :expires_at A date string in the format YEAR-MONTH-DAY.
+    # @option options [Integer] :member_role_id The id of a custom member role.
     # @return [Array<Gitlab::ObjectifiedHash>] Information about updated team member.
     def edit_team_member(project, id, access_level, options = {})
       body = { access_level: access_level }.merge(options)

data/lib/gitlab/client/remote_mirrors.rb

@@ -16,6 +16,19 @@ class Gitlab::Client
       get("/projects/#{url_encode project}/remote_mirrors")
     end
 
+    # Get a specific remote mirror.
+    #
+    # @example
+    #   Gitlab.remote_mirror(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] id The ID of the remote mirror.
+    #
+    # @return [Gitlab::ObjectifiedHash] Information about the specified remote mirror.
+    def remote_mirror(project, id)
+      get("/projects/#{url_encode project}/remote_mirrors/#{id}")
+    end
+
     # Create a remote mirror
     #
     # @example
@@ -47,5 +60,31 @@ class Gitlab::Client
     def edit_remote_mirror(project, id, options = {})
       put("/projects/#{url_encode project}/remote_mirrors/#{id}", body: options)
     end
+
+    # Delete a remote mirror.
+    #
+    # @example
+    #   Gitlab.delete_remote_mirror(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] id The ID of the remote mirror.
+    #
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_remote_mirror(project, id)
+      delete("/projects/#{url_encode project}/remote_mirrors/#{id}")
+    end
+
+    # Force push mirror update.
+    #
+    # @example
+    #   Gitlab.sync_remote_mirror(42, 1234)
+    #
+    # @param [Integer, String] project The ID or path of a project.
+    # @param [Integer] id The ID of the remote mirror.
+    #
+    # @return [Gitlab::ObjectifiedHash]
+    def sync_remote_mirror(project, id)
+      post("/projects/#{url_encode project}/remote_mirrors/#{id}/sync")
+    end
   end
 end

data/lib/gitlab/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module Gitlab
   # Wrapper for the Gitlab REST API.
   class Client < API
@@ -82,11 +84,10 @@ module Gitlab
     end
 
     # Utility method for URL encoding of a string.
-    # Copied from https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB/Util.html
     #
     # @return [String]
     def url_encode(url)
-      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString
+      CGI.escapeURIComponent(url.to_s)
     end
 
     private

data/lib/gitlab/configuration.rb

@@ -5,7 +5,7 @@ module Gitlab
   # Defines constants and methods related to configuration.
   module Configuration
     # An array of valid keys in the options hash when configuring a Gitlab::API.
-    VALID_OPTIONS_KEYS = %i[endpoint private_token user_agent sudo httparty pat_prefix].freeze
+    VALID_OPTIONS_KEYS = %i[endpoint private_token user_agent sudo httparty pat_prefix body_as_json].freeze
 
     # The user agent that will be sent to the API endpoint if none is set.
     DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}"
@@ -41,6 +41,7 @@ module Gitlab
       self.httparty       = get_httparty_config(ENV['GITLAB_API_HTTPARTY_OPTIONS'])
       self.sudo           = nil
       self.user_agent     = DEFAULT_USER_AGENT
+      self.body_as_json   = false
     end
 
     private

data/lib/gitlab/request.rb

@@ -12,7 +12,7 @@ module Gitlab
     headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
     parser(proc { |body, _| parse(body) })
 
-    attr_accessor :private_token, :endpoint, :pat_prefix
+    attr_accessor :private_token, :endpoint, :pat_prefix, :body_as_json
 
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
@@ -49,6 +49,8 @@ module Gitlab
           params[:headers].merge!(authorization_header)
         end
 
+        jsonify_body_content(params) if body_as_json
+
         retries_left = params[:ratelimit_retries] || 3
         begin
           response = self.class.send(method, endpoint + path, params)
@@ -114,5 +116,24 @@ module Gitlab
     def httparty_config(options)
       options.merge!(httparty) if httparty
     end
+
+    # Handle 'body_as_json' configuration option
+    # Modifies passed params in place.
+    def jsonify_body_content(params)
+      # Only modify the content type if there is a body to process AND multipath
+      # was not explicitly requested. There are no uses of multipart in this code
+      # today, but file upload methods require it and someone might be manually
+      # crafting a post call with it:
+      return unless params[:body] && params[:multipart] != true
+
+      # If the caller explicitly requested a Content-Type during the call, assume
+      # they know best and have formatted the body as required:
+      return if params[:headers]&.key?('Content-Type')
+
+      # If we make it here, then we assume it is safe to JSON encode the body:
+      params[:headers] ||= {}
+      params[:headers]['Content-Type'] = 'application/json'
+      params[:body] = params[:body].to_json
+    end
   end
 end

data/lib/gitlab/version.rb

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

metadata

@@ -1,30 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Nihad Abbasov
-- Sean Edge
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +96,6 @@ dependencies:
 description: Ruby client and CLI for GitLab API
 email:
 - nihad@42na.in
-- asedge@gmail.com
 executables:
 - gitlab
 extensions: []
@@ -199,7 +196,6 @@ metadata:
   bug_tracker_uri: https://github.com/NARKOZ/gitlab/issues
   changelog_uri: https://github.com/NARKOZ/gitlab/releases
   funding_uri: https://github.com/NARKOZ/SponsorMe
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -207,15 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API
 test_files: []