gitlab 3.6.1 → 3.7.0

data/lib/gitlab/client/services.rb

@@ -0,0 +1,48 @@
+class Gitlab::Client
+  module Services
+    # Create/Edit service
+    # Full service params documentation: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/services.md
+    #
+    # @example
+    #   Gitlab.change_service(42, :redmine, { new_issue_url: 'https://example.com/projects/test_project/issues/new',
+    #                                         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  [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)
+    end
+
+    # Delete service
+    #
+    # @example
+    #   Gitlab.delete_service(42, :redmine)
+    #
+    # @param  [Integer] project The ID 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)}")
+    end
+
+    # Get service
+    #
+    # @example
+    #   Gitlab.service(42, :redmine)
+    #
+    # @param  [Integer] project The ID 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)}")
+    end
+
+    private
+    def correct_service_name(service)
+      service.to_s.gsub('_', '-')
+    end
+  end
+end

data/lib/gitlab/client/snippets.rb

@@ -31,7 +31,7 @@ class Gitlab::Client
     # Creates a new snippet.
     #
     # @example
-    #   Gitlab.create_snippet(42, {:title => 'REST', :file_name => 'api.rb', :code => 'some code'})
+    #   Gitlab.create_snippet(42, { title: 'REST', file_name: 'api.rb', code: 'some code' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Hash] options A customizable set of options.
@@ -47,7 +47,7 @@ class Gitlab::Client
     # Updates a snippet.
     #
     # @example
-    #   Gitlab.edit_snippet(42, 34, :file_name => 'README.txt')
+    #   Gitlab.edit_snippet(42, 34, { file_name: 'README.txt' })
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a snippet.

data/lib/gitlab/client/tags.rb

@@ -0,0 +1,96 @@
+class Gitlab::Client
+  # Defines methods related to tags.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/tags.md
+  module Tags
+    # Gets a list of project repository tags.
+    #
+    # @example
+    #   Gitlab.tags(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 tags(project, options={})
+      get("/projects/#{project}/repository/tags", query: options)
+    end
+    alias_method :repo_tags, :tags
+
+    # Creates a new project repository tag.
+    #
+    # @example
+    #   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  [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 })
+    end
+    alias_method :repo_create_tag, :create_tag
+
+    # Gets information about a repository tag.
+    #
+    # @example
+    #   Gitlab.tag(3, 'api')
+    #   Gitlab.repo_tag(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] tag The name of the tag.
+    # @return [Gitlab::ObjectifiedHash]
+    def tag(project, tag)
+      get("/projects/#{project}/repository/tags/#{tag}")
+    end
+    alias_method :repo_tag, :tag
+
+    # Deletes a repository tag.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.delete_tag(3, 'api')
+    #   Gitlab.repo_delete_tag(5, 'master')
+    #
+    # @param  [Integer] project The ID 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}")
+    end
+    alias_method :repo_delete_tag, :delete_tag
+
+    # Adds release notes to an existing repository tag.  Requires Gitlab >= 8.2.0
+    #
+    # @example
+    #   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  [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 })
+    end
+    alias_method :repo_create_release, :create_release
+
+    # Updates the release notes of a given release.  Requires Gitlab >= 8.2.0
+    #
+    # @example
+    #   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  [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 })
+    end
+    alias_method :repo_update_release, :update_release
+
+  end
+end

data/lib/gitlab/client/users.rb

@@ -33,7 +33,7 @@ class Gitlab::Client
     # Requires authentication from an admin account.
     #
     # @example
-    #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', :name => 'Joe Smith')
+    #   Gitlab.create_user('joe@foo.org', 'secret', 'joe', { name: 'Joe Smith' })
     #   or
     #   Gitlab.create_user('joe@foo.org', 'secret')
     #
@@ -61,7 +61,7 @@ class Gitlab::Client
     # Updates a user.
     #
     # @example
-    #   Gitlab.edit_user(15, :email => 'joe.smith@foo.org', :projects_limit => 20)
+    #   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.
@@ -169,5 +169,75 @@ class Gitlab::Client
     def delete_ssh_key(id)
       delete("/user/keys/#{id}")
     end
+
+    # Gets user emails.
+    # Will return emails an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.emails
+    #   Gitlab.emails(2)
+    #
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def emails(user_id=nil)
+      url = user_id.to_i.zero? ? "/user/emails" : "/users/#{user_id}/emails"
+      get(url)
+    end
+
+    # Get a single email.
+    #
+    # @example
+    #   Gitlab.email(3)
+    #
+    # @param  [Integer] id The ID of a email.
+    # @return [Gitlab::ObjectifiedHash]
+    def email(id)
+      get("/user/emails/#{id}")
+    end
+
+    # Creates a new email
+    # Will create a new email an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.add_email('email@example.com')
+    #   Gitlab.add_email('email@example.com', 2)
+    #
+    # @param  [String] email Email address
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_email(email, user_id=nil)
+      url = user_id.to_i.zero? ? "/user/emails" : "/users/#{user_id}/emails"
+      post(url, body: {email: email})
+    end
+
+    # Delete email
+    # Will delete a email an authorized user if no user ID passed.
+    #
+    # @example
+    #   Gitlab.delete_email(2)
+    #   Gitlab.delete_email(3, 2)
+    #
+    # @param  [Integer] id Email address ID
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Boolean]
+    def delete_email(id, user_id=nil)
+      url = user_id.to_i.zero? ? "/user/emails/#{id}" : "/users/#{user_id}/emails/#{id}"
+      delete(url)
+    end
+
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.user_search('gitlab')
+    #
+    # @param  [String] search A string to search for in user names and paths.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of user to return per page
+    # @option options [String] :page The page to retrieve
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_search(search, options={})
+      options[:search] = search
+      get("/users", query: options)
+    end
   end
 end

data/lib/gitlab/error.rb

@@ -9,34 +9,77 @@ module Gitlab
     # Raised when impossible to parse response body.
     class Parsing < Error; end
 
+    # Custom error class for rescuing from HTTP response errors.
+    class ResponseError < Error
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      # Status code returned in the http response.
+      #
+      # @return [Integer]
+      def response_status
+        @response.code
+      end
+
+      private
+
+      # Human friendly message.
+      #
+      # @return [String]
+      def build_error_message
+        parsed_response = @response.parsed_response
+        message = parsed_response.message || parsed_response.error
+
+        "Server responded with code #{@response.code}, message: " \
+        "#{handle_message(message)}. " \
+        "Request URI: #{@response.request.base_uri}#{@response.request.path}"
+      end
+
+      # Handle error response message in case of nested hashes
+      def handle_message(message)
+        case message
+        when Gitlab::ObjectifiedHash
+          message.to_h.sort.map do |key, val|
+            "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
+          end.join(', ')
+        when Array
+          message.join(' ')
+        else
+          message
+        end
+      end
+    end
+
     # Raised when API endpoint returns the HTTP status code 400.
-    class BadRequest < Error; end
+    class BadRequest < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 401.
-    class Unauthorized < Error; end
+    class Unauthorized < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 403.
-    class Forbidden < Error; end
+    class Forbidden < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 404.
-    class NotFound < Error; end
+    class NotFound < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 405.
-    class MethodNotAllowed < Error; end
+    class MethodNotAllowed < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 409.
-    class Conflict < Error; end
+    class Conflict < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 422.
-    class Unprocessable < Error; end
+    class Unprocessable < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 500.
-    class InternalServerError < Error; end
+    class InternalServerError < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 502.
-    class BadGateway < Error; end
+    class BadGateway < ResponseError; end
 
     # Raised when API endpoint returns the HTTP status code 503.
-    class ServiceUnavailable < Error; end
+    class ServiceUnavailable < ResponseError; end
   end
 end

data/lib/gitlab/file_response.rb

@@ -0,0 +1,45 @@
+module Gitlab
+  # Wrapper class of file response.
+  class FileResponse
+    HEADER_CONTENT_DISPOSITION = 'Content-Disposition'.freeze
+
+    attr_reader :filename
+
+    def initialize(file)
+      @file = file
+    end
+
+    # @return [bool] Always false
+    def empty?
+      false
+    end
+
+    # @return [Hash] A hash consisting of filename and io object
+    def to_hash
+      { filename: @filename, data: @file }
+    end
+    alias_method :to_h, :to_hash
+
+    # @return [String] Formatted string with the class name, object id and filename.
+    def inspect
+      "#<#{self.class}:#{object_id} {filename: #{filename.inspect}}>"
+    end
+
+    def method_missing(name, *args, &block)
+      if @file.respond_to?(name)
+        @file.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @file.respond_to?(method_name, include_private)
+    end
+
+    # Parse filename from the 'Content Disposition' header.
+    def parse_headers!(headers)
+      @filename = headers[HEADER_CONTENT_DISPOSITION].split("filename=")[1]
+    end
+  end
+end

data/lib/gitlab/help.rb

@@ -88,6 +88,7 @@ module Gitlab::Help
       output_str.gsub!(/\s(@)/, "\n@")
       output_str.gsub!(/(\])\n(\:)/, '\1 \2')
       output_str.gsub!(/(\:.*)(\n)(.*\.)/, '\1 \3')
+      output_str.gsub!(/\{(.+)\}/, '"{\1}"')
       
     end
   end # class << self

data/lib/gitlab/objectified_hash.rb

@@ -27,7 +27,7 @@ module Gitlab
       @data.key?(key.to_s) ? @data[key.to_s] : nil
     end
 
-    def respond_to?(method_name, include_private=false)
+    def respond_to_missing?(method_name, include_private = false)
       @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
     end
   end

data/lib/gitlab/paginated_response.rb

@@ -23,8 +23,8 @@ module Gitlab
       end
     end
 
-    def respond_to?(method, include_all=false)
-      super || @array.respond_to?(method, include_all)
+    def respond_to_missing?(method_name, include_private = false)
+      super || @array.respond_to?(method_name, include_private)
     end
 
     def parse_headers!(headers)

data/lib/gitlab/request.rb

@@ -64,19 +64,21 @@ module Gitlab
     # Checks the response code for common errors.
     # Returns parsed response for successful requests.
     def validate(response)
-      case response.code
-      when 400 then fail Error::BadRequest.new error_message(response)
-      when 401 then fail Error::Unauthorized.new error_message(response)
-      when 403 then fail Error::Forbidden.new error_message(response)
-      when 404 then fail Error::NotFound.new error_message(response)
-      when 405 then fail Error::MethodNotAllowed.new error_message(response)
-      when 409 then fail Error::Conflict.new error_message(response)
-      when 422 then fail Error::Unprocessable.new error_message(response)
-      when 500 then fail Error::InternalServerError.new error_message(response)
-      when 502 then fail Error::BadGateway.new error_message(response)
-      when 503 then fail Error::ServiceUnavailable.new error_message(response)
+      error_klass = case response.code
+      when 400 then Error::BadRequest
+      when 401 then Error::Unauthorized
+      when 403 then Error::Forbidden
+      when 404 then Error::NotFound
+      when 405 then Error::MethodNotAllowed
+      when 409 then Error::Conflict
+      when 422 then Error::Unprocessable
+      when 500 then Error::InternalServerError
+      when 502 then Error::BadGateway
+      when 503 then Error::ServiceUnavailable
       end
 
+      fail error_klass.new(response) if error_klass
+
       parsed = response.parsed_response
       parsed.client = self if parsed.respond_to?(:client=)
       parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
@@ -111,28 +113,5 @@ module Gitlab
     def set_httparty_config(options)
       options.merge!(httparty) if httparty
     end
-
-    def error_message(response)
-      parsed_response = response.parsed_response
-      message = parsed_response.message || parsed_response.error
-
-      "Server responded with code #{response.code}, message: " \
-      "#{handle_error(message)}. " \
-      "Request URI: #{response.request.base_uri}#{response.request.path}"
-    end
-
-    # Handle error response message in case of nested hashes
-    def handle_error(message)
-      case message
-      when Gitlab::ObjectifiedHash
-        message.to_h.sort.map do |key, val|
-          "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
-        end.join(', ')
-      when Array
-        message.join(' ')
-      else
-        message
-      end
-    end
   end
 end