gitlab 2.2.0 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e73d6232b1c15dcf05f0b58e12e4d93ca076d210
+  data.tar.gz: b8e227455c58f3195448c2712b0ea6f1e3d56ade
+SHA512:
+  metadata.gz: e624e3813e30c96657d5810788dc56bcf032b8f132a8a36a88ad3a7a13aa9a42f2c7bf3f61a47c9c21c5013dc09327e79d305db7a67f985530a6998c5e94da95
+  data.tar.gz: d118ef1b86f69311740d79e0f74390c8041e2c8a5b96345ed0edb52bbbc5bfa243fd380b8e8106eeaf71d28114968aeac879938ec5a76aa399d4adb2c075b47d

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/.travis.yml

@@ -1,2 +1,4 @@
 language: ruby
-rvm: 1.9.3
+rvm:
+  - 1.9.3
+  - 2.0.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Nihad Abbasov / NARKOZ
+Copyright (c) 2012-2013 Nihad Abbasov <mail@narkoz.me>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,6 +1,6 @@
 # Gitlab
 
-[![Build Status](https://secure.travis-ci.org/NARKOZ/gitlab.png)](http://travis-ci.org/NARKOZ/gitlab)
+[![Build Status](https://travis-ci.org/NARKOZ/gitlab.png)](http://travis-ci.org/NARKOZ/gitlab)
 
 Gitlab is a Ruby wrapper for the [GitLab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
 
@@ -57,6 +57,14 @@ user = g.user
 # get a user's email
 user.email
 # => "john@example.com"
+
+# set a sudo mode to perform API calls as another user
+Gitlab.sudo = 'other_user'
+# => "other_user"
+
+# disable a sudo mode
+Gitlab.sudo = nil
+# => nil
 ```
 
 For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).

data/lib/gitlab.rb

@@ -1,10 +1,10 @@
-require File.expand_path('../gitlab/version', __FILE__)
-require File.expand_path('../gitlab/objectified_hash', __FILE__)
-require File.expand_path('../gitlab/configuration', __FILE__)
-require File.expand_path('../gitlab/error', __FILE__)
-require File.expand_path('../gitlab/request', __FILE__)
-require File.expand_path('../gitlab/api', __FILE__)
-require File.expand_path('../gitlab/client', __FILE__)
+require 'gitlab/version'
+require 'gitlab/objectified_hash'
+require 'gitlab/configuration'
+require 'gitlab/error'
+require 'gitlab/request'
+require 'gitlab/api'
+require 'gitlab/client'
 
 module Gitlab
   extend Configuration

data/lib/gitlab/api.rb

@@ -11,7 +11,7 @@ module Gitlab
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
-      set_request_defaults @endpoint, @private_token
+      set_request_defaults @endpoint, @private_token, @sudo
     end
   end
 end

data/lib/gitlab/client.rb

@@ -3,12 +3,14 @@ module Gitlab
   class Client < API
     Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
 
-    include Gitlab::Client::Users
-    include Gitlab::Client::Issues
-    include Gitlab::Client::Milestones
-    include Gitlab::Client::Snippets
-    include Gitlab::Client::Projects
-    include Gitlab::Client::Repositories
-    include Gitlab::Client::MergeRequests
+    include Users
+    include Issues
+    include Notes
+    include Milestones
+    include Snippets
+    include Projects
+    include Repositories
+    include MergeRequests
+    include Groups
   end
 end

data/lib/gitlab/client/groups.rb

@@ -0,0 +1,88 @@
+class Gitlab::Client
+  # Defines methods related to groups.
+  module Groups
+    # Gets a list of groups.
+    #
+    # @example
+    #   Gitlab.groups
+    #   Gitlab.groups(:per_page => 40)
+    #
+    # @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 groups(options={})
+      get("/groups", :query => options)
+    end
+
+    # Gets a single group.
+    #
+    # @example
+    #   Gitlab.group(42)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group(id)
+      get("/groups/#{id}")
+    end
+
+    # Creates a new group.
+    #
+    # @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}
+      post("/groups", :body => body)
+    end
+
+    # Get a list of group members.
+    #
+    # @example
+    #   Gitlab.group_members(1)
+    #   Gitlab.group_members(1, :per_page => 40)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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 group_members(id, options={})
+      get("/groups/#{id}/members", :query => options)
+    end
+
+    # Adds a user to group.
+    #
+    # @example
+    #   Gitlab.add_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id to add a member to.
+    # @param  [Integer] user_id The user id of the user to add to the team.
+    # @param  [Integer] access_level Project access level.
+    # @return [Gitlab::ObjectifiedHash] Information about added team member.
+    def add_group_member(team_id, user_id, access_level)
+      post("/groups/#{team_id}/members", :body => {:user_id => user_id, :access_level => access_level})
+    end
+
+    # Removes user from user group.
+    #
+    # @example
+    #   Gitlab.remove_group_member(1, 2)
+    #
+    # @param  [Integer] team_id The group ID.
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash] Information about removed team member.
+    def remove_group_member(team_id, user_id)
+      delete("/groups/#{team_id}/members/#{user_id}")
+    end
+
+    # Transfers a project to a group
+    #
+    # @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
+  end
+end

data/lib/gitlab/client/issues.rb

@@ -2,14 +2,14 @@ class Gitlab::Client
   # Defines methods related to issues.
   module Issues
     # Gets a list of user's issues.
-    # Will return a list of project's issues if project ID or code name passed.
+    # Will return a list of project's issues if project ID passed.
     #
     # @example
     #   Gitlab.issues
     #   Gitlab.issues(5)
-    #   Gitlab.issues('gitlab', :per_page => 40)
+    #   Gitlab.issues(:per_page => 40)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @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.
@@ -25,19 +25,18 @@ class Gitlab::Client
     # Gets a single issue.
     #
     # @example
-    #   Gitlab.issue(5, 36)
-    #   Gitlab.issue('gitlab', 42)
+    #   Gitlab.issue(5, 42)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @return [Gitlab::ObjectifiedHash]
     def issue(project, id)
       get("/projects/#{project}/issues/#{id}")
     end
 
     # Creates a new issue.
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [String] title The title of an issue.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description The description of an issue.
@@ -52,7 +51,7 @@ class Gitlab::Client
 
     # Updates an issue.
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :title The title of an issue.
@@ -60,7 +59,7 @@ class Gitlab::Client
     # @option options [Integer] :assignee_id The ID of a user to assign issue.
     # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
     # @option options [String] :labels Comma-separated label names for an issue.
-    # @option options [Boolean] :closed The state of an issue (0 = false, 1 = true).
+    # @option options [String] :state_event The state event of an issue ('close' or 'reopen').
     # @return [Gitlab::ObjectifiedHash] Information about updated issue.
     def edit_issue(project, id, options={})
       put("/projects/#{project}/issues/#{id}", :body => options)
@@ -70,26 +69,24 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.close_issue(3, 42)
-    #   Gitlab.close_issue('gitlab', 42)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about closed issue.
     def close_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:closed => 1})
+      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'close'})
     end
 
     # Reopens an issue.
     #
     # @example
     #   Gitlab.reopen_issue(3, 42)
-    #   Gitlab.reopen_issue('gitlab', 42)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of an issue.
     # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
     def reopen_issue(project, id)
-      put("/projects/#{project}/issues/#{id}", :body => {:closed => 0})
+      put("/projects/#{project}/issues/#{id}", :body => {:state_event => 'reopen'})
     end
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -5,9 +5,9 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.merge_requests(5)
-    #   Gitlab.merge_requests('gitlab', :per_page => 40)
+    #   Gitlab.merge_requests(:per_page => 40)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @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.
@@ -20,13 +20,75 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.merge_request(5, 36)
-    #   Gitlab.merge_request('gitlab', 42)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a merge request.
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @return <Gitlab::ObjectifiedHash]
     def merge_request(project, id)
       get("/projects/#{project}/merge_request/#{id}")
     end
+
+    # Creates a merge request.
+    #
+    # @example
+    #   Gitlab.create_merge_request(5, 'New merge request',
+    #     :source_branch => 'source_branch', :target_branch => 'target_branch')
+    #   Gitlab.create_merge_request(5, 'New merge request',
+    #     :source_branch => 'source_branch', :target_branch => 'target_branch', :assignee_id => 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :source_branch (required) The source branch name.
+    # @option options [String] :target_branch (required) The target branch name.
+    # @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
+    # @return [Gitlab::ObjectifiedHash] Information about created merge request.
+    def create_merge_request(project, title, options={})
+      check_attributes!(options, [:source_branch, :target_branch])
+
+      body = {:title => title}.merge(options)
+      post("/projects/#{project}/merge_requests", :body => body)
+    end
+
+    # Updates a merge request.
+    #
+    # @example
+    #   Gitlab.update_merge_request(5, 42, :title => 'New title')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of a merge request.
+    # @option options [String] :source_branch The source branch name.
+    # @option options [String] :target_branch The target branch name.
+    # @option options [Integer] :assignee_id The ID of a user to assign merge request.
+    # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
+    def update_merge_request(project, id, options={})
+      put("/projects/#{project}/merge_request/#{id}", :body => options)
+    end
+
+    # Adds a comment to a merge request.
+    #
+    # @example
+    #   Gitlab.comment_merge_request(5, 1, "Awesome merge!")
+    #   Gitlab.comment_merge_request('gitlab', 1, "Awesome merge!")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @param  [String] note The content of a comment.
+    # @return [Gitlab::ObjectifiedHash] Information about created merge request comment.
+    def create_merge_request_comment(project, id, note)
+      post("/projects/#{project}/merge_request/#{id}/comments", :body => {:note => note})
+    end
+
+    private
+
+    def check_attributes!(options, attrs)
+      attrs.each do |attr|
+        unless options.has_key?(attr) || options.has_key?(attr.to_s)
+          raise Gitlab::Error::MissingAttributes.new("Missing '#{attr}' parameter")
+        end
+      end
+    end
   end
 end

data/lib/gitlab/client/milestones.rb

@@ -5,9 +5,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.milestones(5)
-    #   Gitlab.milestones('gitlab')
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @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.
@@ -20,18 +19,17 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.milestone(5, 36)
-    #   Gitlab.milestone('gitlab', 42)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID of a project.
     # @param  [Integer] id The ID of a milestone.
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @return [Gitlab::ObjectifiedHash]
     def milestone(project, id)
       get("/projects/#{project}/milestones/#{id}")
     end
 
     # Creates a new milestone.
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [String] title The title of a milestone.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :description The description of a milestone.
@@ -44,13 +42,13 @@ class Gitlab::Client
 
     # Updates a milestone.
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a milestone.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :title The title of a milestone.
     # @option options [String] :description The description of a milestone.
     # @option options [String] :due_date The due date of a milestone.
-    # @option options [Boolean] :closed The state of a milestone (0 = false, 1 = true).
+    # @option options [String] :state_event The state of a milestone ('close' or 'activate').
     # @return [Gitlab::ObjectifiedHash] Information about updated milestone.
     def edit_milestone(project, id, options={})
       put("/projects/#{project}/milestones/#{id}", :body => options)

data/lib/gitlab/client/notes.rb

@@ -0,0 +1,106 @@
+class Gitlab::Client
+  # Defines methods related to notes.
+  module Notes
+    # Gets a list of projects notes.
+    #
+    # @example
+    #   Gitlab.notes(5)
+    #
+    # @param [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def notes(project)
+      get("/projects/#{project}/notes")
+    end
+
+    # Gets a list of notes for a issue.
+    #
+    # @example
+    #   Gitlab.issue_notes(5, 10)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def issue_notes(project, issue)
+      get("/projects/#{project}/issues/#{issue}/notes")
+    end
+
+    # Gets a list of notes for a snippet.
+    #
+    # @example
+    #   Gitlab.snippet_notes(5, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def snippet_notes(project, snippet)
+      get("/projects/#{project}/snippets/#{snippet}/notes")
+    end
+
+    # Gets a single wall note.
+    #
+    # @example
+    #   Gitlab.note(5, 15)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def note(project, id)
+      get("/projects/#{project}/notes/#{id}")
+    end
+
+    # Gets a single issue note.
+    #
+    # @example
+    #   Gitlab.issue_note(5, 10, 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] issue The ID of an issue.
+    # @param [Integer] id The ID of a note.
+    # @return [Gitlab::ObjectifiedHash]
+    def issue_note(project, issue, id)
+      get("/projects/#{project}/issues/#{issue}/notes/#{id}")
+    end
+
+    # Gets a single snippet note.
+    #
+    # @example
+    #   Gitlab.snippet_note(5, 11, 3)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] snippet The ID of a snippet.
+    # @param [Integer] id The ID of an note.
+    # @return [Gitlab::ObjectifiedHash]
+    def snippet_note(project, snippet, id)
+      get("/projects/#{project}/snippets/#{snippet}/notes/#{id}")
+    end
+
+    # Creates a new 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.
+    def create_note(project, body)
+      post("/projects/#{project}/notes", :body => {:body => body})
+    end
+
+    # Creates a new issue note.
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] issue The ID of an issue.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_issue_note(project, issue, body)
+      post("/projects/#{project}/issues/#{issue}/notes", :body => {:body => body})
+    end
+
+    # Creates a new snippet note.
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] snippet The ID of a snippet.
+    # @param  [String] body The body of a note.
+    # @return [Gitlab::ObjectifiedHash] Information about created note.
+    def create_snippet_note(project, snippet, body)
+      post("/projects/#{project}/snippets/#{snippet}/notes", :body => {:body => body})
+    end
+  end
+end