gitlab 2.2.0 → 3.0.0

data/lib/gitlab/client/projects.rb

@@ -20,7 +20,7 @@ class Gitlab::Client
     #   Gitlab.project(3)
     #   Gitlab.project('gitlab')
     #
-    # @param  [Integer, String] id The ID or code name of a project.
+    # @param  [Integer, String] id The ID or name of a project.
     # @return [Gitlab::ObjectifiedHash]
     def project(id)
       get("/projects/#{id}")
@@ -35,17 +35,19 @@ class Gitlab::Client
     #
     # @param  [String] name The name of a project.
     # @param  [Hash] options A customizable set of options.
-    # @option options [String] :code The code name of a project.
-    # @option options [String] :path The path of a project.
     # @option options [String] :description The description of a project.
     # @option options [String] :default_branch The default branch of a project.
     # @option options [Boolean] :wiki_enabled The wiki integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :wall_enabled The wall functionality for a project (0 = false, 1 = true).
     # @option options [Boolean] :issues_enabled The issues integration for a project (0 = false, 1 = true).
+    # @option options [Boolean] :snippets_enabled The snippets integration for a project (0 = false, 1 = true).
     # @option options [Boolean] :merge_requests_enabled The merge requests functionality for a project (0 = false, 1 = true).
+    # @option options [Boolean] :public The setting for making a project public (0 = false, 1 = true).
+    # @option options [Integer] :user_id The user/owner id of a project.
     # @return [Gitlab::ObjectifiedHash] Information about created project.
     def create_project(name, options={})
-      post("/projects", :body => {:name => name}.merge(options))
+      url = options[:user_id] ? "/projects/user/#{options[:user_id]}" : "/projects"
+      post(url, :body => {:name => name}.merge(options))
     end
 
     # Gets a list of project team members.
@@ -54,8 +56,9 @@ class Gitlab::Client
     #   Gitlab.team_members(42)
     #   Gitlab.team_members('gitlab')
     #
-    # @param  [Integer, String] project The ID or code name 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] :query The search query.
     # @option options [Integer] :page The page number.
     # @option options [Integer] :per_page The number of results per page.
     # @return [Array<Gitlab::ObjectifiedHash>]
@@ -68,9 +71,9 @@ class Gitlab::Client
     # @example
     #   Gitlab.team_member('gitlab', 2)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a project team member.
-    # @return [Array<Gitlab::ObjectifiedHash>]
+    # @return [Gitlab::ObjectifiedHash]
     def team_member(project, id)
       get("/projects/#{project}/members/#{id}")
     end
@@ -80,10 +83,11 @@ class Gitlab::Client
     # @example
     #   Gitlab.add_team_member('gitlab', 2, 40)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
-    # @return [Array<Gitlab::ObjectifiedHash>] Information about added team member.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Gitlab::ObjectifiedHash] Information about added team member.
     def add_team_member(project, id, access_level)
       post("/projects/#{project}/members", :body => {:user_id => id, :access_level => access_level})
     end
@@ -93,9 +97,10 @@ class Gitlab::Client
     # @example
     #   Gitlab.edit_team_member('gitlab', 3, 20)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a user.
     # @param  [Integer] access_level The access level to project.
+    # @param  [Hash] options A customizable set of options.
     # @return [Array<Gitlab::ObjectifiedHash>] Information about updated team member.
     def edit_team_member(project, id, access_level)
       put("/projects/#{project}/members/#{id}", :body => {:access_level => access_level})
@@ -106,9 +111,10 @@ class Gitlab::Client
     # @example
     #   Gitlab.remove_team_member('gitlab', 2)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a user.
-    # @return [Array<Gitlab::ObjectifiedHash>] Information about removed team member.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Gitlab::ObjectifiedHash] Information about removed team member.
     def remove_team_member(project, id)
       delete("/projects/#{project}/members/#{id}")
     end
@@ -119,7 +125,7 @@ class Gitlab::Client
     #   Gitlab.project_hooks(42)
     #   Gitlab.project_hooks('gitlab')
     #
-    # @param  [Integer, String] project The ID or code name 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.
@@ -134,7 +140,7 @@ class Gitlab::Client
     #   Gitlab.project_hook(42, 5)
     #   Gitlab.project_hook('gitlab', 5)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of a hook.
     # @return [Gitlab::ObjectifiedHash]
     def project_hook(project, id)
@@ -146,7 +152,7 @@ class Gitlab::Client
     # @example
     #   Gitlab.add_project_hook(42, 'https://api.example.net/v1/webhooks/ci')
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] url The hook URL.
     # @return [Gitlab::ObjectifiedHash] Information about added hook.
     def add_project_hook(project, url)
@@ -158,7 +164,7 @@ class Gitlab::Client
     # @example
     #   Gitlab.edit_project_hook(42, 1, 'https://api.example.net/v1/webhooks/ci')
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [Integer] id The ID of the hook.
     # @param  [String] url The hook URL.
     # @return [Gitlab::ObjectifiedHash] Information about updated hook.
@@ -171,11 +177,86 @@ class Gitlab::Client
     # @example
     #   Gitlab.delete_project_hook('gitlab', 4)
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] id The ID of the hook.
     # @return [Gitlab::ObjectifiedHash] Information about deleted hook.
     def delete_project_hook(project, id)
       delete("/projects/#{project}/hooks/#{id}")
     end
+
+    # Mark this project as forked from the other
+    #
+    # @example
+    #   Gitlab.make_forked(42, 24)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the project it is forked from.
+    # @return [Gitlab::ObjectifiedHash] Information about the forked project.
+    def make_forked_from(project, id)
+      post("/projects/#{project}/fork/#{id}")
+    end
+
+    # Remove a forked_from relationship for a project.
+    #
+    # @example
+    #  Gitlab.remove_forked(42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] project The ID of the project it is forked from
+    # @return [Gitlab::ObjectifiedHash] Information about the forked project.
+    def remove_forked(project)
+      delete("/projects/#{project}/fork")
+    end
+
+    # Gets a project deploy keys.
+    #
+    # @example
+    #   Gitlab.deploy_keys(42)
+    #
+    # @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.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def deploy_keys(project, options={})
+      get("/projects/#{project}/keys", :query => options)
+    end
+
+    # Gets a single project deploy key.
+    #
+    # @example
+    #   Gitlab.deploy_key(42, 1)
+    #
+    # @param  [Integer, String] project The ID of a project.
+    # @param  [Integer] id The ID of a deploy key.
+    # @return [Gitlab::ObjectifiedHash]
+    def deploy_key(project, id)
+      get("/projects/#{project}/keys/#{id}")
+    end
+
+    # Creates a new deploy key.
+    #
+    # @example
+    #   Gitlab.create_deploy_key(42, 'My Key', 'Key contents')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of a deploy key.
+    # @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)
+    end
+
+    # Deletes a deploy key from project.
+    #
+    # @example
+    #   Gitlab.delete_deploy_key(42, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a deploy key.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted deploy key.
+    def delete_deploy_key(project, id)
+      delete("/projects/#{project}/keys/#{id}")
+    end
   end
 end

data/lib/gitlab/client/repositories.rb

@@ -5,9 +5,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.tags(42)
-    #   Gitlab.repo_tags('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.
@@ -21,9 +20,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.branches(42)
-    #   Gitlab.repo_branches('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.
@@ -39,7 +37,7 @@ class Gitlab::Client
     #   Gitlab.branch(3, 'api')
     #   Gitlab.repo_branch(5, 'master')
     #
-    # @param  [Integer, String] project The ID or code name of a project.
+    # @param  [Integer] project The ID of a project.
     # @param  [String] branch The name of the branch.
     # @return [Gitlab::ObjectifiedHash]
     def branch(project, branch)
@@ -53,7 +51,7 @@ class Gitlab::Client
     #   Gitlab.commits('viking')
     #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
     #
-    # @param  [String] project The name of a project.
+    # @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.

data/lib/gitlab/client/snippets.rb

@@ -5,9 +5,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.snippets(42)
-    #   Gitlab.snippets('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,9 +19,8 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.snippet(2, 14)
-    #   Gitlab.snippet('gitlab', 34)
     #
-    # @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 snippet.
     # @return [Gitlab::ObjectifiedHash]
     def snippet(project, id)
@@ -32,26 +30,26 @@ class Gitlab::Client
     # Creates a new snippet.
     #
     # @example
-    #   Gitlab.create_snippet('gitlab',
-    #     {:title => 'REST', :file_name => 'api.rb', :code => 'some code'})
+    #   Gitlab.create_snippet(42, {:title => 'REST', :file_name => 'api.rb', :code => 'some code'})
     #
-    # @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 [String] :title The title of a snippet.
-    # @option options [String] :file_name The name of a snippet file.
-    # @option options [String] :code The content of a snippet.
-    # @option options [String] :lifetime The expiration date of a snippet.
+    # @option options [String] :title (required) The title of a snippet.
+    # @option options [String] :file_name (required) The name of a snippet file.
+    # @option options [String] :code (required) The content of a snippet.
+    # @option options [String] :lifetime (optional) The expiration date of a snippet.
     # @return [Gitlab::ObjectifiedHash] Information about created snippet.
     def create_snippet(project, options={})
+      check_attributes!(options, [:title, :file_name, :code])
       post("/projects/#{project}/snippets", :body => options)
     end
 
     # Updates a snippet.
     #
     # @example
-    #   Gitlab.edit_snippet('gitlab', 34, :file_name => 'README.txt')
+    #   Gitlab.edit_snippet(42, 34, :file_name => 'README.txt')
     #
-    # @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 snippet.
     # @param  [Hash] options A customizable set of options.
     # @option options [String] :title The title of a snippet.
@@ -67,13 +65,22 @@ class Gitlab::Client
     #
     # @example
     #   Gitlab.delete_snippet(2, 14)
-    #   Gitlab.delete_snippet('gitlab', 34)
     #
-    # @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 snippet.
     # @return [Gitlab::ObjectifiedHash] Information about deleted snippet.
     def delete_snippet(project, id)
       delete("/projects/#{project}/snippets/#{id}")
     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/configuration.rb

@@ -2,7 +2,7 @@ module Gitlab
   # Defines constants and methods related to configuration.
   module Configuration
     # An array of valid keys in the options hash when configuring a Gitlab::API.
-    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent].freeze
+    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent, :sudo].freeze
 
     # The user agent that will be sent to the API endpoint if none is set.
     DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}".freeze
@@ -32,6 +32,7 @@ module Gitlab
     def reset
       self.endpoint       = nil
       self.private_token  = nil
+      self.sudo           = nil
       self.user_agent     = DEFAULT_USER_AGENT
     end
   end

data/lib/gitlab/error.rb

@@ -3,6 +3,9 @@ module Gitlab
     # Custom error class for rescuing from all Gitlab errors.
     class Error < StandardError; end
 
+    # Raise when attributes are missing.
+    class MissingAttributes < Error; end
+
     # Raised when API endpoint credentials not configured.
     class MissingCredentials < Error; end
 
@@ -21,6 +24,12 @@ module Gitlab
     # Raised when API endpoint returns the HTTP status code 404.
     class NotFound < Error; end
 
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
     # Raised when API endpoint returns the HTTP status code 500.
     class InternalServerError < Error; end
 

data/lib/gitlab/request.rb

@@ -4,9 +4,9 @@ module Gitlab
   # @private
   class Request
     include HTTParty
-    format  :json
+    format :json
     headers 'Accept' => 'application/json'
-    parser  Proc.new {|body| parse(body)}
+    parser Proc.new { |body, _| parse(body) }
 
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
@@ -15,7 +15,7 @@ module Gitlab
       if body.is_a? Hash
         ObjectifiedHash.new body
       elsif body.is_a? Array
-        body.collect! {|e| ObjectifiedHash.new(e)}
+        body.collect! { |e| ObjectifiedHash.new(e) }
       else
         raise Error::Parsing.new "Couldn't parse a response body"
       end
@@ -24,12 +24,8 @@ module Gitlab
     # Decodes a JSON response into Ruby object.
     def self.decode(response)
       begin
-        if MultiJson.respond_to?(:adapter)
-          MultiJson.load response
-        else
-          MultiJson.decode response
-        end
-      rescue MultiJson::DecodeError
+        JSON.load response
+      rescue JSON::ParserError
         raise Error::Parsing.new "The response is not a valid JSON"
       end
     end
@@ -53,28 +49,37 @@ module Gitlab
     # Checks the response code for common errors.
     # Returns parsed response for successful requests.
     def validate(response)
-      message = "Server responsed with code #{response.code}"
       case response.code
-      when 400; raise Error::BadRequest.new message
-      when 401; raise Error::Unauthorized.new message
-      when 403; raise Error::Forbidden.new message
-      when 404; raise Error::NotFound.new message
-      when 500; raise Error::InternalServerError.new message
-      when 502; raise Error::BadGateway.new message
-      when 503; raise Error::ServiceUnavailable.new message
+        when 400; raise Error::BadRequest.new error_message(response)
+        when 401; raise Error::Unauthorized.new error_message(response)
+        when 403; raise Error::Forbidden.new error_message(response)
+        when 404; raise Error::NotFound.new error_message(response)
+        when 405; raise Error::MethodNotAllowed.new error_message(response)
+        when 409; raise Error::Conflict.new error_message(response)
+        when 500; raise Error::InternalServerError.new error_message(response)
+        when 502; raise Error::BadGateway.new error_message(response)
+        when 503; raise Error::ServiceUnavailable.new error_message(response)
       end
 
       response.parsed_response
     end
 
-    # Sets a base_uri and private_token parameter for requests.
+    # Sets a base_uri and default_params for requests.
     # @raise [Error::MissingCredentials] if endpoint or private_token not set.
-    def set_request_defaults(endpoint, private_token)
+    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
 
       self.class.base_uri endpoint
-      self.class.default_params :private_token => private_token
+      self.class.default_params :private_token => private_token, :sudo => sudo
+      self.class.default_params.delete(:sudo) if sudo.nil?
+    end
+
+    private
+
+    def error_message(response)
+      "Server responded with code #{response.code}, message: #{response.parsed_response.message}. " \
+      "Request URI: #{response.request.base_uri}#{response.request.path}"
     end
   end
 end