gitlab 3.6.1 → 3.7.0

data/.travis.yml

@@ -4,3 +4,5 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  - 2.3.0
+before_install: gem update bundler

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## Change Log
 
+### 3.7.0 (16/08/2016)
+
+- Add in GitlabCI Runner support (@davidcollum)
+- Implemented tags API methods (@jblackman)
+- Expose response status when Gitlab raises an error. (@calavera)
+- Add `build_artifacts` method (@nanofi)
+- Add `user_search` method (@Dreeg)
+- Added project git hook support (@liger1978)
+- Add the ability to delete an issue (@dandunckelman)
+- Add missing Build APIs (@edgemaster)
+- Improve record table output to use Hash `id` field if it exists. (@asedge)
+- Support for listing merge request notes (@dlukman)
+- Update YARD so it can be formatted easier for the CLI. (@asedge)
+- Add `options` to `build` method (@sanderhahn)
+- Add `delete_group` method (@shadeslayer)
+- Add `group_projects` method (@shadeslayer)
+- Add `edit_merge_request_comment` (@hjanuschka)
+- Add `merge_request_commits` method (@nomeaning777)
+- Add method `edit_group_member` (@coder-hugo)
+- New builds endpoints (@kmarcisz)
+- Use `respond_to_missing?` instead of `respond_to?` (@tsigo)
+- Added possibility to change emails of user (@azomazo)
+- Added possibility to change services in the project (@azomazo)
+- Update README.md (@walterheck)
+
 ### 3.6.1 (13/12/2015)
 
 - Fixed CLI output for collections

data/README.md

@@ -105,8 +105,7 @@ For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/f
 
 ## CLI
 
-Configuration example:
-
+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/v3
 export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
@@ -116,16 +115,23 @@ export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
 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.
+
 Usage examples:
 
 ```sh
 # list users
+# see: http://www.rubydoc.info/gems/gitlab/3.4.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
 gitlab user
 
 # get a user
+# see: http://www.rubydoc.info/gems/gitlab/3.4.0/Gitlab/Client/Users#user-instance_method
 gitlab user 2
 
 # filter output
@@ -137,6 +143,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
 gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
 
 ```

data/gitlab.gemspec

@@ -19,7 +19,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "BSD"
 
-  gem.add_runtime_dependency 'httparty'
+  if RUBY_VERSION < '2.0'
+    gem.add_runtime_dependency 'httparty', '~> 0.13.0'
+  else
+    gem.add_runtime_dependency 'httparty'
+  end
   gem.add_runtime_dependency 'terminal-table'
 
   gem.add_development_dependency 'pry'

data/lib/gitlab.rb

@@ -4,6 +4,7 @@ require 'gitlab/configuration'
 require 'gitlab/error'
 require 'gitlab/page_links'
 require 'gitlab/paginated_response'
+require 'gitlab/file_response'
 require 'gitlab/request'
 require 'gitlab/api'
 require 'gitlab/client'
@@ -25,8 +26,8 @@ module Gitlab
   end
 
   # Delegate to Gitlab::Client
-  def self.respond_to?(method)
-    client.respond_to?(method) || super
+  def respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
   end
 
   # Delegate to HTTParty.http_proxy

data/lib/gitlab/cli_helpers.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'json'
+require 'base64'
 
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
@@ -91,7 +92,7 @@ class Gitlab::CLI
     # Outputs a nicely formatted table or error msg.
     def output_table(cmd, args, data)
       case data
-      when Gitlab::ObjectifiedHash
+      when Gitlab::ObjectifiedHash, Gitlab::FileResponse
         puts record_table([data], cmd, args)
       when Gitlab::PaginatedResponse
         puts record_table(data, cmd, args)
@@ -105,7 +106,7 @@ class Gitlab::CLI
         puts '{}'
       else
         hash_result = case data
-                      when Gitlab::ObjectifiedHash
+                      when Gitlab::ObjectifiedHash,Gitlab::FileResponse
                         record_hash([data], cmd, args, true)
                       when Gitlab::PaginatedResponse
                         record_hash(data, cmd, args)
@@ -134,7 +135,9 @@ class Gitlab::CLI
           keys.each do |key|
             case value = hash[key]
             when Hash
-              value = 'Hash'
+              value = value.has_key?('id') ? value['id'] : 'Hash'
+            when StringIO
+              value = 'File'
             when nil
               value = 'null'
             end
@@ -168,6 +171,8 @@ class Gitlab::CLI
             case hash[key]
             when Hash
               row[key] = 'Hash'
+            when StringIO
+              row[key] = Base64.encode64(hash[key].read)
             when nil
               row[key] = nil
             else

data/lib/gitlab/client.rb

@@ -4,6 +4,9 @@ module Gitlab
     Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
 
     include Branches
+    include Builds
+    include BuildTriggers
+    include BuildVariables
     include Commits
     include Groups
     include Issues
@@ -15,8 +18,11 @@ module Gitlab
     include Projects
     include Repositories
     include RepositoryFiles
+    include Runners
+    include Services
     include Snippets
     include SystemHooks
+    include Tags
     include Users
   end
 end

data/lib/gitlab/client/build_triggers.rb

@@ -0,0 +1,51 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/build_triggers.md
+  module BuildTriggers
+    # Gets a list of the project's build triggers
+    #
+    # @example
+    #   Gitlab.triggers(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of triggers.
+    def triggers(project)
+      get("/projects/#{project}/triggers")
+    end
+
+    # Gets details of project's build trigger.
+    #
+    # @example
+    #   Gitlab.trigger(5, '7b9148c158980bbd9bcea92c17522d')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] token The token of a trigger.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def trigger(project, token)
+      get("/projects/#{project}/triggers/#{token}")
+    end
+
+    # Create a build trigger for a project.
+    #
+    # @example
+    #   Gitlab.create_trigger(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def create_trigger(project)
+      post("/projects/#{project}/triggers")
+    end
+
+    # Remove a project's build trigger.
+    #
+    # @example
+    #   Gitlab.remove_trigger(5, '7b9148c158980bbd9bcea92c17522d')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] token The token of a trigger.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def remove_trigger(project, token)
+      delete("/projects/#{project}/triggers/#{token}")
+    end
+  end
+end

data/lib/gitlab/client/build_variables.rb

@@ -0,0 +1,66 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/build_variables.md
+  module BuildVariables
+    # Gets a list of the project's build variables
+    #
+    # @example
+    #   Gitlab.variables(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
+    def variables(project)
+      get("/projects/#{project}/variables")
+    end
+
+    # Gets details of a project's specific build variable.
+    #
+    # @example
+    #   Gitlab.build(5, "TEST_VARIABLE_1")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def variable(project, key)
+      get("/projects/#{project}/variables/#{key}")
+    end
+
+    # Create a build variable for a project.
+    #
+    # @example
+    #   Gitlab.create_variable(5, "NEW_VARIABLE", "new value")
+    #
+    # @param  [Integer] project The ID 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
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def create_variable(project, key, value)
+      post("/projects/#{project}/variables", body: { key: key, value: value })
+    end
+
+    # Update a project's build variable.
+    #
+    # @example
+    #   Gitlab.create_variable(5, "NEW_VARIABLE", "updated value")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def update_variable(project, key, value)
+      put("/projects/#{project}/variables/#{key}", body: { value: value })
+    end
+
+    # Remove a project's build variable.
+    #
+    # @example
+    #   Gitlab.remove_variable(5, "VARIABLE_1")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def remove_variable(project, key)
+      delete("/projects/#{project}/variables/#{key}")
+    end
+  end
+end

data/lib/gitlab/client/builds.rb

@@ -0,0 +1,106 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/builds.md
+  module Builds
+    # Gets a list of project builds.
+    #
+    # @example
+    #   Gitlab.builds(5)
+    #   Gitlab.builds(5, { per_page: 10, page:  2 })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @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.
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def builds(project, options={})
+      get("/projects/#{project}/builds", query: options)
+    end
+
+    # Gets a single build.
+    #
+    # @example
+    #   Gitlab.build(5, 36)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash]
+    def build(project, id)
+      get("/projects/#{project}/builds/#{id}")
+    end
+
+    # Gets build artifacts.
+    #
+    # @example
+    #   Gitlab.build_artifacts(1, 8)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::FileResponse]
+    def build_artifacts(project, id)
+      get("/projects/#{project}/builds/#{id}/artifacts",
+           format: nil,
+           headers: { Accept: 'application/octet-stream' },
+           parser: proc { |body, _|
+            if body.encoding == Encoding::ASCII_8BIT # binary response
+              ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+            else # error with json response
+              ::Gitlab::Request.parse(body)
+            end
+          })
+    end
+
+    # Gets a list of builds for specific commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_builds(5, 'asdf')
+    #   Gitlab.commit_builds(5, 'asdf', { per_page: 10, page: 2 })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The SHA checksum of a commit.
+    # @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.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of builds.
+    def commit_builds(project, sha, options={})
+      get("/projects/#{project}/repository/commits/#{sha}/builds", query: options)
+    end
+
+    # Cancels a build.
+    #
+    # @example
+    #   Gitlab.build_cancel(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The builds changes.
+    def build_cancel(project, id)
+      post("/projects/#{project}/builds/#{id}/cancel")
+    end
+
+    # Retry a build.
+    #
+    # @example
+    #   Gitlab.build_retry(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Array<Gitlab::ObjectifiedHash>] The builds changes.
+    def build_retry(project, id)
+      post("/projects/#{project}/builds/#{id}/retry")
+    end
+
+    # Erase a single build of a project (remove build artifacts and a build trace)
+    #
+    # @example
+    #   Gitlab.build_erase(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The build's changes.
+    def build_erase(project, id)
+      post("/projects/#{project}/builds/#{id}/erase")
+    end
+  end
+end

data/lib/gitlab/client/commits.rb

@@ -6,7 +6,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.commits('viking')
-    #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
+    #   Gitlab.repo_commits('gitlab', { ref_name: 'api' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Hash] options A customizable set of options.
@@ -84,8 +84,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
-    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', name: 'jenkins')
-    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', name: 'jenkins', all: true)
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins' })
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins', all: true })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [String] sha The commit hash
@@ -103,8 +103,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'success')
-    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'failed', name: 'jenkins')
-    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'canceled', name: 'jenkins', target_url: 'http://example.com/builds/1')
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'failed', { name: 'jenkins' })
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'canceled', { name: 'jenkins', target_url: 'http://example.com/builds/1' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [String] sha The commit hash

data/lib/gitlab/client/groups.rb

@@ -6,7 +6,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.groups
-    #   Gitlab.groups(:per_page => 40)
+    #   Gitlab.groups({ per_page: 40, page: 2 })
     #
     # @param  [Hash] options A customizable set of options.
     # @option options [Integer] :page The page number.
@@ -31,7 +31,7 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.create_group('new-group', 'group-path')
-    #   Gitlab.create_group('gitlab', 'gitlab-path', :description => "New Gitlab project")
+    #   Gitlab.create_group('gitlab', 'gitlab-path', { description: 'New Gitlab project' })
     #
     # @param  [String] name The name of a group.
     # @param  [String] path The path of a group.
@@ -41,11 +41,21 @@ class Gitlab::Client
       post("/groups", body: body)
     end
 
+    # Delete's a group.
+    #
+    # @example
+    #   Gitlab.delete_group(42)
+    # @param  [Integer] id The ID of a group
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted group.
+    def delete_group(id)
+      delete("/groups/#{id}")
+    end
+
     # Get a list of group members.
     #
     # @example
     #   Gitlab.group_members(1)
-    #   Gitlab.group_members(1, :per_page => 40)
+    #   Gitlab.group_members(1, { per_page: 40 })
     #
     # @param  [Integer] id The ID of a group.
     # @param  [Hash] options A customizable set of options.
@@ -69,6 +79,19 @@ class Gitlab::Client
       post("/groups/#{team_id}/members", body: { user_id: user_id, access_level: access_level })
     end
 
+    # Edit a user of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_member(1, 2, 40)
+    #
+    # @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.
+    # @return [Gitlab::ObjectifiedHash] Information about edited team member.
+    def edit_group_member(team_id, user_id, access_level)
+      put("/groups/#{team_id}/members/#{user_id}", body: { access_level: access_level })
+    end
+
     # Removes user from user group.
     #
     # @example
@@ -107,5 +130,15 @@ class Gitlab::Client
       options[:search] = search
       get("/groups", query: options)
     end
+
+    # Get a list of projects under a group
+    # @example
+    #   Gitlab.group_projects(1)
+    #
+    # @param [Integer] id The ID of a group
+    # @return [Array<Gitlab::ObjectifiedHash>] List of projects under a group
+    def group_projects(id, options={})
+      get("/groups/#{id}/projects", query: options)
+    end
   end
 end