gitlab 3.7.0 → 4.0.0

data/lib/gitlab/client/repositories.rb

@@ -1,42 +1,46 @@
 class Gitlab::Client
   # Defines methods related to repositories.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md
+  # @see https://docs.gitlab.com/ce/api/repositories.html
   module Repositories
-    # Get the contents of a file
-    #
-    # @example
-    #   Gitlab.file_contents(42, 'Gemfile')
-    #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [String] filepath The relative path of the file in the repository
-    # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
-    # @return [String]
-    def file_contents(project, filepath, ref='master')
-      ref = URI.encode(ref, /\W/)
-      get "/projects/#{project}/repository/blobs/#{ref}?filepath=#{filepath}",
-          format: nil,
-          headers: { Accept: 'text/plain' },
-          parser: ::Gitlab::Request::Parser
-    end
-    alias_method :repo_file_contents, :file_contents
-
     # Get file tree project (root level).
     #
     # @example
     #   Gitlab.tree(42)
     #   Gitlab.tree(42, { path: 'Gemfile' })
     #
-    # @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 [String] :path The path inside repository.
     # @option options [String] :ref_name The name of a repository branch or tag.
     # @return [Gitlab::ObjectifiedHash]
     def tree(project, options={})
-      get("/projects/#{project}/repository/tree", query: options)
+      get("/projects/#{url_encode project}/repository/tree", query: options)
     end
     alias_method :repo_tree, :tree
 
+    # Get project repository archive
+    #
+    # @example
+    #   Gitlab.repo_archive(42)
+    #   Gitlab.repo_archive(42, 'deadbeef')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] ref The commit sha, branch, or tag to download.
+    # @return [Gitlab::FileResponse]
+    def repo_archive(project, ref = 'master')
+      get("/projects/#{url_encode project}/repository/archive",
+          format: nil,
+          headers: { Accept: 'application/octet-stream' },
+          query: { sha: ref },
+          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
+
     # Compares branches, tags or commits.
     #
     # @example
@@ -48,7 +52,7 @@ class Gitlab::Client
     # @param [String] to The commit SHA or branch name of to branch.
     # @return [Gitlab::ObjectifiedHash]
     def compare(project, from, to)
-      get("/projects/#{project}/repository/compare", query: { from: from, to: to })
+      get("/projects/#{url_encode project}/repository/compare", query: { from: from, to: to })
     end
     alias_method :repo_compare, :compare
   end

data/lib/gitlab/client/repository_files.rb

@@ -2,20 +2,39 @@ require 'base64'
 
 class Gitlab::Client
   # Defines methods related to repository files.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repository_files.md
+  # @see https://docs.gitlab.com/ce/api/repository_files.html
   module RepositoryFiles
+    # Get the contents of a file
+    #
+    # @example
+    #   Gitlab.file_contents(42, 'Gemfile')
+    #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] filepath The relative path of the file in the repository
+    # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
+    # @return [String]
+    def file_contents(project, filepath, ref='master')
+      ref = URI.encode(ref, /\W/)
+      get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
+          query: { ref: ref},
+          format: nil,
+          headers: { Accept: 'text/plain' },
+          parser: ::Gitlab::Request::Parser
+    end
+    alias_method :repo_file_contents, :file_contents
+
     # Gets a repository file.
     #
     # @example
     #   Gitlab.get_file(42, "README.md", "master")
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] file_path The full path of the file.
     # @param  [String] ref The name of branch, tag or commit.
     # @return [Gitlab::ObjectifiedHash]
     def get_file(project, file_path, ref)
-      get("/projects/#{project}/repository/files", query: {
-            file_path: file_path,
+      get("/projects/#{url_encode project}/repository/files/#{url_encode file_path}", query: {
             ref: ref
           })
     end
@@ -25,14 +44,14 @@ class Gitlab::Client
     # @example
     #   Gitlab.create_file(42, "path", "branch", "content", "commit message")
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] full path to new file.
     # @param  [String] the name of the branch.
     # @param  [String] file content.
     # @param  [String] commit message.
     # @return [Gitlab::ObjectifiedHash]
     def create_file(project, path, branch, content, commit_message)
-      post("/projects/#{project}/repository/files", body: {
+      post("/projects/#{url_encode project}/repository/files", body: {
         file_path: path,
         branch_name: branch,
         commit_message: commit_message
@@ -44,14 +63,14 @@ class Gitlab::Client
     # @example
     #   Gitlab.edit_file(42, "path", "branch", "content", "commit message")
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] full path to new file.
     # @param  [String] the name of the branch.
     # @param  [String] file content.
     # @param  [String] commit message.
     # @return [Gitlab::ObjectifiedHash]
     def edit_file(project, path, branch, content, commit_message)
-      put("/projects/#{project}/repository/files", body: {
+      put("/projects/#{url_encode project}/repository/files", body: {
         file_path: path,
         branch_name: branch,
         commit_message: commit_message
@@ -63,13 +82,13 @@ class Gitlab::Client
     # @example
     #   Gitlab.remove_file(42, "path", "branch", "commit message")
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] full path to new file.
     # @param  [String] the name of the branch.
     # @param  [String] commit message.
     # @return [Gitlab::ObjectifiedHash]
     def remove_file(project, path, branch, commit_message)
-      delete("/projects/#{project}/repository/files", body: {
+      delete("/projects/#{url_encode project}/repository/files", body: {
                file_path: path,
                branch_name: branch,
                commit_message: commit_message

data/lib/gitlab/client/runners.rb

@@ -1,10 +1,10 @@
 class Gitlab::Client
   # Defines methods related to runners.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+  # @see https://docs.gitlab.com/ce/api/runners.html
   module Runners
 
     # Get a list of specific runners available to the user.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#list-owned-runners
     #
     # @example
     #   Gitlab.runners
@@ -19,7 +19,7 @@ class Gitlab::Client
     end
 
     # Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#list-all-runners
     #
     # @example
     #   Gitlab.all_runners
@@ -32,7 +32,7 @@ class Gitlab::Client
     end
 
     # Get details of a runner..
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#get-runners-details
     #
     # @example
     #   Gitlab.runner(42)
@@ -44,7 +44,7 @@ class Gitlab::Client
     end
 
     # Update details of a runner.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#update-runners-details
     #
     # @example
     #   Gitlab.update_runner(42, { description: 'Awesome runner' })
@@ -61,7 +61,7 @@ class Gitlab::Client
     end
 
     # Remove a runner.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#remove-a-runner
     #
     # @example
     #   Gitlab.delete_runner(42)
@@ -73,42 +73,42 @@ class Gitlab::Client
     end
 
     # List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project's settings.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#list-projects-runners
     #
     # @example
     #   Gitlab.project_runners(42)
     #
-    # @param  [Integer, String] id The ID of a project.
+    # @param  [Integer, String] id The ID or name of a project.
     # @return [Array<Gitlab::ObjectifiedHash>]
     def project_runners(project_id)
-      get("/projects/#{project_id}/runners")
+      get("/projects/#{url_encode project_id}/runners")
     end
 
     # Enable an available specific runner in the project.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#enable-a-runner-in-project
     #
     # @example
     #   Gitlab.project_enable_runner(2, 42)
     #
-    # @param  [Integer, String] id The ID of a project.
+    # @param  [Integer, String] id The ID or name of a project.
     # @param  [Integer, String] id The ID of a runner.
     # @return <Gitlab::ObjectifiedHash>
     def project_enable_runner(project_id, id)
       body = { runner_id: id }
-      post("/projects/#{project_id}/runners", body: body)
+      post("/projects/#{url_encode project_id}/runners", body: body)
     end
 
     # Disable a specific runner from the project. It works only if the project isn't the only project associated with the specified runner.
-    # Full runner params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/runners.md
+    # @see https://docs.gitlab.com/ce/api/runners.html#disable-a-runner-from-project
     #
     # @example
     #   Gitlab.project_disable_runner(2, 42)
     #
-    # @param  [Integer, String] id The ID of a project.
+    # @param  [Integer, String] id The ID or name of a project.
     # @param  [Integer, String] runner_id The ID of a runner.
     # @return <Gitlab::ObjectifiedHash>
     def project_disable_runner(id, runner_id)
-      delete("/projects/#{id}/runners/#{runner_id}")
+      delete("/projects/#{url_encode id}/runners/#{runner_id}")
     end
 
   end

data/lib/gitlab/client/services.rb

@@ -1,4 +1,6 @@
 class Gitlab::Client
+  # Third party services connected to a project.
+  # @see https://docs.gitlab.com/ce/api/services.html
   module Services
     # Create/Edit service
     # Full service params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/services.md
@@ -8,12 +10,12 @@ class Gitlab::Client
     #                                         project_url: 'https://example.com/projects/test_project/issues',
     #                                         issues_url: 'https://example.com/issues/:id' })
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] service A service code name.
     # @param  [Hash] params A service parameters.
     # @return [Boolean]
     def change_service(project, service, params)
-      put("/projects/#{project}/services/#{correct_service_name(service)}", body: params)
+      put("/projects/#{url_encode project}/services/#{correct_service_name(service)}", body: params)
     end
 
     # Delete service
@@ -21,11 +23,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.delete_service(42, :redmine)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] service A service code name.
     # @return [Boolean]
     def delete_service(project, service)
-      delete("/projects/#{project}/services/#{correct_service_name(service)}")
+      delete("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
     end
 
     # Get service
@@ -33,11 +35,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.service(42, :redmine)
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] service A service code name.
     # @return [Gitlab::ObjectifiedHash]
     def service(project, service)
-      get("/projects/#{project}/services/#{correct_service_name(service)}")
+      get("/projects/#{url_encode project}/services/#{correct_service_name(service)}")
     end
 
     private

data/lib/gitlab/client/snippets.rb

@@ -1,19 +1,19 @@
 class Gitlab::Client
   # Defines methods related to snippets.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/project_snippets.md
+  # @see https://docs.gitlab.com/ce/api/project_snippets.html
   module Snippets
     # Gets a list of project's snippets.
     #
     # @example
     #   Gitlab.snippets(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 [Gitlab::ObjectifiedHash]
     def snippets(project, options={})
-      get("/projects/#{project}/snippets", query: options)
+      get("/projects/#{url_encode project}/snippets", query: options)
     end
 
     # Gets information about a snippet.
@@ -21,11 +21,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.snippet(2, 14)
     #
-    # @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 snippet.
     # @return [Gitlab::ObjectifiedHash]
     def snippet(project, id)
-      get("/projects/#{project}/snippets/#{id}")
+      get("/projects/#{url_encode project}/snippets/#{id}")
     end
 
     # Creates a new snippet.
@@ -33,7 +33,7 @@ class Gitlab::Client
     # @example
     #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code' })
     #
-    # @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 [String] :title (required) The title of a snippet.
     # @option options [String] :file_name (required) The name of a snippet file.
@@ -41,7 +41,7 @@ class Gitlab::Client
     # @option options [String] :lifetime (optional) The expiration date of a snippet.
     # @return [Gitlab::ObjectifiedHash] Information about created snippet.
     def create_snippet(project, options={})
-      post("/projects/#{project}/snippets", body: options)
+      post("/projects/#{url_encode project}/snippets", body: options)
     end
 
     # Updates a snippet.
@@ -49,7 +49,7 @@ class Gitlab::Client
     # @example
     #   Gitlab.edit_snippet(42, 34, { file_name: 'README.txt' })
     #
-    # @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 snippet.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :title The title of a snippet.
@@ -58,7 +58,7 @@ class Gitlab::Client
     # @option options [String] :lifetime The expiration date of a snippet.
     # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
     def edit_snippet(project, id, options={})
-      put("/projects/#{project}/snippets/#{id}", body: options)
+      put("/projects/#{url_encode project}/snippets/#{id}", body: options)
     end
 
     # Deletes a snippet.
@@ -66,11 +66,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.delete_snippet(2, 14)
     #
-    # @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 snippet.
     # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
     def delete_snippet(project, id)
-      delete("/projects/#{project}/snippets/#{id}")
+      delete("/projects/#{url_encode project}/snippets/#{id}")
     end
 
     # Returns raw project snippet content as plain text.
@@ -78,11 +78,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.snippet_content(2, 14)
     #
-    # @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 snippet.
     # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
     def snippet_content(project, id)
-      get("/projects/#{project}/snippets/#{id}/raw",
+      get("/projects/#{url_encode project}/snippets/#{id}/raw",
           format: nil,
           headers: { Accept: 'text/plain' },
           parser: ::Gitlab::Request::Parser)

data/lib/gitlab/client/system_hooks.rb

@@ -1,6 +1,6 @@
 class Gitlab::Client
   # Defines methods related to system hooks.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/system_hooks.md
+  # @see https://docs.gitlab.com/ce/api/system_hooks.html
   module SystemHooks
     # Gets a list of system hooks.
     #

data/lib/gitlab/client/tags.rb

@@ -1,19 +1,19 @@
 class Gitlab::Client
   # Defines methods related to tags.
-  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/tags.md
+  # @see https://docs.gitlab.com/ce/api/tags.html
   module Tags
     # Gets a list of project repository tags.
     #
     # @example
     #   Gitlab.tags(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 tags(project, options={})
-      get("/projects/#{project}/repository/tags", query: options)
+      get("/projects/#{url_encode project}/repository/tags", query: options)
     end
     alias_method :repo_tags, :tags
 
@@ -23,14 +23,14 @@ class Gitlab::Client
     #   Gitlab.create_tag(42, 'new_tag', 'master')
     #   Gitlab.create_tag(42, 'v1.0', 'master', 'Release 1.0')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String]  tag_name The name of the new tag.
     # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
     # @param  [String]  message Optional message for tag, creates annotated tag if specified.
     # @param  [String]  description Optional release notes for tag.
     # @return [Gitlab::ObjectifiedHash]
     def create_tag(project, tag_name, ref, message='', description=nil)
-      post("/projects/#{project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, description: description })
+      post("/projects/#{url_encode project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, description: description })
     end
     alias_method :repo_create_tag, :create_tag
 
@@ -40,11 +40,11 @@ class Gitlab::Client
     #   Gitlab.tag(3, 'api')
     #   Gitlab.repo_tag(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] tag The name of the tag.
     # @return [Gitlab::ObjectifiedHash]
     def tag(project, tag)
-      get("/projects/#{project}/repository/tags/#{tag}")
+      get("/projects/#{url_encode project}/repository/tags/#{tag}")
     end
     alias_method :repo_tag, :tag
 
@@ -54,11 +54,11 @@ class Gitlab::Client
     #   Gitlab.delete_tag(3, 'api')
     #   Gitlab.repo_delete_tag(5, 'master')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] tag The name of the tag to delete
     # @return [Gitlab::ObjectifiedHash]
     def delete_tag(project, tag)
-      delete("/projects/#{project}/repository/tags/#{tag}")
+      delete("/projects/#{url_encode project}/repository/tags/#{tag}")
     end
     alias_method :repo_delete_tag, :delete_tag
 
@@ -68,12 +68,12 @@ class Gitlab::Client
     #   Gitlab.create_release(3, '1.0.0', 'This is ready for production')
     #   Gitlab.repo_create_release(5, '1.0.0', 'This is ready for production')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] tag The name of the new tag.
     # @param  [String] description Release notes with markdown support
     # @return [Gitlab::ObjectifiedHash]
     def create_release(project, tag, description)
-      post("/projects/#{project}/repository/tags/#{tag}/release", body: { description: description })
+      post("/projects/#{url_encode project}/repository/tags/#{tag}/release", body: { description: description })
     end
     alias_method :repo_create_release, :create_release
 
@@ -83,12 +83,12 @@ class Gitlab::Client
     #   Gitlab.update_release(3, '1.0.0', 'This is even more ready for production')
     #   Gitlab.repo_update_release(5, '1.0.0', 'This is even more ready for production')
     #
-    # @param  [Integer] project The ID of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] tag The name of the new tag.
     # @param  [String] description Release notes with markdown support
     # @return [Gitlab::ObjectifiedHash]
     def update_release(project, tag, description)
-      put("/projects/#{project}/repository/tags/#{tag}/release", body: { description: description })
+      put("/projects/#{url_encode project}/repository/tags/#{tag}/release", body: { description: description })
     end
     alias_method :repo_update_release, :update_release