gitlab 3.4.0 → 3.5.0

data/lib/gitlab/client/groups.rb

@@ -29,11 +29,15 @@ class Gitlab::Client
 
     # Creates a new group.
     #
+    # @example
+    #   Gitlab.create_group('new-group', 'group-path')
+    #   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.
     # @return [Gitlab::ObjectifiedHash] Information about created group.
-    def create_group(name, path)
-      body = {:name => name, :path => path}
+    def create_group(name, path, options={})
+      body = {:name => name, :path => path}.merge(options)
       post("/groups", :body => body)
     end
 
@@ -79,11 +83,30 @@ class Gitlab::Client
 
     # Transfers a project to a group
     #
+    # @example
+    #   Gitlab.transfer_project_to_group(3, 50)
+    #
     # @param  [Integer] id The ID of a group.
     # @param  [Integer] project_id The ID of a project.
     def transfer_project_to_group(id, project_id)
       body = {:id => id, :project_id => project_id}
       post("/groups/#{id}/projects/#{project_id}", :body => body)
     end
+
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.group_search('gitlab')
+    #
+    # @param  [String] search A string to search for in group names and paths.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_search(search, options={})
+      options[:search] = search
+      get("/groups", :query => options)
+    end
+
   end
 end

data/lib/gitlab/client/issues.rb

@@ -37,6 +37,10 @@ class Gitlab::Client
 
     # Creates a new issue.
     #
+    # @example
+    #   Gitlab.create_issue(5, 'New issue')
+    #   Gitlab.create_issue(5, 'New issue', :description => "This is a new issue", :assignee_id => 42)
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [String] title The title of an issue.
     # @param  [Hash] options A customizable set of options.
@@ -52,6 +56,9 @@ class Gitlab::Client
 
     # Updates an issue.
     #
+    # @example
+    #   Gitlab.edit_issue(6, 1, :title => 'Updated title')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
     # @param  [Hash] options A customizable set of options.

data/lib/gitlab/client/milestones.rb

@@ -44,6 +44,9 @@ class Gitlab::Client
 
     # Creates a new milestone.
     #
+    # @example
+    #   Gitlab.create_milestone(5, 'v1.0')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [String] title The title of a milestone.
     # @param  [Hash] options A customizable set of options.
@@ -57,6 +60,9 @@ class Gitlab::Client
 
     # Updates a milestone.
     #
+    # @example
+    #   Gitlab.edit_milestone(5, 2, :state_event => 'activate')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a milestone.
     # @param  [Hash] options A customizable set of options.

data/lib/gitlab/client/namespaces.rb

@@ -0,0 +1,19 @@
+class Gitlab::Client
+  # Defines methods related to namespaces
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/namespaces.md
+  module Namespaces
+    # Gets a list of namespaces.
+    #
+    # @example
+    #   Gitlab.namespaces
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @options options [Integer] :page The page number.
+    # @options options [Integer] :per_page The number of results per page.
+    # @options opttion [String]  :search The string to search for.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def namespaces(options={})
+      get("/namespaces", :query => options)
+    end
+  end
+end

data/lib/gitlab/client/notes.rb

@@ -83,6 +83,9 @@ class Gitlab::Client
 
     # Creates a new wall note.
     #
+    # @example
+    #   Gitlab.create_note(5, 'This is a wall note!')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [String] body The body of a note.
     # @return [Gitlab::ObjectifiedHash] Information about created note.
@@ -92,6 +95,9 @@ class Gitlab::Client
 
     # Creates a new issue note.
     #
+    # @example
+    #   Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] issue The ID of an issue.
     # @param  [String] body The body of a note.
@@ -102,6 +108,9 @@ class Gitlab::Client
 
     # Creates a new snippet note.
     #
+    # @example
+    #   Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')
+    #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] snippet The ID of a snippet.
     # @param  [String] body The body of a note.
@@ -112,6 +121,9 @@ class Gitlab::Client
 
     # Creates a new note for a single merge request.
     #
+    # @example
+    #   Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')
+    #
     # @param [Integer] project The ID of a project.
     # @param [Integer] merge_request The ID of a merge request.
     # @param [String] body The content of a note.

data/lib/gitlab/client/projects.rb

@@ -321,5 +321,35 @@ class Gitlab::Client
     def delete_deploy_key(project, id)
       delete("/projects/#{project}/keys/#{id}")
     end
+
+    # Forks a project into the user namespace.
+    #
+    # @example
+    #   Gitlab.create_fork(42)
+    #   Gitlab.create_fork(42, :sudo => 'another_username')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :sudo The username the project will be forked for
+    # @return [Gitlab::ObjectifiedHash] Information about the forked project.
+    def create_fork(id, options = {})
+      post("/projects/fork/#{id}", body: options)
+    end
+
+    # Updates an existing project.
+    #
+    # @example
+    #   Gitlab.edit_project(42)
+    #   Gitlab.edit_project(42, :name => 'project_name')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name The name of a project
+    # @option options [String] :path The name of a project
+    # @option options [String] :description The name of a project
+    # @return [Gitlab::ObjectifiedHash] Information about the edited project.
+    def edit_project(id, options={})
+        put("/projects/#{id}", :query => options)
+    end
   end
 end

data/lib/gitlab/client/repositories.rb

@@ -33,51 +33,6 @@ class Gitlab::Client
     end
     alias_method :repo_create_tag, :create_tag
 
-    # Gets a list of project commits.
-    #
-    # @example
-    #   Gitlab.commits('viking')
-    #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :ref_name The branch or tag name of a project repository.
-    # @option options [Integer] :page The page number.
-    # @option options [Integer] :per_page The number of results per page.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def commits(project, options={})
-      get("/projects/#{project}/repository/commits", :query => options)
-    end
-    alias_method :repo_commits, :commits
-
-    # Gets a specific commit identified by the commit hash or name of a branch or tag.
-    #
-    # @example
-    #   Gitlab.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
-    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [String] sha The commit hash or name of a repository branch or tag
-    # @return [Gitlab::ObjectifiedHash]
-    def commit(project, sha)
-      get("/projects/#{project}/repository/commits/#{sha}")
-    end
-    alias_method :repo_commit, :commit
-
-    # Get the diff of a commit in a project.
-    #
-    # @example
-    #   Gitlab.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
-    #   Gitlab.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [String] sha The name of a repository branch or tag or if not given the default branch.
-    # @return [Gitlab::ObjectifiedHash]
-    def commit_diff(project, sha)
-      get("/projects/#{project}/repository/commits/#{sha}/diff")
-    end
-    alias_method :repo_commit_diff, :commit_diff
-
     # Get the contents of a file
     #
     # @example
@@ -97,36 +52,6 @@ class Gitlab::Client
     end
     alias_method :repo_file_contents, :file_contents
 
-    # Gets a list of comments for a commit.
-    #
-    # @example
-    #   Gitlab.commit_comments(5, c9f9662a9b1116c838b523ed64c6abdb4aae4b8b)
-    #
-    # @param [Integer] project The ID of a project.
-    # @param [String] sha The commit hash or name of a repository branch or tag.
-    # @option options [Integer] :page The page number.
-    # @option options [Integer] :per_page The number of results per page.
-    # @return [Array<Gitlab::ObjectifiedHash>]
-    def commit_comments(project, commit, options={})
-      get("/projects/#{project}/repository/commits/#{commit}/comments", :query => options)
-    end
-    alias_method :repo_commit_comments, :commit_comments
-
-    # Creates a new comment for a commit.
-    #
-    # @param  [Integer] project The ID of a project.
-    # @param  [String] sha The commit hash or name of a repository branch or tag.
-    # @param  [String] note The text of a comment.
-    # @param  [Hash] options A customizable set of options.
-    # @option options [String] :path The file path.
-    # @option options [Integer] :line The line number.
-    # @option options [String] :line_type The line type (new or old).
-    # @return [Gitlab::ObjectifiedHash] Information about created comment.
-    def create_commit_comment(project, commit, note, options={})
-      post("/projects/#{project}/repository/commits/#{commit}/comments", :body => options.merge(:note => note))
-    end
-    alias_method :repo_create_commit_comment, :create_commit_comment
-
     # Get file tree project (root level).
     #
     # @example

data/lib/gitlab/client/repository_files.rb

@@ -4,6 +4,22 @@ class Gitlab::Client
   # Defines methods related to repository files.
   # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repository_files.md
   module RepositoryFiles
+    # Gets a repository file.
+    #
+    # @example
+    #   Gitlab.get_file(42, "README.md", "master")
+    #
+    # @param  [Integer] project The ID 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,
+        ref: ref,
+      })
+    end
+
     # Creates a new repository file.
     #
     # @example

data/lib/gitlab/client/snippets.rb

@@ -72,5 +72,20 @@ class Gitlab::Client
     def delete_snippet(project, id)
       delete("/projects/#{project}/snippets/#{id}")
     end
+
+    # Returns raw project snippet content as plain text.
+    #
+    # @example
+    #   Gitlab.snippet_content(2, 14)
+    #
+    # @param  [Integer] project The ID 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",
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser)
+    end
   end
 end

data/lib/gitlab/client/users.rb

@@ -32,8 +32,14 @@ class Gitlab::Client
     # Creates a new user.
     # Requires authentication from an admin account.
     #
+    # @example
+    #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', :name => 'Joe Smith')
+    #   or
+    #   Gitlab.create_user('joe@foo.org', 'secret')
+    #
     # @param  [String] email The email of a user.
     # @param  [String] password The password of a user.
+    # @param  [String] username The username of a user.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :name The name of a user. Defaults to email.
     # @option options [String] :skype The skype of a user.
@@ -41,17 +47,26 @@ class Gitlab::Client
     # @option options [String] :twitter The twitter of a user.
     # @option options [Integer] :projects_limit The limit of projects for a user.
     # @return [Gitlab::ObjectifiedHash] Information about created user.
-    def create_user(email, password, options={})
-      body = {:email => email, :password => password, :name => email}.merge(options)
-      post("/users", :body => body)
+    def create_user(*args)
+      options = Hash === args.last ? args.pop : {}
+      if args[2]
+        body = { email: args[0], password: args[1], username: args[2] }
+      else
+        body = { email: args[0], password: args[1], name: args[0] }
+      end
+      body.merge!(options)
+      post('/users', body: body)
     end
 
     # Updates a user.
     #
+    # @example
+    #   Gitlab.edit_user(15, :email => 'joe.smith@foo.org', :projects_limit => 20)
+    #
     # @param  [Integer] id The ID of a user.
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] email The email of a user.
-    # @option options [String] password The password of a user.
+    # @option options [String] :email The email of a user.
+    # @option options [String] :password The password of a user.
     # @option options [String] :name The name of a user. Defaults to email.
     # @option options [String] :skype The skype of a user.
     # @option options [String] :linkedin The linkedin of a user.
@@ -62,6 +77,39 @@ class Gitlab::Client
       put("/users/#{user_id}", :body => options)
     end
 
+    # Deletes a user.
+    #
+    # @example
+    #   Gitlab.delete_user(1)
+    #
+    # @param [Integer] id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted user.
+    def delete_user(user_id)
+      delete("/users/#{user_id}")
+    end
+
+    # Blocks the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.block_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def block_user(user_id)
+      put("/users/#{user_id}/block")
+    end
+
+    # Unblocks the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.unblock_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def unblock_user(user_id)
+      put("/users/#{user_id}/unblock")
+    end
+
     # Creates a new user session.
     #
     # @example
@@ -121,5 +169,6 @@ class Gitlab::Client
     def delete_ssh_key(id)
       delete("/user/keys/#{id}")
     end
+
   end
 end

data/lib/gitlab/configuration.rb

@@ -1,3 +1,4 @@
+require 'gitlab/cli_helpers'
 module Gitlab
   # Defines constants and methods related to configuration.
   module Configuration
@@ -34,8 +35,21 @@ module Gitlab
     def reset
       self.endpoint       = ENV['GITLAB_API_ENDPOINT']
       self.private_token  = ENV['GITLAB_API_PRIVATE_TOKEN'] || ENV['GITLAB_API_AUTH_TOKEN']
+      self.httparty       = get_httparty_config(ENV['GITLAB_API_HTTPARTY_OPTIONS'])
       self.sudo           = nil
       self.user_agent     = DEFAULT_USER_AGENT
     end
+
+    private
+
+    # Allows HTTParty config to be specified in ENV using YAML hash.
+    def get_httparty_config options
+      return options if options.nil?
+
+      httparty = Gitlab::CLI::Helpers.yaml_load(options)
+
+      raise ArgumentError, "HTTParty config should be a Hash." unless httparty.is_a? Hash
+      Gitlab::CLI::Helpers.symbolize_keys httparty
+    end
   end
 end

data/lib/gitlab/error.rb

@@ -27,6 +27,9 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 409.
     class Conflict < Error; end
 
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < Error; end
+
     # Raised when API endpoint returns the HTTP status code 500.
     class InternalServerError < Error; end