gitlab 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fd8bd1d12fdceba122d4fd99e3df259c399e629
-  data.tar.gz: dd195a082fc9a572a22ff4074306891ccc9553a1
+SHA256:
+  metadata.gz: 4bfad0b28f61c172f39cceece1d908d7bbd6a339dfd94bde1fd2fd91894947c4
+  data.tar.gz: 991192468932b419e0f7512ac0034a942a994fe09ab66372f195332e81fbc639
 SHA512:
-  metadata.gz: 0edc2245a554decf8c18723979c256e6e7926d67521fa9ffeef11508b3bad1501e31ea3fe7ba91c1e9a5efe98a66149e6be3f2adcb25199c3118e5e6bde9b847
-  data.tar.gz: 12aa581f975cd5bbc7cebe3fb75eef20d1fb87eab9119af485c3a2158779a673cd0c1da74ee4a0d91f05adfe582a35f906e7679f2fd4650f65b5c04167926c28
+  metadata.gz: 6c769c30e5072d68696fe7cc75747744aa6ff28a232f7084eb96cc78dbe4853a213d456a95d3a635197ef4a9473ddfd5fd7379654a6a1811c6b74b87f6c62a37
+  data.tar.gz: 48292a8b7dafad7fbaf577bcff3065b97beeb47610e68d513544f66f48881b0bd291cfa5110835a52d177927a6ee8a4acc8b0d8bb48d0b595951bc1a2b1032d8

data/.rubocop.yml

@@ -0,0 +1,33 @@
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Layout/DotPosition:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'lib/gitlab/client/*'
+    - 'spec/**/*'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/gitlab/client/*'
+
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/gitlab/client/*'
+
+Style/StringLiterals:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3
-  - 2.4.0
+  - 2.4
 before_install: gem update bundler
+
+matrix:
+  include:
+    - rvm: 2.4
+      env: "TRAVIS_CI_RUBOCOP=true"
+  allow_failures:
+    - env: "TRAVIS_CI_RUBOCOP=true"

data/README.md

@@ -1,17 +1,17 @@
 # Gitlab
 
-[![Build Status](https://img.shields.io/travis/NARKOZ/gitlab.svg?style=flat)](https://travis-ci.org/NARKOZ/gitlab)
-[![Code Climate](https://img.shields.io/codeclimate/github/NARKOZ/gitlab.svg?style=flat)](https://codeclimate.com/github/NARKOZ/gitlab)
-[![Inline docs](http://inch-ci.org/github/NARKOZ/gitlab.svg?style=flat)](https://inch-ci.org/github/NARKOZ/gitlab)
-[![Gem version](https://img.shields.io/gem/v/gitlab.svg?style=flat)](https://rubygems.org/gems/gitlab)
-[![License](https://img.shields.io/badge/license-BSD-red.svg?style=flat)](https://github.com/NARKOZ/gitlab/blob/master/LICENSE.txt)
+[![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)
+[![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) |
 [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 will only support Ruby 2.0+ and Gitlab API v4.
+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.
 
 ## Installation
 

data/Rakefile

@@ -1,9 +1,17 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern    = FileList['spec/**/*_spec.rb']
   spec.rspec_opts = ['--color', '--format d']
 end
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['-D', '--parallel']
+end
+
+if ENV['TRAVIS_CI_RUBOCOP']
+  task default: :rubocop
+else
+  task default: :spec
+end

data/gitlab.gemspec

@@ -1,25 +1,24 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "gitlab"
+  gem.name          = 'gitlab'
   gem.version       = Gitlab::VERSION
-  gem.authors       = ["Nihad Abbasov"]
-  gem.email         = ["mail@narkoz.me"]
-  gem.description   = %q{Ruby client and CLI for GitLab API}
-  gem.summary       = %q{A Ruby wrapper and CLI for the GitLab API}
-  gem.homepage      = "https://github.com/narkoz/gitlab"
+  gem.authors       = ['Nihad Abbasov']
+  gem.email         = ['mail@narkoz.me']
+  gem.description   = 'Ruby client and CLI for GitLab API'
+  gem.summary       = 'A Ruby wrapper and CLI for the GitLab API'
+  gem.homepage      = 'https://github.com/narkoz/gitlab'
 
   gem.files         = `git ls-files`.split($/)
-  gem.bindir        = "exe"
+  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.require_paths = ['lib']
+  gem.license       = 'BSD'
 
-  gem.required_ruby_version = ">= 2.0.0"
+  gem.required_ruby_version = '>= 2.0.0'
 
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'terminal-table'
@@ -28,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'rubocop'
 end

data/lib/gitlab.rb

@@ -26,7 +26,7 @@ module Gitlab
   end
 
   # Delegate to Gitlab::Client
-  def 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
 
@@ -39,7 +39,7 @@ module Gitlab
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults|httparty/
+    hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|request_defaults|httparty/
     (Gitlab::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
   end
 end

data/lib/gitlab/api.rb

@@ -13,7 +13,8 @@ module Gitlab
       (Configuration::VALID_OPTIONS_KEYS + [:auth_token]).each do |key|
         send("#{key}=", options[key]) if options[key]
       end
-      set_request_defaults(@sudo)
+      request_defaults(@sudo)
+      self.class.headers 'User-Agent' => user_agent
     end
   end
 end

data/lib/gitlab/cli.rb

@@ -52,15 +52,11 @@ class Gitlab::CLI
       end
 
       unless valid_command?(cmd)
-        puts "Unknown command. Run `gitlab help` for a list of available commands."
+        puts 'Unknown command. Run `gitlab help` for a list of available commands.'
         exit(1)
       end
 
-      if args.any? && (args.last.start_with?('--only=') || args.last.start_with?('--except='))
-        command_args = args[0..-2]
-      else
-        command_args = args
-      end
+      command_args = args.any? && args.last.start_with?('--only=', '--except=') ? args[0..-2] : args
 
       begin
         command_args.map! { |arg| symbolize_keys(yaml_load(arg)) }

data/lib/gitlab/cli_helpers.rb

@@ -67,14 +67,15 @@ class Gitlab::CLI
     #
     # @return [String]
     def confirm_command(cmd)
-      if cmd.start_with?('remove_') || cmd.start_with?('delete_')
-        puts "Are you sure? (y/n)"
-        if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
-          puts 'Proceeding..'
-        else
-          puts 'Command aborted.'
-          exit(1)
-        end
+      return unless cmd.start_with?('remove_', 'delete_')
+
+      puts 'Are you sure? (y/n)'
+
+      if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+        puts 'Proceeding..'
+      else
+        puts 'Command aborted.'
+        exit(1)
       end
     end
 
@@ -102,17 +103,17 @@ class Gitlab::CLI
     end
 
     def output_json(cmd, args, data)
-      if data.empty?
+      if data.respond_to?(:empty?) && data.empty?
         puts '{}'
       else
         hash_result = case data
-                      when Gitlab::ObjectifiedHash,Gitlab::FileResponse
+                      when Gitlab::ObjectifiedHash, Gitlab::FileResponse
                         record_hash([data], cmd, args, true)
                       when Gitlab::PaginatedResponse
                         record_hash(data, cmd, args)
                       else
                         { cmd: cmd, data: data, args: args }
-        end
+                      end
         puts JSON.pretty_generate(hash_result)
       end
     end
@@ -135,7 +136,7 @@ class Gitlab::CLI
           keys.each do |key|
             case value = hash[key]
             when Hash
-              value = value.has_key?('id') ? value['id'] : 'Hash'
+              value = value.key?('id') ? value['id'] : 'Hash'
             when StringIO
               value = 'File'
             when nil
@@ -194,7 +195,7 @@ class Gitlab::CLI
     # Helper function to get rows and keys from data returned from API call
     def get_keys(args, data)
       arr = data.map(&:to_h)
-      keys = arr.first.keys.sort { |x, y| x.to_s <=> y.to_s }
+      keys = arr.first.keys.sort_by(&:to_s)
       keys &= required_fields(args) if required_fields(args).any?
       keys -= excluded_fields(args)
       [arr, keys]
@@ -220,7 +221,7 @@ class Gitlab::CLI
           begin
             newhash[key.to_sym] = symbolize_keys(value)
           rescue NoMethodError
-            raise "error: cannot convert hash key to symbol: #{key}"
+            raise "Error: cannot convert hash key to symbol: #{key}"
           end
         end
       end
@@ -230,12 +231,9 @@ class Gitlab::CLI
 
     # YAML::load on a single argument
     def yaml_load(arg)
-      begin
-        yaml = YAML.load(arg)
-      rescue Psych::SyntaxError
-        raise "error: Argument is not valid YAML syntax: #{arg}"
-      end
-      yaml
+      YAML.safe_load(arg)
+    rescue Psych::SyntaxError
+      raise "Error: Argument is not valid YAML syntax: #{arg}"
     end
   end
 end

data/lib/gitlab/client.rb

@@ -3,23 +3,27 @@ module Gitlab
   class Client < API
     Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
 
+    # Please keep in alphabetical order
     include AwardEmojis
     include Boards
     include Branches
-    include Builds
     include BuildVariables
+    include Builds
     include Commits
+    include Deployments
     include Environments
     include Groups
     include Issues
+    include Jobs
     include Keys
     include Labels
     include MergeRequests
     include Milestones
     include Namespaces
     include Notes
-    include Pipelines
+    include PipelineSchedules
     include PipelineTriggers
+    include Pipelines
     include Projects
     include Repositories
     include RepositoryFiles
@@ -30,7 +34,6 @@ module Gitlab
     include Tags
     include Todos
     include Users
-    include Jobs
 
     # Text representation of the client, masking private token.
     #
@@ -46,13 +49,13 @@ module Gitlab
     end
 
     def url_encode(s)
-      ERB::Util.url_encode(s)
+      URI.encode(s.to_s, /\W/)
     end
 
     private
 
     def only_show_last_four_chars(token)
-      "#{'*'*(token.size - 4)}#{token[-4..-1]}"
+      "#{'*' * (token.size - 4)}#{token[-4..-1]}"
     end
   end
 end

data/lib/gitlab/client/branches.rb

@@ -27,7 +27,7 @@ class Gitlab::Client
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def branch(project, branch)
-      get("/projects/#{url_encode project}/repository/branches/#{branch}")
+      get("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
     end
     alias_method :repo_branch, :branch
 
@@ -47,7 +47,7 @@ class Gitlab::Client
     # @option options [Boolean] :developers_can_merge True to allow developers to merge into the branch (default = false)
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def protect_branch(project, branch, options = {})
-      put("/projects/#{url_encode project}/repository/branches/#{branch}/protect", body: options)
+      post("/projects/#{url_encode project}/protected_branches", body: {name: branch}.merge(options))
     end
     alias_method :repo_protect_branch, :protect_branch
 
@@ -61,7 +61,7 @@ class Gitlab::Client
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash] Details about the branch
     def unprotect_branch(project, branch)
-      put("/projects/#{url_encode project}/repository/branches/#{branch}/unprotect")
+      delete("/projects/#{url_encode project}/protected_branches/#{url_encode branch}")
     end
     alias_method :repo_unprotect_branch, :unprotect_branch
 
@@ -89,7 +89,7 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch to delete
     def delete_branch(project, branch)
-      delete("/projects/#{url_encode project}/repository/branches/#{branch}")
+      delete("/projects/#{url_encode project}/repository/branches/#{url_encode branch}")
     end
     alias_method :repo_delete_branch, :delete_branch
   end

data/lib/gitlab/client/build_variables.rb

@@ -1,6 +1,7 @@
 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
   module BuildVariables
     # Gets a list of the project's build variables
     #
@@ -16,7 +17,7 @@ class Gitlab::Client
     # Gets details of a project's specific build variable.
     #
     # @example
-    #   Gitlab.build(5, "TEST_VARIABLE_1")
+    #   Gitlab.variable(5, "TEST_VARIABLE_1")
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] key The key of a variable.
@@ -41,7 +42,7 @@ class Gitlab::Client
     # Update a project's build variable.
     #
     # @example
-    #   Gitlab.create_variable(5, "NEW_VARIABLE", "updated value")
+    #   Gitlab.update_variable(5, "NEW_VARIABLE", "updated value")
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] key The key of a variable
@@ -62,5 +63,66 @@ class Gitlab::Client
     def remove_variable(project, key)
       delete("/projects/#{url_encode project}/variables/#{key}")
     end
+
+    # Gets a list of the group's build variables
+    #
+    # @example
+    #   Gitlab.group_variables(5)
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
+    def group_variables(group)
+      get("/groups/#{url_encode group}/variables")
+    end
+
+    # Gets details of a group's specific build variable.
+    #
+    # @example
+    #   Gitlab.group_variable(5, "TEST_VARIABLE_1")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def group_variable(group, key)
+      get("/groups/#{url_encode group}/variables/#{key}")
+    end
+
+    # Create a build variable for a group.
+    #
+    # @example
+    #   Gitlab.create_group_variable(5, "NEW_VARIABLE", "new value")
+    #
+    # @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
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def create_group_variable(group, key, value)
+      post("/groups/#{url_encode group}/variables", body: { key: key, value: value })
+    end
+
+    # Update a group's build variable.
+    #
+    # @example
+    #   Gitlab.update_group_variable(5, "NEW_VARIABLE", "updated value")
+    #
+    # @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
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def update_group_variable(group, key, value)
+      put("/groups/#{url_encode group}/variables/#{key}", body: { value: value })
+    end
+
+    # Remove a group's build variable.
+    #
+    # @example
+    #   Gitlab.remove_group_variable(5, "VARIABLE_1")
+    #
+    # @param  [Integer, String] group The ID or name of a group.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def remove_group_variable(group, key)
+      delete("/groups/#{url_encode group}/variables/#{key}")
+    end
   end
 end