gitlab 4.14.0 → 4.17.0

data/lib/gitlab/client/user_snippets.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to user snippets.
+  # @see https://docs.gitlab.com/ce/api/snippets.html
+  module UserSnippets
+    # Get a list of the snippets of the current user.
+    #
+    # @example
+    #   Gitlab.user_snippets
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] List of snippets of current user
+    def user_snippets
+      get('/snippets')
+    end
+
+    # Get a single snippet.
+    #
+    # @example
+    #   Gitlab.user_snippet(1)
+    #
+    # @param  [Integer] id ID of snippet to retrieve.
+    # @return [Gitlab::ObjectifiedHash] Information about the user snippet
+    def user_snippet(id)
+      get("/snippets/#{id}")
+    end
+
+    # Get raw contents of a single snippet.
+    #
+    # @example
+    #   Gitlab.user_snippet_raw(1)
+    #
+    # @param  [Integer] id ID of snippet to retrieve.
+    # @return [String] User snippet text
+    def user_snippet_raw(id)
+      get("/snippets/#{id}/raw",
+          format: nil,
+          headers: { Accept: 'text/plain' },
+          parser: ::Gitlab::Request::Parser)
+    end
+
+    # Create a new snippet.
+    #
+    # @example
+    #   Gitlab.create_user_snippet({ title: 'REST', file_name: 'api.rb', content: 'some code', description: 'Hello World snippet', visibility: 'public'})
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title (required) Title of a snippet.
+    # @option options [String] :file_name (required) Name of a snippet file.
+    # @option options [String] :content (required) Content of a snippet.
+    # @option options [String] :description (optional) Description of a snippet.
+    # @option options [String] :visibility (optional) visibility of a snippet.
+    # @return [Gitlab::ObjectifiedHash] Information about created snippet.
+    def create_user_snippet(options = {})
+      post('/snippets', body: options)
+    end
+
+    # Update an existing snippet.
+    #
+    # @example
+    #   Gitlab.edit_user_snippet(34, { file_name: 'README.txt' })
+    #   Gitlab.edit_user_snippet(34, { file_name: 'README.txt', title: 'New title' })
+    #
+    # @param  [Integer] id ID of snippet to update.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title (optional) Title of a snippet.
+    # @option options [String] :file_name (optional) Name of a snippet file.
+    # @option options [String] :content (optional) Content of a snippet.
+    # @option options [String] :description (optional) Description of a snippet.
+    # @option options [String] :visibility (optional) visibility of a snippet.
+    # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
+    def edit_user_snippet(id, options = {})
+      put("/snippets/#{id}", body: options)
+    end
+
+    # Delete an existing snippet.
+    #
+    # @example
+    #   Gitlab.delete_user_snippet(14)
+    #
+    # @param  [Integer] id ID of snippet to delete.
+    # @return [void] This API call returns an empty response body.
+    def delete_user_snippet(id)
+      delete("/snippets/#{id}")
+    end
+
+    # List all public snippets.
+    #
+    # @example
+    #   Gitlab.public_snippets
+    #   Gitlab.public_snippets(per_page: 2, page: 1)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page (optional) Number of snippets to return per page.
+    # @option options [String] :page (optional) Page to retrieve.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all public snippets
+    def public_snippets(options = {})
+      get('/snippets/public', query: options)
+    end
+
+    # Get user agent details for a snippet.
+    #
+    # @example
+    #   Gitlab.snippet_user_agent_details(1)
+    #
+    # @param  [Integer] id ID of snippet to delete.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] Details of the user agent
+    def snippet_user_agent_details(id)
+      get("/snippets/#{id}/user_agent_detail")
+    end
+  end
+end

data/lib/gitlab/client/users.rb

@@ -123,6 +123,20 @@ class Gitlab::Client
       post('/session', body: { email: email, password: password }, unauthenticated: true)
     end
 
+    # Gets a list of user activities (for admin access only).
+    #
+    # @example
+    #   Gitlab.activities
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @option options [String] :from The start date for paginated results.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def activities(options = {})
+      get('/user/activities', query: options)
+    end
+
     # Gets a list of user's SSH keys.
     #
     # @example
@@ -225,10 +239,15 @@ class Gitlab::Client
     #
     # @param  [String] email Email address
     # @param  [Integer] user_id The ID of a user.
+    # @param  [Boolean] skip_confirmation     Skip confirmation and assume e-mail is verified
     # @return [Gitlab::ObjectifiedHash]
-    def add_email(email, user_id = nil)
+    def add_email(email, user_id = nil, skip_confirmation = nil)
       url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
-      post(url, body: { email: email })
+      if skip_confirmation.nil?
+        post(url, body: { email: email })
+      else
+        post(url, body: { email: email, skip_confirmation: skip_confirmation })
+      end
     end
 
     # Delete email

data/lib/gitlab/error.rb

@@ -34,6 +34,17 @@ module Gitlab
         @response.parsed_response.message
       end
 
+      # Additional error context returned by some API endpoints
+      #
+      # @return [String]
+      def error_code
+        if @response.respond_to?(:error_code)
+          @response.error_code
+        else
+          ''
+        end
+      end
+
       private
 
       # Human friendly message.
@@ -63,6 +74,14 @@ module Gitlab
         else
           @response.parsed_response
         end
+      rescue Gitlab::Error::Parsing
+        # Return stringified response when receiving a
+        # parsing error to avoid obfuscation of the
+        # api error.
+        #
+        # note: The Gitlab API does not always return valid
+        # JSON when there are errors.
+        @response.to_s
       end
 
       # Handle error response message in case of nested hashes

data/lib/gitlab/help.rb

@@ -74,20 +74,21 @@ module Gitlab::Help
     # Returns full namespace of a command (e.g. Gitlab::Client::Branches.cmd)
     def namespace(cmd)
       method_owners.select { |method| method[:name] == cmd }
-                   .map { |method| method[:owner] + '.' + method[:name] }
+                   .map { |method| "#{method[:owner]}.#{method[:name]}" }
                    .shift
     end
 
     # Massage output from 'ri'.
     def change_help_output!(cmd, output_str)
-      output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd + ' \1')
-      output_str.gsub!(/\,[\s]*/, ' ')
+      output_str = +output_str
+      output_str.gsub!(/#{cmd}\((.*?)\)/m, "#{cmd} \1")
+      output_str.gsub!(/,\s*/, ' ')
 
       # Ensure @option descriptions are on a single line
       output_str.gsub!(/\n\[/, " \[")
       output_str.gsub!(/\s(@)/, "\n@")
-      output_str.gsub!(/(\])\n(\:)/, '\1 \2')
-      output_str.gsub!(/(\:.*)(\n)(.*\.)/, '\1 \3')
+      output_str.gsub!(/(\])\n(:)/, '\1 \2')
+      output_str.gsub!(/(:.*)(\n)(.*\.)/, '\1 \3')
       output_str.gsub!(/\{(.+)\}/, '"{\1}"')
     end
   end

data/lib/gitlab/objectified_hash.rb

@@ -7,29 +7,45 @@ module Gitlab
     def initialize(hash)
       @hash = hash
       @data = hash.each_with_object({}) do |(key, value), data|
-        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        value = self.class.new(value) if value.is_a? Hash
+        value = value.map { |v| v.is_a?(Hash) ? self.class.new(v) : v } if value.is_a? Array
         data[key.to_s] = value
       end
     end
 
     # @return [Hash] The original hash.
     def to_hash
-      @hash
+      hash
     end
     alias to_h to_hash
 
     # @return [String] Formatted string with the class name, object id and original hash.
     def inspect
-      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+      "#<#{self.class}:#{object_id} {hash: #{hash.inspect}}"
     end
 
-    # Delegate to ObjectifiedHash.
-    def method_missing(key)
-      @data.key?(key.to_s) ? @data[key.to_s] : super
+    def [](key)
+      data[key]
+    end
+
+    private
+
+    attr_reader :hash, :data
+
+    # Respond to messages for which `self.data` has a key
+    def method_missing(method_name, *args, &block)
+      if data.key?(method_name.to_s)
+        data[method_name.to_s]
+      elsif data.respond_to?(method_name)
+        warn 'WARNING: Please convert ObjectifiedHash object to hash before calling Hash methods on it.'
+        data.send(method_name, *args, &block)
+      else
+        super
+      end
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+      hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
     end
   end
 end

data/lib/gitlab/page_links.rb

@@ -7,7 +7,7 @@ module Gitlab
   class PageLinks
     HEADER_LINK = 'Link'
     DELIM_LINKS = ','
-    LINK_REGEX = /<([^>]+)>; rel=\"([^\"]+)\"/.freeze
+    LINK_REGEX = /<([^>]+)>; rel="([^"]+)"/.freeze
     METAS = %w[last next first prev].freeze
 
     attr_accessor(*METAS)

data/lib/gitlab/paginated_response.rb

@@ -42,37 +42,20 @@ module Gitlab
       end
     end
 
-    def auto_paginate
-      response = block_given? ? nil : []
-      each_page do |page|
-        if block_given?
-          page.each do |item|
-            yield item
-          end
-        else
-          response += page
-        end
-      end
-      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
+    def lazy_paginate
+      to_enum(:each_page).lazy.flat_map(&:to_ary) # rubocop:disable Lint/ToEnumArguments
+    end
+
+    def auto_paginate(&block)
+      return lazy_paginate.to_a unless block
+
+      lazy_paginate.each(&block)
+    end
+
+    def paginate_with_limit(limit, &block)
+      return lazy_paginate.take(limit).to_a unless block
+
+      lazy_paginate.take(limit).each(&block)
     end
 
     def last_page?
@@ -83,8 +66,7 @@ module Gitlab
     def last_page
       return nil if @client.nil? || !has_last_page?
 
-      path = @links.last.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.last))
     end
 
     def first_page?
@@ -95,8 +77,7 @@ module Gitlab
     def first_page
       return nil if @client.nil? || !has_first_page?
 
-      path = @links.first.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.first))
     end
 
     def next_page?
@@ -107,8 +88,7 @@ module Gitlab
     def next_page
       return nil if @client.nil? || !has_next_page?
 
-      path = @links.next.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.next))
     end
 
     def prev_page?
@@ -119,8 +99,12 @@ module Gitlab
     def prev_page
       return nil if @client.nil? || !has_prev_page?
 
-      path = @links.prev.sub(/#{@client.endpoint}/, '')
-      @client.get(path)
+      @client.get(client_relative_path(@links.prev))
+    end
+
+    def client_relative_path(link)
+      client_endpoint_path = URI.parse(@client.endpoint).request_uri # api/v4
+      URI.parse(link).request_uri.sub(client_endpoint_path, '')
     end
   end
 end

data/lib/gitlab/request.rb

@@ -25,8 +25,6 @@ module Gitlab
         true
       elsif !body
         false
-      elsif body.nil?
-        false
       else
         raise Error::Parsing, "Couldn't parse a response body"
       end

data/lib/gitlab/shell_history.rb

@@ -42,10 +42,10 @@ class Gitlab::Shell
       File.expand_path(@file_path)
     end
 
-    def read_from_file
+    def read_from_file(&block)
       path = history_file_path
 
-      File.foreach(path) { |line| yield(line) } if File.exist?(path)
+      File.foreach(path, &block) if File.exist?(path)
     rescue StandardError => e
       warn "History file not loaded: #{e.message}"
     end

data/lib/gitlab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Nihad Abbasov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,20 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -51,20 +45,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,20 +73,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -152,9 +118,11 @@ files:
 - lib/gitlab/client/container_registry.rb
 - lib/gitlab/client/deployments.rb
 - lib/gitlab/client/environments.rb
+- lib/gitlab/client/epic_issues.rb
 - lib/gitlab/client/epics.rb
 - lib/gitlab/client/events.rb
 - lib/gitlab/client/features.rb
+- lib/gitlab/client/group_badges.rb
 - lib/gitlab/client/group_boards.rb
 - lib/gitlab/client/group_labels.rb
 - lib/gitlab/client/group_milestones.rb
@@ -184,6 +152,7 @@ files:
 - lib/gitlab/client/repository_files.rb
 - lib/gitlab/client/repository_submodules.rb
 - lib/gitlab/client/resource_label_events.rb
+- lib/gitlab/client/resource_state_events.rb
 - lib/gitlab/client/runners.rb
 - lib/gitlab/client/search.rb
 - lib/gitlab/client/services.rb
@@ -193,6 +162,7 @@ files:
 - lib/gitlab/client/tags.rb
 - lib/gitlab/client/templates.rb
 - lib/gitlab/client/todos.rb
+- lib/gitlab/client/user_snippets.rb
 - lib/gitlab/client/users.rb
 - lib/gitlab/client/versions.rb
 - lib/gitlab/client/wikis.rb
@@ -219,14 +189,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper and CLI for the GitLab API