gitlab 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4709e421064af0cf5367a459989920ad1e88d324dbb01437f5bf70673f7b3e98
-  data.tar.gz: 0d3242640c2f27ee04607b5dcd2e78b9e6e38f4c49d107d5217306abbb00ff81
+  metadata.gz: c2abe85ce03f9110e9d7c55e516487e125898a960de1c8f69ce752b12851a026
+  data.tar.gz: 9bda4675dc3a8e1c408ba68c366a14855f4456660001bff17bba98f06de9ca42
 SHA512:
-  metadata.gz: 9d5bd203c61aca2526b0c378333c3e5a003e33eedaf3e592d88270ce86c4daa1742c14cce45d35e3c4d5e1dd4dcd3eee00daa64c533fa3fbd95cbc1bdddac5a6
-  data.tar.gz: 947dc65cf181b02049ca052a04e9f42f68c2ca0387da7cbe36151590b7fee9e64afa6a726eda0e8ed91eae540f22e0c192c5cc6af353c05e64e5aaf9d60ba6fa
+  metadata.gz: be06faf90e256343833177899f3064af39042cb7e299364f499cc29a0d903b62219d0dc80cf8588b956a424c43f01d58d28fd7bdba69609b5cf3c23a495f44f0
+  data.tar.gz: 412245730f19b0adc1f4fff19dd0e39373f7810ec00991e0303bf3287ac3f5d6b0dc2d132af93a09a272b254dc4c73fdadd29b2926e9e1761f55f66f4ef75f5e

data/.github/stale.yml

@@ -0,0 +1,18 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 10
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - contribution welcome
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.rubocop_todo.yml

@@ -0,0 +1,46 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-10-10 10:25:27 +0400 using RuboCop version 0.59.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/UriEscapeUnescape:
+  Exclude:
+    - 'lib/gitlab/client.rb'
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 34
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 10
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 34
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 165
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect.
+Security/JSONLoad:
+  Exclude:
+    - 'lib/gitlab/request.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gitlab.gemspec

data/README.md

@@ -1,17 +1,17 @@
 # Gitlab
 
 [![Build Status](https://img.shields.io/travis/NARKOZ/gitlab.svg)](https://travis-ci.org/NARKOZ/gitlab)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/NARKOZ/gitlab.svg)](https://codeclimate.com/github/NARKOZ/gitlab)
-[![Inline docs](http://inch-ci.org/github/NARKOZ/gitlab.svg)](https://inch-ci.org/github/NARKOZ/gitlab)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2e310b334b1b5db4a7e1/maintainability)](https://codeclimate.com/github/NARKOZ/gitlab)
+[![Inline docs](https://inch-ci.org/github/NARKOZ/gitlab.svg)](https://inch-ci.org/github/NARKOZ/gitlab)
 [![Gem version](https://img.shields.io/gem/v/gitlab.svg)](https://rubygems.org/gems/gitlab)
 [![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/NARKOZ/gitlab/blob/master/LICENSE.txt)
 
-[website](http://narkoz.github.io/gitlab) |
-[documentation](http://rubydoc.info/gems/gitlab/frames) |
+[website](https://narkoz.github.io/gitlab) |
+[documentation](https://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 Ruby 2.0+ and GitLab API v4.
 
 ## Installation
 
@@ -54,8 +54,8 @@ Usage examples:
 
 ```ruby
 # set an API endpoint
-Gitlab.endpoint = 'http://example.net/api/v4'
-# => "http://example.net/api/v4"
+Gitlab.endpoint = 'https://example.net/api/v4'
+# => "https://example.net/api/v4"
 
 # set a user private token
 Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
@@ -63,7 +63,7 @@ Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
 
 # configure a proxy server
 Gitlab.http_proxy('proxyhost', 8888)
-# proxy server w/ basic auth
+# proxy server with basic auth
 Gitlab.http_proxy('proxyhost', 8888, 'proxyuser', 'strongpasswordhere')
 
 # list projects
@@ -108,11 +108,11 @@ end
 projects.auto_paginate
 ```
 
-For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).
+For more information, refer to [documentation](https://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:
+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>
@@ -124,21 +124,21 @@ export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
 
 Usage:
 
-When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
+When you want to know which CLI commands are supported, take a look at the client [commands implemented in this gem](https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client). Any of those methods can be called as a command by passing the parameters of the commands as parameters of the CLI.
 
 Usage examples:
 
 ```sh
 # list users
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#users-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#users-instance_method
 gitlab users
 
 # get current user
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
 gitlab user
 
 # get a user
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/Users#user-instance_method
 gitlab user 2
 
 # filter output
@@ -150,7 +150,7 @@ gitlab user --except=email,bio
 gitlab user 2 --json
 
 # passing options hash to a command (use YAML)
-# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
+# see: https://www.rubydoc.info/gems/gitlab/4.5.0/Gitlab/Client/MergeRequests#create_merge_request-instance_method
 gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
 
 ```
@@ -177,17 +177,17 @@ gitlab> create_merge_request 4 "New merge request" "{source_branch: 'new_branch'
 ```
 
 Web version is available at https://gitlab-live.herokuapp.com  
-For more information, refer to [website](http://narkoz.github.io/gitlab).
+For more information, refer to [website](https://narkoz.github.io/gitlab).
 
 ## Development
 
-### With a dockerized Gitlab instance
+### With a dockerized GitLab instance
 
 ```shell
-docker-compose up -d gitlab # Will start the gitlab instance in the background (approx. 3 minutes)
+docker-compose up -d gitlab # Will start the GitLab instance in the background (approx. 3 minutes)
 ```
 
-After a while, your Gitlab instance will be accessible on http://localhost:3000.
+After a while, your GitLab instance will be accessible on http://localhost:3000.
 
 Once you have set your new root password, you can login with the root user.
 
@@ -206,17 +206,17 @@ Gitlab.users
 => [#<Gitlab::ObjectifiedHash:47231290771040 {hash: {"id"=>1, "name"=>"Administrator", "username"=>"root", ...]
 ```
 
-To launch the specs,
+To launch the specs:
 
 ```shell
 docker-compose run app rake spec
 ```
 
-#### Want to use Gitlab Enterprise?
+#### Want to use GitLab Enterprise?
 
 Just change the image from `gitlab/gitlab-ce:latest` to `gitlab/gitlab-ee:latest` in the `docker-compose.yml` file.
 
-### With an external Gitlab instance
+### With an external GitLab instance
 
 First, set the variables to the correct values in the `docker.env` file.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
@@ -10,8 +12,4 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.options = ['-D', '--parallel']
 end
 
-if ENV['TRAVIS_CI_RUBOCOP']
-  task default: :rubocop
-else
-  task default: :spec
-end
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # ENV['GITLAB_API_ENDPOINT'] = ''
 # ENV['GITLAB_API_PRIVATE_TOKEN'] = ''

data/exe/gitlab

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+# Exit cleanly from an early interrupt
+Signal.trap('INT') { exit 1 }
 
 require 'gitlab/cli'
 

data/gitlab.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/version'
 
@@ -11,16 +13,17 @@ Gem::Specification.new do |gem|
   gem.summary       = 'A Ruby wrapper and CLI for the GitLab API'
   gem.homepage      = 'https://github.com/narkoz/gitlab'
 
-  gem.files         = `git ls-files`.split($/).
-                      reject { |f| f[/^spec/] } -
-                      %w[Dockerfile docker-compose.yml docker.env .travis.yml .rubocop.yml .dockerignore]
+  gem.files         = `git ls-files`.split($/)
+                                    .grep_v(/^spec/) -
+                      %w[Dockerfile docker-compose.yml docker.env .travis.yml
+                         .rubocop.yml .dockerignore]
   gem.bindir        = 'exe'
   gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
   gem.license       = 'BSD'
 
-  gem.required_ruby_version = '>= 2.0.0'
+  gem.required_ruby_version = '>= 2.3'
 
   gem.add_runtime_dependency 'httparty', '>= 0.14.0'
   gem.add_runtime_dependency 'terminal-table', '>= 1.5.1'
@@ -28,6 +31,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'webmock'
 end

data/lib/gitlab.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab/version'
 require 'gitlab/objectified_hash'
 require 'gitlab/configuration'
@@ -15,23 +17,24 @@ module Gitlab
   # Alias for Gitlab::Client.new
   #
   # @return [Gitlab::Client]
-  def self.client(options={})
+  def self.client(options = {})
     Gitlab::Client.new(options)
   end
 
   # Delegate to Gitlab::Client
   def self.method_missing(method, *args, &block)
     return super unless client.respond_to?(method)
+
     client.send(method, *args, &block)
   end
 
   # Delegate to Gitlab::Client
-  def self.respond_to_missing?(method_name, include_private=false)
+  def self.respond_to_missing?(method_name, include_private = false)
     client.respond_to?(method_name) || super
   end
 
   # Delegate to HTTParty.http_proxy
-  def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
+  def self.http_proxy(address = nil, port = nil, username = nil, password = nil)
     Gitlab::Request.http_proxy(address, port, username, password)
   end
 

data/lib/gitlab/api.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Gitlab
   # @private
   class API < Request
     # @private
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
     # @private
-    alias_method :auth_token=, :private_token=
+    alias auth_token= private_token=
 
     # Creates a new API.
     # @raise [Error:MissingCredentials]
-    def initialize(options={})
+    def initialize(options = {})
       options = Gitlab.options.merge(options)
       (Configuration::VALID_OPTIONS_KEYS + [:auth_token]).each do |key|
         send("#{key}=", options[key]) if options[key]
       end
-      request_defaults(@sudo)
+      request_defaults(sudo)
       self.class.headers 'User-Agent' => user_agent
     end
   end

data/lib/gitlab/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab'
 require 'terminal-table/import'
 require_relative 'cli_helpers'
@@ -17,7 +19,11 @@ class Gitlab::CLI
   #
   # @param [Array] args The command and it's optional arguments.
   def self.start(args)
-    command = args.shift.strip rescue 'help'
+    command = begin
+                args.shift.strip
+              rescue StandardError
+                'help'
+              end
     run(command, args)
   end
 
@@ -30,13 +36,13 @@ class Gitlab::CLI
   # @param [String] cmd The name of a command.
   # @param [Array] args The optional arguments for a command.
   # @return [nil]
-  def self.run(cmd, args=[])
+  def self.run(cmd, args = [])
     case cmd
     when 'help'
       puts help(args.shift) { |out| out.gsub!(/Gitlab\./, 'gitlab ') }
     when 'info'
-      endpoint = Gitlab.endpoint ? Gitlab.endpoint : 'not set'
-      private_token = Gitlab.private_token ? Gitlab.private_token : 'not set'
+      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}"
@@ -60,7 +66,7 @@ class Gitlab::CLI
 
       begin
         command_args.map! { |arg| symbolize_keys(yaml_load(arg)) }
-      rescue => e
+      rescue StandardError => e
         puts e.message
         exit 1
       end

data/lib/gitlab/cli_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 require 'base64'
@@ -5,7 +7,7 @@ require 'base64'
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
   module Helpers
-    extend self
+    module_function
 
     # Returns actions available to CLI & Shell
     #
@@ -71,7 +73,7 @@ class Gitlab::CLI
 
       puts 'Are you sure? (y/n)'
 
-      if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+      if %w[y yes].include?($stdin.gets.to_s.strip.downcase)
         puts 'Proceeding..'
       else
         puts 'Command aborted.'
@@ -82,7 +84,7 @@ class Gitlab::CLI
     # Gets defined help for a specific command/action.
     #
     # @return [String]
-    def help(cmd=nil, &block)
+    def help(cmd = nil, &block)
       if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
         Gitlab::Help.actions_table(cmd)
       else
@@ -90,14 +92,14 @@ class Gitlab::CLI
       end
     end
 
-    # Outputs a nicely formatted table or error msg.
+    # 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 msg
+      else # probably just an error message
         puts data
       end
     end
@@ -159,7 +161,7 @@ class Gitlab::CLI
     # @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)
+    def record_hash(data, cmd, args, single_value = false)
       if data.empty?
         result = nil
       else
@@ -169,21 +171,21 @@ class Gitlab::CLI
           row = {}
 
           keys.each do |key|
-            case hash[key]
-            when Hash
-              row[key] = 'Hash'
-            when StringIO
-              row[key] = Base64.encode64(hash[key].read)
-            when nil
-              row[key] = nil
-            else
-              row[key] = hash[key]
-            end
+            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 > 0
+        result = result[0] if single_value && result.count.positive?
       end
 
       {
@@ -202,10 +204,10 @@ class Gitlab::CLI
     end
 
     # Helper function to call Gitlab commands with args.
-    def gitlab_helper(cmd, args=[])
+    def gitlab_helper(cmd, args = [])
       begin
         data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
-      rescue => e
+      rescue StandardError => e
         puts e.message
         yield if block_given?
       end
@@ -217,9 +219,9 @@ class Gitlab::CLI
     # @return [Hash]
     def symbolize_keys(hash)
       if hash.is_a?(Hash)
-        hash = hash.each_with_object({}) do |(key, value), newhash|
+        hash = hash.each_with_object({}) do |(key, value), new_hash|
           begin
-            newhash[key.to_sym] = symbolize_keys(value)
+            new_hash[key.to_sym] = symbolize_keys(value)
           rescue NoMethodError
             raise "Error: cannot convert hash key to symbol: #{key}"
           end
@@ -229,9 +231,16 @@ class Gitlab::CLI
       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)
-      YAML.safe_load(arg)
+      hex_color?(arg) ? arg : YAML.safe_load(arg)
     rescue Psych::SyntaxError
       raise "Error: Argument is not valid YAML syntax: #{arg}"
     end