gitlab-faraday 5.1.0

data/lib/gitlab/client/tags.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+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, 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.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def tags(project, options = {})
+      get("/projects/#{url_encode project}/repository/tags", query: options)
+    end
+    alias 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, String] project The ID or name 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/#{url_encode project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, release_description: description })
+    end
+    alias repo_create_tag create_tag
+
+    # Gets information about a repository tag.
+    #
+    # @example
+    #   Gitlab.tag(3, 'api')
+    #   Gitlab.repo_tag(5, 'master')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] tag The name of the tag.
+    # @return [Gitlab::ObjectifiedHash]
+    def tag(project, tag)
+      get("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
+    end
+    alias 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, String] project The ID or name of a project.
+    # @param  [String] tag The name of the tag to delete
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_tag(project, tag)
+      delete("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
+    end
+    alias 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, String] project The ID or name 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/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
+    end
+    alias 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, String] project The ID or name 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/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
+    end
+    alias repo_update_release update_release
+  end
+end

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