gitlab 3.0.0 → 3.1.0

data/lib/gitlab/client/projects.rb

@@ -9,9 +9,14 @@ class Gitlab::Client
     # @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.
+    # @option options [String] :scope Scope of projects. 'owned' for list of projects owned by the authenticated user, 'all' to get all projects (admin only)
     # @return [Array<Gitlab::ObjectifiedHash>]
     def projects(options={})
-      get("/projects", :query => options)
+      if (options[:scope])
+        get("/projects/#{options[:scope]}", :query => options)
+      else
+        get("/projects", :query => options)
+      end
     end
 
     # Gets information about a project.
@@ -50,6 +55,17 @@ class Gitlab::Client
       post(url, :body => {:name => name}.merge(options))
     end
 
+    # Deletes a project.
+    #
+    # @example
+    #   Gitlab.delete_project(4)
+    #
+    # @param  [Integer, String] id The ID or name of a project.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted project.
+    def delete_project(id)
+      delete("/projects/#{id}")
+    end
+
     # Gets a list of project team members.
     #
     # @example
@@ -154,9 +170,14 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] url The hook URL.
+    # @param  [Hash] options Events list (`{push_events: true, merge_requests_events: false}`).
     # @return [Gitlab::ObjectifiedHash] Information about added hook.
-    def add_project_hook(project, url)
-      post("/projects/#{project}/hooks", :body => {:url => url})
+    def add_project_hook(project, url, options = {})
+      available_events = [:push_events, :merge_requests_events, :issues_events]
+      passed_events = available_events.select { |event| options[event] }
+      events = Hash[passed_events.map { |event| [event, options[event]] }]
+
+      post("/projects/#{project}/hooks", :body => {:url => url}.merge(events))
     end
 
     # Updates a project hook URL.
@@ -244,7 +265,7 @@ class Gitlab::Client
     # @param  [String] key The content of a deploy key.
     # @return [Gitlab::ObjectifiedHash] Information about created deploy key.
     def create_deploy_key(project, title, key)
-      post("/projects/#{project}/keys", title: title, key: key)
+      post("/projects/#{project}/keys", body: {title: title, key: key})
     end
 
     # Deletes a deploy key from project.

data/lib/gitlab/client/repositories.rb

@@ -16,50 +16,49 @@ class Gitlab::Client
     end
     alias_method :repo_tags, :tags
 
-    # Gets a list of project repositiory branches.
+    # Gets a list of project commits.
     #
     # @example
-    #   Gitlab.branches(42)
+    #   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 branches(project, options={})
-      get("/projects/#{project}/repository/branches", :query => options)
+    def commits(project, options={})
+      get("/projects/#{project}/repository/commits", :query => options)
     end
-    alias_method :repo_branches, :branches
+    alias_method :repo_commits, :commits
 
-    # Gets information about a repository branch.
+    # Gets a specific commit identified by the commit hash or name of a branch or tag.
     #
     # @example
-    #   Gitlab.branch(3, 'api')
-    #   Gitlab.repo_branch(5, 'master')
+    #   Gitlab.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
     #
     # @param  [Integer] project The ID of a project.
-    # @param  [String] branch The name of the branch.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
     # @return [Gitlab::ObjectifiedHash]
-    def branch(project, branch)
-      get("/projects/#{project}/repository/branches/#{branch}")
+    def commit(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}")
     end
-    alias_method :repo_branch, :branch
+    alias_method :repo_commit, :commit
 
-    # Gets a list of project commits.
+    # Get the diff of a commit in a project.
     #
     # @example
-    #   Gitlab.commits('viking')
-    #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
+    #   Gitlab.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
     #
     # @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)
+    # @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_commits, :commits
+    alias_method :repo_commit_diff, :commit_diff
   end
 end

data/lib/gitlab/client/system_hooks.rb

@@ -0,0 +1,58 @@
+class Gitlab::Client
+  # Defines methods related to system hooks.
+  module SystemHooks
+    # Gets a list of system hooks.
+    #
+    # @example
+    #   Gitlab.hooks
+    #   Gitlab.system_hooks
+    #
+    # @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 hooks(options={})
+      get("/hooks", query: options)
+    end
+    alias_method :system_hooks, :hooks
+
+    # Adds a new system hook.
+    #
+    # @example
+    #   Gitlab.add_hook('http://example.com/hook')
+    #   Gitlab.add_system_hook('https://api.example.net/v1/hook')
+    #
+    # @param  [String] url The hook URL.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_hook(url)
+      post("/hooks", :body => {:url => url})
+    end
+    alias_method :add_system_hook, :add_hook
+
+    # Tests a system hook.
+    #
+    # @example
+    #   Gitlab.hook(3)
+    #   Gitlab.system_hook(12)
+    #
+    # @param  [Integer] id The ID of a system hook.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def hook(id)
+      get("/hooks/#{id}")
+    end
+    alias_method :system_hook, :hook
+
+    # Deletes a new system hook.
+    #
+    # @example
+    #   Gitlab.delete_hook(3)
+    #   Gitlab.delete_system_hook(12)
+    #
+    # @param  [Integer] id The ID of a system hook.
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_hook(id)
+      delete("/hooks/#{id}")
+    end
+    alias_method :delete_system_hook, :delete_hook
+  end
+end

data/lib/gitlab/client/users.rb

@@ -44,6 +44,22 @@ class Gitlab::Client
       post("/users", :body => body)
     end
 
+    # Updates a user.
+    #
+    # @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] :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.
+    # @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 edit_user(user_id, options={})
+      put("/users/#{user_id}", :body => options)
+    end
+
     # Creates a new user session.
     #
     # @example
@@ -52,6 +68,7 @@ class Gitlab::Client
     # @param  [String] email The email of a user.
     # @param  [String] password The password of a user.
     # @return [Gitlab::ObjectifiedHash]
+    # @note This method doesn't require private_token to be set.
     def session(email, password)
       post("/session", :body => {:email => email, :password => password})
     end

data/lib/gitlab/configuration.rb

@@ -8,7 +8,7 @@ module Gitlab
     DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}".freeze
 
     # @private
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     # Sets all configuration options to their default values
     # when this module is extended.
@@ -30,8 +30,8 @@ module Gitlab
 
     # Resets all configuration options to the defaults.
     def reset
-      self.endpoint       = nil
-      self.private_token  = nil
+      self.endpoint       = ENV['GITLAB_API_ENDPOINT']
+      self.private_token  = ENV['GITLAB_API_PRIVATE_TOKEN']
       self.sudo           = nil
       self.user_agent     = DEFAULT_USER_AGENT
     end

data/lib/gitlab/objectified_hash.rb

@@ -1,8 +1,9 @@
 module Gitlab
   # Converts hashes to the objects.
   class ObjectifiedHash
-    # Creates a new ObjectifiedHash.
+    # Creates a new ObjectifiedHash object.
     def initialize(hash)
+      @hash = hash
       @data = hash.inject({}) do |data, (key,value)|
         value = ObjectifiedHash.new(value) if value.is_a? Hash
         data[key.to_s] = value
@@ -10,7 +11,12 @@ module Gitlab
       end
     end
 
-    # Delegate to ObjectifiedHash
+    def to_hash
+      @hash
+    end
+    alias_method :to_h, :to_hash
+
+    # Delegate to ObjectifiedHash.
     def method_missing(key)
       @data.key?(key.to_s) ? @data[key.to_s] : nil
     end

data/lib/gitlab/request.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'json'
 
 module Gitlab
   # @private
@@ -8,6 +9,8 @@ module Gitlab
     headers 'Accept' => 'application/json'
     parser Proc.new { |body, _| parse(body) }
 
+    attr_accessor :private_token
+
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
       body = decode(body)
@@ -31,19 +34,23 @@ module Gitlab
     end
 
     def get(path, options={})
+      set_private_token_header(options)
       validate self.class.get(path, options)
     end
 
     def post(path, options={})
+      set_private_token_header(options, path)
       validate self.class.post(path, options)
     end
 
     def put(path, options={})
+      set_private_token_header(options)
       validate self.class.put(path, options)
     end
 
-    def delete(path)
-      validate self.class.delete(path)
+    def delete(path, options={})
+      set_private_token_header(options)
+      validate self.class.delete(path, options)
     end
 
     # Checks the response code for common errors.
@@ -65,18 +72,27 @@ module Gitlab
     end
 
     # Sets a base_uri and default_params for requests.
-    # @raise [Error::MissingCredentials] if endpoint or private_token not set.
+    # @raise [Error::MissingCredentials] if endpoint not set.
     def set_request_defaults(endpoint, private_token, sudo=nil)
       raise Error::MissingCredentials.new("Please set an endpoint to API") unless endpoint
-      raise Error::MissingCredentials.new("Please set a private_token for user") unless private_token
+      @private_token = private_token
 
       self.class.base_uri endpoint
-      self.class.default_params :private_token => private_token, :sudo => sudo
+      self.class.default_params :sudo => sudo
       self.class.default_params.delete(:sudo) if sudo.nil?
     end
 
     private
 
+    # Sets a PRIVATE-TOKEN header for requests.
+    # @raise [Error::MissingCredentials] if private_token not set.
+    def set_private_token_header(options, path=nil)
+      unless path == '/session'
+        raise Error::MissingCredentials.new("Please set a private_token for user") unless @private_token
+        options[:headers] = {'PRIVATE-TOKEN' => @private_token}
+      end
+    end
+
     def error_message(response)
       "Server responded with code #{response.code}, message: #{response.parsed_response.message}. " \
       "Request URI: #{response.request.base_uri}#{response.request.path}"

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/fixtures/branch.json

@@ -0,0 +1 @@
+{"name":"api","commit":{"id":"f7dd067490fe57505f7226c3b54d3127d2f7fd46","parents":[{"id":"949b1df930bedace1dbd755aaa4a82e8c451a616"}],"tree":"f8c4b21c036339f92fcc5482aa28a41250553b27","message":"API: expose issues project id","author":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"committer":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"authored_date":"2012-07-25T04:22:21-07:00","committed_date":"2012-07-25T04:22:21-07:00"},"protected": true}

data/spec/fixtures/create_branch.json

@@ -0,0 +1 @@
+{"name":"api","commit":{ "id":"f7dd067490fe57505f7226c3b54d3127d2f7fd46","message":"API: expose issues project id","parent_ids":["949b1df930bedace1dbd755aaa4a82e8c451a616"],"authored_date":"2012-07-25T04:22:21-07:00","author_name":"Nihad Abbasov","author_email":"narkoz.2008@gmail.com","committed_date":"2012-07-25T04:22:21-07:00","committer_name":"Nihad Abbasov","committer_email":"narkoz.2008@gmail.com"},"protected": false}

data/spec/fixtures/merge_request_comments.json

@@ -0,0 +1 @@
+[{"note":"this is the 1st comment on the 2merge merge request","author":{"id":11,"username":"admin","email":"admin@example.com","name":"A User","state":"active","created_at":"2014-03-06T08:17:35.000Z"}},{"note":"another discussion point on the 2merge request","author":{"id":12,"username":"admin","email":"admin@example.com","name":"A User","state":"active","created_at":"2014-03-06T08:17:35.000Z"}}]

data/spec/fixtures/project_commit.json

@@ -0,0 +1,13 @@
+{
+    "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
+    "short_id": "6104942438c",
+    "title": "Sanitize for network graph",
+    "author_name": "randx",
+    "author_email": "dmitriy.zaporozhets@gmail.com",
+    "created_at": "2012-09-20T09:06:12+03:00",
+    "committed_date": "2012-09-20T09:06:12+03:00",
+    "authored_date": "2012-09-20T09:06:12+03:00",
+    "parent_ids": [
+        "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
+    ]
+}

data/spec/fixtures/project_commit_diff.json

@@ -0,0 +1,10 @@
+{
+    "diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
+    "new_path": "doc/update/5.4-to-6.0.md",
+    "old_path": "doc/update/5.4-to-6.0.md",
+    "a_mode": null,
+    "b_mode": "100644",
+    "new_file": false,
+    "renamed_file": false,
+    "deleted_file": false
+}

data/spec/fixtures/{project_branch.json → protect_branch.json}

@@ -1 +1 @@
-{"name":"api","commit":{"id":"f7dd067490fe57505f7226c3b54d3127d2f7fd46","parents":[{"id":"949b1df930bedace1dbd755aaa4a82e8c451a616"}],"tree":"f8c4b21c036339f92fcc5482aa28a41250553b27","message":"API: expose issues project id","author":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"committer":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"authored_date":"2012-07-25T04:22:21-07:00","committed_date":"2012-07-25T04:22:21-07:00"}}
+{"name":"api","commit":{"id":"f7dd067490fe57505f7226c3b54d3127d2f7fd46","parents":[{"id":"949b1df930bedace1dbd755aaa4a82e8c451a616"}],"tree":"f8c4b21c036339f92fcc5482aa28a41250553b27","message":"API: expose issues project id","author":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"committer":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"authored_date":"2012-07-25T04:22:21-07:00","committed_date":"2012-07-25T04:22:21-07:00"},"protected":true}

data/spec/fixtures/system_hook.json

@@ -0,0 +1 @@
+{"id": 3, "url": "http://example.com/hook", "created_at": "2013-10-02T10:15:31Z"}

data/spec/fixtures/system_hook_test.json

@@ -0,0 +1 @@
+{ "event_name": "project_create", "name": "Ruby", "path": "ruby", "project_id": 1, "owner_name": "Someone", "owner_email": "example@gitlabhq.com" }

data/spec/fixtures/system_hooks.json

@@ -0,0 +1 @@
+[{"id": 3, "url": "http://example.com/hook", "created_at": "2013-10-02T10:15:31Z"}]

data/spec/fixtures/unprotect_branch.json

@@ -0,0 +1 @@
+{"name":"api","commit":{"id":"f7dd067490fe57505f7226c3b54d3127d2f7fd46","parents":[{"id":"949b1df930bedace1dbd755aaa4a82e8c451a616"}],"tree":"f8c4b21c036339f92fcc5482aa28a41250553b27","message":"API: expose issues project id","author":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"committer":{"name":"Nihad Abbasov","email":"narkoz.2008@gmail.com"},"authored_date":"2012-07-25T04:22:21-07:00","committed_date":"2012-07-25T04:22:21-07:00"},"protected":false}

data/spec/gitlab/cli_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Gitlab::CLI do
+  describe ".run" do
+    context "when command is version" do
+      it "should show gem version" do
+        output = capture_output { Gitlab::CLI.run('-v') }
+        expect(output).to eq("Gitlab Ruby Gem #{Gitlab::VERSION}\n")
+      end
+    end
+
+    context "when command is info" do
+      it "should show environment info" do
+        output = capture_output { Gitlab::CLI.run('info') }
+        expect(output).to include("Gitlab endpoint is")
+        expect(output).to include("Gitlab private token is")
+        expect(output).to include("Ruby Version is")
+        expect(output).to include("Gitlab Ruby Gem")
+      end
+    end
+
+    context "when command is help" do
+      it "should show available actions" do
+        output = capture_output { Gitlab::CLI.run('help') }
+        expect(output).to include('Available commands')
+        expect(output).to include('MergeRequests')
+        expect(output).to include('team_members')
+      end
+    end
+
+    context "when command is user" do
+      before do
+        stub_get("/user", "user")
+        @output = capture_output { Gitlab::CLI.run('user') }
+      end
+
+      it "should show executed command" do
+        expect(@output).to include('Gitlab.user')
+      end
+
+      it "should show user data" do
+        expect(@output).to include('name')
+        expect(@output).to include('John Smith')
+      end
+    end
+  end
+
+  describe ".start" do
+    context "when command with excluded fields" do
+      before do
+        stub_get("/user", "user")
+        args = ['user', '--except=id,email,name']
+        @output = capture_output { Gitlab::CLI.start(args) }
+      end
+
+      it "should show user data with excluded fields" do
+        expect(@output).to_not include('John Smith')
+        expect(@output).to include('bio')
+        expect(@output).to include('created_at')
+      end
+    end
+
+    context "when command with required fields" do
+      before do
+        stub_get("/user", "user")
+        args = ['user', '--only=id,email,name']
+        @output = capture_output { Gitlab::CLI.start(args) }
+      end
+
+      it "should show user data with required fields" do
+        expect(@output).to include('id')
+        expect(@output).to include('name')
+        expect(@output).to include('email')
+        expect(@output).to include('John Smith')
+        expect(@output).to_not include('bio')
+        expect(@output).to_not include('created_at')
+      end
+    end
+  end
+end