fs-gitlab 4.18.1

data/lib/gitlab/client/templates.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to templates.
+  # @see https://docs.gitlab.com/ce/api/templates/dockerfiles.html
+  # @see https://docs.gitlab.com/ce/api/templates/gitignores.html
+  # @see https://docs.gitlab.com/ce/api/templates/gitlab_ci_ymls.html
+  # @see https://docs.gitlab.com/ce/api/templates/licenses.html
+  module Templates
+    # Get all Dockerfile templates.
+    #
+    # @example
+    #   Gitlab.dockerfile_templates
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def dockerfile_templates
+      get('/templates/dockerfiles')
+    end
+
+    # Get a single Dockerfile template.
+    #
+    # @example
+    #   Gitlab.dockerfile_template('Binary')
+    #
+    # @param  [String] key The key of the Dockerfile template
+    # @return [Gitlab::ObjectifiedHash]
+    def dockerfile_template(key)
+      get("/templates/dockerfiles/#{key}")
+    end
+
+    # Get all gitignore templates.
+    #
+    # @example
+    #   Gitlab.gitignore_templates
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def gitignore_templates
+      get('/templates/gitignores')
+    end
+
+    # Get a single gitignore template.
+    #
+    # @example
+    #   Gitlab.gitignore_template('Ruby')
+    #
+    # @param  [String] key The key of the gitignore template
+    # @return [Gitlab::ObjectifiedHash]
+    def gitignore_template(key)
+      get("/templates/gitignores/#{key}")
+    end
+
+    # Get all `gitlab_ci.yml` templates.
+    #
+    # @example
+    #   Gitlab.gitlab_ci_yml_templates
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def gitlab_ci_yml_templates
+      get('/templates/gitlab_ci_ymls')
+    end
+
+    # Get a single `gitlab_ci.yml` template.
+    #
+    # @example
+    #   Gitlab.gitlab_ci_yml_template('Ruby')
+    #
+    # @param  [String] key The key of the gitlab_ci_yml template
+    # @return [Gitlab::ObjectifiedHash]
+    def gitlab_ci_yml_template(key)
+      get("/templates/gitlab_ci_ymls/#{key}")
+    end
+
+    # Get all license templates.
+    #
+    # @example
+    #   Gitlab.license_templates
+    #   Gitlab.license_templates(popular: true)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] popular(optional) If passed, returns only popular licenses.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def license_templates(options = {})
+      get('/templates/licenses', query: options)
+    end
+
+    # Get a single license template. You can pass parameters to replace the license placeholder.
+    #
+    # @example
+    #   Gitlab.license_template('Ruby')
+    #
+    # @param  [String] key The key of the license template
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] project(optional) The copyrighted project name.
+    # @option options [String] fullname(optional) The full-name of the copyright holder
+    # @return [Gitlab::ObjectifiedHash]
+    def license_template(key, options = {})
+      get("/templates/licenses/#{key}", query: options)
+    end
+  end
+end

data/lib/gitlab/client/todos.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to todos
+  # @see https://docs.gitlab.com/ce/api/todos.html
+  module Todos
+    # Gets a list of todos.
+    #
+    # @example
+    #   Gitlab.todos
+    #   Gitlab.todos({ action: 'assigned' })
+    #   Gitlab.todos({ state: 'pending' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :action The action to be filtered. Can be `assigned`, `mentioned`, `build_failed`, `marked`, or `approval_required`.
+    # @option options [Integer] :author_id The ID of an author
+    # @option options [Integer] :project_id The ID of a project
+    # @option options [Integer] :state The state of the todo. Can be either `pending` or `done`
+    # @option options [Integer] :type The type of a todo. Can be either `Issue` or `MergeRequest`
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def todos(options = {})
+      get('/todos', query: options)
+    end
+
+    # Marks a single pending todo for the current user as done.
+    #
+    # @example
+    #   Gitlab.mark_todo_as_done(42)
+    #
+    # @param  [Integer] id The ID of the todo.
+    # @return [Gitlab::ObjectifiedHash]
+    def mark_todo_as_done(id)
+      post("/todos/#{id}/mark_as_done")
+    end
+
+    # Marks all todos for the current user as done
+    #
+    # @example
+    #   Gitlab.mark_all_todos_as_done
+    #
+    # @return [void] This API call returns an empty response body.
+    def mark_all_todos_as_done
+      post('/todos/mark_as_done')
+    end
+  end
+end

data/lib/gitlab/client/user_snippets.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to user snippets.
+  # @see https://docs.gitlab.com/ce/api/snippets.html
+  module UserSnippets
+    # Get a list of the snippets of the current user.
+    #
+    # @example
+    #   Gitlab.user_snippets
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] List of snippets of current user
+    def user_snippets
+      get('/snippets')
+    end
+
+    # Get a single snippet.
+    #
+    # @example
+    #   Gitlab.user_snippet(1)
+    #
+    # @param  [Integer] id ID of snippet to retrieve.
+    # @return [Gitlab::ObjectifiedHash] Information about the user snippet
+    def user_snippet(id)
+      get("/snippets/#{id}")
+    end
+
+    # Get raw contents of a single snippet.
+    #
+    # @example
+    #   Gitlab.user_snippet_raw(1)
+    #
+    # @param  [Integer] id ID of snippet to retrieve.
+    # @return [String] User snippet text
+    def user_snippet_raw(id)
+      get("/snippets/#{id}/raw",
+          format: nil,
+          headers: { Accept: 'text/plain' },
+          parser: ::Gitlab::Request::Parser)
+    end
+
+    # Create a new snippet.
+    #
+    # @example
+    #   Gitlab.create_user_snippet({ title: 'REST', file_name: 'api.rb', content: 'some code', description: 'Hello World snippet', visibility: 'public'})
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title (required) Title of a snippet.
+    # @option options [String] :file_name (required) Name of a snippet file.
+    # @option options [String] :content (required) Content of a snippet.
+    # @option options [String] :description (optional) Description of a snippet.
+    # @option options [String] :visibility (optional) visibility of a snippet.
+    # @return [Gitlab::ObjectifiedHash] Information about created snippet.
+    def create_user_snippet(options = {})
+      post('/snippets', body: options)
+    end
+
+    # Update an existing snippet.
+    #
+    # @example
+    #   Gitlab.edit_user_snippet(34, { file_name: 'README.txt' })
+    #   Gitlab.edit_user_snippet(34, { file_name: 'README.txt', title: 'New title' })
+    #
+    # @param  [Integer] id ID of snippet to update.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title (optional) Title of a snippet.
+    # @option options [String] :file_name (optional) Name of a snippet file.
+    # @option options [String] :content (optional) Content of a snippet.
+    # @option options [String] :description (optional) Description of a snippet.
+    # @option options [String] :visibility (optional) visibility of a snippet.
+    # @return [Gitlab::ObjectifiedHash] Information about updated snippet.
+    def edit_user_snippet(id, options = {})
+      put("/snippets/#{id}", body: options)
+    end
+
+    # Delete an existing snippet.
+    #
+    # @example
+    #   Gitlab.delete_user_snippet(14)
+    #
+    # @param  [Integer] id ID of snippet to delete.
+    # @return [void] This API call returns an empty response body.
+    def delete_user_snippet(id)
+      delete("/snippets/#{id}")
+    end
+
+    # List all public snippets.
+    #
+    # @example
+    #   Gitlab.public_snippets
+    #   Gitlab.public_snippets(per_page: 2, page: 1)
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page (optional) Number of snippets to return per page.
+    # @option options [String] :page (optional) Page to retrieve.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] List of all public snippets
+    def public_snippets(options = {})
+      get('/snippets/public', query: options)
+    end
+
+    # Get user agent details for a snippet.
+    #
+    # @example
+    #   Gitlab.snippet_user_agent_details(1)
+    #
+    # @param  [Integer] id ID of snippet to delete.
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>] Details of the user agent
+    def snippet_user_agent_details(id)
+      get("/snippets/#{id}/user_agent_detail")
+    end
+  end
+end

data/lib/gitlab/client/users.rb

@@ -0,0 +1,397 @@
+# frozen_string_literal: true
+
+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', 'joe')
+    #
+    # @param  [String] email(required) The email of a user.
+    # @param  [String] password(required) The password of a user.
+    # @param  [String] username(required) 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 = args.last.is_a?(Hash) ? args.pop : {}
+      raise ArgumentError, 'Missing required parameters' unless args[2]
+
+      body = { email: args[0], password: args[1], username: args[2], name: args[0] }
+      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)
+      post("/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)
+      post("/users/#{user_id}/unblock")
+    end
+
+    # Approves the specified user. Available only for admin.
+    #
+    # @example
+    #   Gitlab.approve_user(15)
+    #
+    # @param [Integer] user_id The Id of user
+    # @return [Boolean] success or not
+    def approve_user(user_id)
+      post("/users/#{user_id}/approve")
+    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 }, unauthenticated: true)
+    end
+
+    # Gets a list of user activities (for admin access only).
+    #
+    # @example
+    #   Gitlab.activities
+    #
+    # @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] :from The start date for paginated results.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def activities(options = {})
+      get('/user/activities', query: options)
+    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.
+    # @param  [Hash] options A customizable set of options.
+    # @option options  [Integer] :user_id id of the user to associate the key with
+    # @return [Gitlab::ObjectifiedHash] Information about created SSH key.
+    def create_ssh_key(title, key, options = {})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        post('/user/keys', body: { title: title, key: key })
+      else
+        post("/users/#{user_id}/keys", body: { title: title, key: key })
+      end
+    end
+
+    # Deletes an SSH key.
+    #
+    # @example
+    #   Gitlab.delete_ssh_key(1)
+    #
+    # @param  [Integer] id The ID of a user's SSH key.
+    # @param  [Hash] options A customizable set of options.
+    # @option options  [Integer] :user_id id of the user to associate the key with
+    # @return [Gitlab::ObjectifiedHash] Information about deleted SSH key.
+    def delete_ssh_key(id, options = {})
+      user_id = options.delete :user_id
+      if user_id.to_i.zero?
+        delete("/user/keys/#{id}")
+      else
+        delete("/users/#{user_id}/keys/#{id}")
+      end
+    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.
+    # @param  [Boolean] skip_confirmation     Skip confirmation and assume e-mail is verified
+    # @return [Gitlab::ObjectifiedHash]
+    def add_email(email, user_id = nil, skip_confirmation = nil)
+      url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
+      if skip_confirmation.nil?
+        post(url, body: { email: email })
+      else
+        post(url, body: { email: email, skip_confirmation: skip_confirmation })
+      end
+    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
+
+    # Gets user custom_attributes.
+    #
+    # @example
+    #   Gitlab.user_custom_attributes(2)
+    #
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_custom_attributes(user_id)
+      get("/users/#{user_id}/custom_attributes")
+    end
+
+    # Gets single user custom_attribute.
+    #
+    # @example
+    #   Gitlab.user_custom_attribute(key, 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_custom_attribute(key, user_id)
+      get("/users/#{user_id}/custom_attributes/#{key}")
+    end
+
+    # Creates a new custom_attribute
+    #
+    # @example
+    #   Gitlab.add_custom_attribute('some_new_key', 'some_new_value', 2)
+    #
+    # @param  [String] key The custom_attributes key
+    # @param  [String] value The custom_attributes value
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash]
+    def add_user_custom_attribute(key, value, user_id)
+      url = "/users/#{user_id}/custom_attributes/#{key}"
+      put(url, body: { value: value })
+    end
+
+    # Delete custom_attribute
+    # Will delete a custom_attribute
+    #
+    # @example
+    #   Gitlab.delete_user_custom_attribute('somekey', 2)
+    #
+    # @param  [String] key The custom_attribute key to delete
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Boolean]
+    def delete_user_custom_attribute(key, user_id)
+      delete("/users/#{user_id}/custom_attributes/#{key}")
+    end
+
+    # Get all impersonation tokens for a user
+    #
+    # @example
+    #   Gitlab.user_impersonation_tokens(1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [String] state Filter impersonation tokens by state {}
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def user_impersonation_tokens(user_id)
+      get("/users/#{user_id}/impersonation_tokens")
+    end
+
+    # Get impersonation token information
+    #
+    # @example
+    #   Gitlab.user_impersonation_token(1, 1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [Integer] impersonation_token_id ID of the impersonation token.
+    # @return [Gitlab::ObjectifiedHash]
+    def user_impersonation_token(user_id, impersonation_token_id)
+      get("/users/#{user_id}/impersonation_tokens/#{impersonation_token_id}")
+    end
+
+    # Create impersonation token
+    #
+    # @example
+    #   Gitlab.create_user_impersonation_token(2, "token", ["api", "read_user"])
+    #   Gitlab.create_user_impersonation_token(2, "token", ["api", "read_user"], "1970-01-01")
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [String] name Name for impersonation token.
+    # @param  [Array<String>] scopes Array of scopes for the impersonation token
+    # @param  [String] expires_at Date for impersonation token expiration in ISO format.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_user_impersonation_token(user_id, name, scopes, expires_at = nil)
+      body = { name: name, scopes: scopes }
+      body[:expires_at] = expires_at if expires_at
+      post("/users/#{user_id}/impersonation_tokens", body: body)
+    end
+
+    # Revoke an impersonation token
+    #
+    # @example
+    #   Gitlab.revoke_user_impersonation_token(1, 1)
+    #
+    # @param  [Integer] user_id The ID of the user.
+    # @param  [Integer] impersonation_token_id ID of the impersonation token.
+    # @return [Gitlab::ObjectifiedHash]
+    def revoke_user_impersonation_token(user_id, impersonation_token_id)
+      delete("/users/#{user_id}/impersonation_tokens/#{impersonation_token_id}")
+    end
+  end
+end

data/lib/gitlab/client/versions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Gitlab::Client
+  # Defines methods related to version
+  # @see https://docs.gitlab.com/ce/api/version.html
+  module Versions
+    # Returns server version.
+    # @see https://docs.gitlab.com/ce/api/version.html
+    #
+    # @example
+    #   Gitlab.version
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def version
+      get('/version')
+    end
+  end
+end