gitlab 3.7.0 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b76c82ead8e87ca095bc2ad47515701b11c9735f
+  data.tar.gz: 758f96760c958422f9642878247aad32cc5962be
+SHA512:
+  metadata.gz: 14dcda9a02593219e14e7dd67f4480790022c755a7e2261da430784464a2cfc6c0c0f68f8eb3a599f08a39f27bf69e8c9b271bfc54ad4ae71393b56493e88283
+  data.tar.gz: 2b0c3d034013eaffaf176de7a334c95efc15d4f979dfa9e83e4e70de881571925a6d7ec03571ba55076506580673e5bf9b2584e0e99e285f1b763ba7506008c2

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 .bundle
 .config
 .yardoc
@@ -15,6 +16,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle
 .idea
 .ruby-version
 .ruby-gemset

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3
+  - 2.4.0
 before_install: gem update bundler

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## Change Log
 
+### Unreleased
+
+### 4.0.0 (10/04/2017)
+- Adds ability to create commits in a repository - (@logicminds)
+- Remove Ruby 1.x support from the project - (@orta)
+- Add `star_project` and `unstar_project` methods. (@connorshea)
+- Lock terminal-table to prevent build failures on Ruby 1.9/2.0. (@connorshea)
+- Update documentation to link to docs.gitlab.com instead of the GitHub mirror for GitLab CE. (@connorshea)
+- Add method `share_project_with_group` (@danhalligan)
+- Allow to retrieve `ssh_keys` for a specific user(@dirker)
+- Allow issues to use NAMESPACE/REPO identifier (@brodock)
+- Add issues subscribe/unsubscribe (@newellista)
+- Add merge_requests subscribe/unsubscribe (@newellista)
+- Updated `deploy_key` endpoints (@epintozzi)
+- Add milestone/merge_requests (API V4 only) (@joren)
+- Rename "git hook" to "push rule". (@asedge)
+- Change project fork endpoint for v4 API. (@asedge)
+- Block/unblock user now uses POST instead of PUT. (@asedge)
+- Project ID can also be a string (namespace/project_name). (@bergholdt)
+- Support pipeline. (@bergholdt)
+- Add methods to disable and enable deploy keys on projects. (@buzzdeee)
+- Add method to fetch issues a merge request will close. (@joren)
+- Fix `get_file` and `file_contents` methods to work with APIv4. (@asedge)
+
 ### 3.7.0 (16/08/2016)
 
 - Add in GitlabCI Runner support (@davidcollum)

data/README.md

@@ -10,7 +10,8 @@
 [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://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
+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.
 
 ## Installation
 
@@ -33,7 +34,7 @@ Configuration example:
 
 ```ruby
 Gitlab.configure do |config|
-  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
+  config.endpoint       = 'https://example.net/api/v4' # API endpoint URL, default: ENV['GITLAB_API_ENDPOINT']
   config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
   # Optional
   # config.user_agent   = 'Custom User Agent'          # user agent, default: 'Gitlab Ruby Gem [version]'
@@ -41,14 +42,14 @@ Gitlab.configure do |config|
 end
 ```
 
-(Note: If you are using Gitlab.com's hosted service, your endpoint will be `https://gitlab.com/api/v3`)
+(Note: If you are using GitLab.com's hosted service, your endpoint will be `https://gitlab.com/api/v4`)
 
 Usage examples:
 
 ```ruby
 # set an API endpoint
-Gitlab.endpoint = 'http://example.net/api/v3'
-# => "http://example.net/api/v3"
+Gitlab.endpoint = 'http://example.net/api/v4'
+# => "http://example.net/api/v4"
 
 # set a user private token
 Gitlab.private_token = 'qEsq1pt6HJPaNciie3MG'
@@ -107,7 +108,7 @@ For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/f
 
 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_ENDPOINT=https://gitlab.yourcompany.com/api/v4
 export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
 # This one is optional and can be used to set any HTTParty option you may need
 # using YAML hash syntax. For example, this is how you would disable SSL

data/gitlab.gemspec

@@ -19,12 +19,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "BSD"
 
-  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.required_ruby_version = ">= 2.0.0"
+
+  gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'terminal-table', '1.7.1'
 
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'

data/lib/gitlab/client.rb

@@ -15,6 +15,7 @@ module Gitlab
     include Milestones
     include Namespaces
     include Notes
+    include Pipelines
     include Projects
     include Repositories
     include RepositoryFiles
@@ -24,5 +25,28 @@ module Gitlab
     include SystemHooks
     include Tags
     include Users
+
+    # Text representation of the client, masking private token.
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      if @private_token
+        inspected = inspected.sub! @private_token, only_show_last_four_chars(@private_token)
+      end
+
+      inspected
+    end
+
+    def url_encode(s)
+      ERB::Util.url_encode(s)
+    end
+
+    private
+
+    def only_show_last_four_chars(token)
+      "#{'*'*(token.size - 4)}#{token[-4..-1]}"
+    end
   end
 end

data/lib/gitlab/client/branches.rb

@@ -1,19 +1,19 @@
 class Gitlab::Client
   # Defines methods related to repositories.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/branches.md
+  # @see https://docs.gitlab.com/ce/api/branches.html
   module Branches
     # Gets a list of project repositiory branches.
     #
     # @example
     #   Gitlab.branches(42)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def branches(project, options={})
-      get("/projects/#{project}/repository/branches", query: options)
+      get("/projects/#{url_encode project}/repository/branches", query: options)
     end
     alias_method :repo_branches, :branches
 
@@ -23,11 +23,11 @@ class Gitlab::Client
     #   Gitlab.branch(3, 'api')
     #   Gitlab.repo_branch(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def branch(project, branch)
-      get("/projects/#{project}/repository/branches/#{branch}")
+      get("/projects/#{url_encode project}/repository/branches/#{branch}")
     end
     alias_method :repo_branch, :branch
 
@@ -37,11 +37,11 @@ class Gitlab::Client
     #   Gitlab.protect_branch(3, 'api')
     #   Gitlab.repo_protect_branch(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def protect_branch(project, branch)
-      put("/projects/#{project}/repository/branches/#{branch}/protect")
+      put("/projects/#{url_encode project}/repository/branches/#{branch}/protect")
     end
     alias_method :repo_protect_branch, :protect_branch
 
@@ -51,11 +51,11 @@ class Gitlab::Client
     #   Gitlab.unprotect_branch(3, 'api')
     #   Gitlab.repo_unprotect_branch(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def unprotect_branch(project, branch)
-      put("/projects/#{project}/repository/branches/#{branch}/unprotect")
+      put("/projects/#{url_encode project}/repository/branches/#{branch}/unprotect")
     end
     alias_method :repo_unprotect_branch, :unprotect_branch
 
@@ -65,12 +65,12 @@ class Gitlab::Client
     #   Gitlab.create_branch(3, 'api')
     #   Gitlab.repo_create_branch(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the new branch.
     # @param  [String] ref Create branch from commit sha or existing branch
     # @return [Gitlab::ObjectifiedHash]
     def create_branch(project, branch, ref)
-      post("/projects/#{project}/repository/branches", body: { branch_name: branch, ref: ref })
+      post("/projects/#{url_encode project}/repository/branches", body: { branch_name: branch, ref: ref })
     end
     alias_method :repo_create_branch, :create_branch
 
@@ -80,11 +80,11 @@ class Gitlab::Client
     #   Gitlab.delete_branch(3, 'api')
     #   Gitlab.repo_delete_branch(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch to delete
     # @return [Gitlab::ObjectifiedHash]
     def delete_branch(project, branch)
-      delete("/projects/#{project}/repository/branches/#{branch}")
+      delete("/projects/#{url_encode project}/repository/branches/#{branch}")
     end
     alias_method :repo_delete_branch, :delete_branch
   end

data/lib/gitlab/client/build_triggers.rb

@@ -1,16 +1,16 @@
 class Gitlab::Client
   # Defines methods related to builds.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/build_triggers.md
+  # @see https://docs.gitlab.com/ce/api/build_triggers.html
   module BuildTriggers
     # Gets a list of the project's build triggers
     #
     # @example
     #   Gitlab.triggers(5)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @return [Array<Gitlab::ObjectifiedHash>] The list of triggers.
     def triggers(project)
-      get("/projects/#{project}/triggers")
+      get("/projects/#{url_encode project}/triggers")
     end
 
     # Gets details of project's build trigger.
@@ -18,11 +18,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.trigger(5, '7b9148c158980bbd9bcea92c17522d')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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}")
+      get("/projects/#{url_encode project}/triggers/#{token}")
     end
 
     # Create a build trigger for a project.
@@ -30,10 +30,10 @@ class Gitlab::Client
     # @example
     #   Gitlab.create_trigger(5)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @return [Gitlab::ObjectifiedHash] The trigger.
     def create_trigger(project)
-      post("/projects/#{project}/triggers")
+      post("/projects/#{url_encode project}/triggers")
     end
 
     # Remove a project's build trigger.
@@ -41,11 +41,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.remove_trigger(5, '7b9148c158980bbd9bcea92c17522d')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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}")
+      delete("/projects/#{url_encode project}/triggers/#{token}")
     end
   end
 end

data/lib/gitlab/client/build_variables.rb

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

data/lib/gitlab/client/builds.rb

@@ -1,6 +1,6 @@
 class Gitlab::Client
   # Defines methods related to builds.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/builds.md
+  # @see https://docs.gitlab.com/ce/api/builds.html
   module Builds
     # Gets a list of project builds.
     #
@@ -8,14 +8,14 @@ class Gitlab::Client
     #   Gitlab.builds(5)
     #   Gitlab.builds(5, { per_page: 10, page:  2 })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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.
+    # @param  [Integer, String] project The ID or name of a project.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def builds(project, options={})
-      get("/projects/#{project}/builds", query: options)
+      get("/projects/#{url_encode project}/builds", query: options)
     end
 
     # Gets a single build.
@@ -23,11 +23,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.build(5, 36)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a build.
     # @return [Gitlab::ObjectifiedHash]
     def build(project, id)
-      get("/projects/#{project}/builds/#{id}")
+      get("/projects/#{url_encode project}/builds/#{id}")
     end
 
     # Gets build artifacts.
@@ -35,11 +35,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.build_artifacts(1, 8)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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",
+      get("/projects/#{url_encode project}/builds/#{id}/artifacts",
            format: nil,
            headers: { Accept: 'application/octet-stream' },
            parser: proc { |body, _|
@@ -57,14 +57,14 @@ class Gitlab::Client
     #   Gitlab.commit_builds(5, 'asdf')
     #   Gitlab.commit_builds(5, 'asdf', { per_page: 10, page: 2 })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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)
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/builds", query: options)
     end
 
     # Cancels a build.
@@ -72,11 +72,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.build_cancel(5, 1)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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")
+      post("/projects/#{url_encode project}/builds/#{id}/cancel")
     end
 
     # Retry a build.
@@ -84,11 +84,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.build_retry(5, 1)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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")
+      post("/projects/#{url_encode project}/builds/#{id}/retry")
     end
 
     # Erase a single build of a project (remove build artifacts and a build trace)
@@ -96,11 +96,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.build_erase(5, 1)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name 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")
+      post("/projects/#{url_encode project}/builds/#{id}/erase")
     end
   end
 end