gitlab-akerl 4.0.0

data/lib/gitlab/client/tags.rb

@@ -0,0 +1,96 @@
+class Gitlab::Client
+  # Defines methods related to tags.
+  # @see https://docs.gitlab.com/ce/api/tags.html
+  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

@@ -0,0 +1,250 @@
+class Gitlab::Client
+  # Defines methods related to users.
+  # @see https://docs.gitlab.com/ce/api/users.html
+  # @see https://docs.gitlab.com/ce/api/session.html
+  module Users
+    # Gets a list of users.
+    #
+    # @example
+    #   Gitlab.users
+    #
+    # @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 users(options={})
+      get("/users", query: options)
+    end
+
+    # Gets information about a user.
+    # Will return information about an authorized user if no ID passed.
+    #
+    # @example
+    #   Gitlab.user
+    #   Gitlab.user(2)
+    #
+    # @param  [Integer] id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user(id=nil)
+      id.to_i.zero? ? get("/user") : get("/users/#{id}")
+    end
+
+    # 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.
+    # @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 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] :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
+
+    # 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
+    #   Gitlab.session('jack@example.com', 'secret12345')
+    #
+    # @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
+
+    # Gets a list of user's SSH keys.
+    #
+    # @example
+    #   Gitlab.ssh_keys
+    #   Gitlab.ssh_keys({ user_id: 2 })
+    #
+    # @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 [Integer] :user_id The ID of the user to retrieve the keys for.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def ssh_keys(options={})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        get("/user/keys", query: options)
+      else
+        get("/users/#{user_id}/keys", query: options)
+      end
+    end
+
+    # Gets information about SSH key.
+    #
+    # @example
+    #   Gitlab.ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @return [Gitlab::ObjectifiedHash]
+    def ssh_key(id)
+      get("/user/keys/#{id}")
+    end
+
+    # Creates a new SSH key.
+    #
+    # @example
+    #   Gitlab.create_ssh_key('key title', 'key body')
+    #
+    # @param  [String] title The title of an SSH key.
+    # @param  [String] key The SSH key body.
+    # @return [Gitlab::ObjectifiedHash] Information about created SSH key.
+    def create_ssh_key(title, key)
+      post("/user/keys", body: { title: title, key: key })
+    end
+
+    # Deletes an SSH key.
+    #
+    # @example
+    #   Gitlab.delete_ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted SSH key.
+    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/configuration.rb

@@ -0,0 +1,55 @@
+require 'gitlab/cli_helpers'
+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, :sudo, :httparty].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
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+    # @private
+    alias_method :auth_token=, :private_token=
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    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

@@ -0,0 +1,85 @@
+module Gitlab
+  module Error
+    # Custom error class for rescuing from all Gitlab errors.
+    class Error < StandardError; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # 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 < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < ResponseError; end
+  end
+end