gitlab-akerl 4.0.0

data/lib/gitlab/client/builds.rb

@@ -0,0 +1,106 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://docs.gitlab.com/ce/api/builds.html
+  module Builds
+    # Gets a list of project builds.
+    #
+    # @example
+    #   Gitlab.builds(5)
+    #   Gitlab.builds(5, { per_page: 10, page:  2 })
+    #
+    # @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.
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def builds(project, options={})
+      get("/projects/#{project}/builds", query: options)
+    end
+
+    # Gets a single build.
+    #
+    # @example
+    #   Gitlab.build(5, 36)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash]
+    def build(project, id)
+      get("/projects/#{project}/builds/#{id}")
+    end
+
+    # Gets build artifacts.
+    #
+    # @example
+    #   Gitlab.build_artifacts(1, 8)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::FileResponse]
+    def build_artifacts(project, id)
+      get("/projects/#{project}/builds/#{id}/artifacts",
+           format: nil,
+           headers: { Accept: 'application/octet-stream' },
+           parser: proc { |body, _|
+            if body.encoding == Encoding::ASCII_8BIT # binary response
+              ::Gitlab::FileResponse.new StringIO.new(body, 'rb+')
+            else # error with json response
+              ::Gitlab::Request.parse(body)
+            end
+          })
+    end
+
+    # Gets a list of builds for specific commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_builds(5, 'asdf')
+    #   Gitlab.commit_builds(5, 'asdf', { per_page: 10, page: 2 })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The SHA checksum of a commit.
+    # @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>] The list of builds.
+    def commit_builds(project, sha, options={})
+      get("/projects/#{project}/repository/commits/#{sha}/builds", query: options)
+    end
+
+    # Cancels a build.
+    #
+    # @example
+    #   Gitlab.build_cancel(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The builds changes.
+    def build_cancel(project, id)
+      post("/projects/#{project}/builds/#{id}/cancel")
+    end
+
+    # Retry a build.
+    #
+    # @example
+    #   Gitlab.build_retry(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Array<Gitlab::ObjectifiedHash>] The builds changes.
+    def build_retry(project, id)
+      post("/projects/#{project}/builds/#{id}/retry")
+    end
+
+    # Erase a single build of a project (remove build artifacts and a build trace)
+    #
+    # @example
+    #   Gitlab.build_erase(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a build.
+    # @return [Gitlab::ObjectifiedHash] The build's changes.
+    def build_erase(project, id)
+      post("/projects/#{project}/builds/#{id}/erase")
+    end
+  end
+end

data/lib/gitlab/client/commits.rb

@@ -0,0 +1,121 @@
+class Gitlab::Client
+  # Defines methods related to repository commits.
+  # @see https://docs.gitlab.com/ce/api/commits.html
+  module Commits
+    # Gets a list of project commits.
+    #
+    # @example
+    #   Gitlab.commits('viking')
+    #   Gitlab.repo_commits('gitlab', { ref_name: 'api' })
+    #
+    # @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.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commits(project, options={})
+      get("/projects/#{project}/repository/commits", query: options)
+    end
+    alias_method :repo_commits, :commits
+
+    # Gets a specific commit identified by the commit hash or name of a branch or tag.
+    #
+    # @example
+    #   Gitlab.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @return [Gitlab::ObjectifiedHash]
+    def commit(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}")
+    end
+    alias_method :repo_commit, :commit
+
+    # Get the diff of a commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The name of a repository branch or tag or if not given the default branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def commit_diff(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}/diff")
+    end
+    alias_method :repo_commit_diff, :commit_diff
+
+    # Gets a list of comments for a commit.
+    #
+    # @example
+    #   Gitlab.commit_comments(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] sha The commit hash or name of a repository branch or tag.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commit_comments(project, commit, options={})
+      get("/projects/#{project}/repository/commits/#{commit}/comments", query: options)
+    end
+    alias_method :repo_commit_comments, :commit_comments
+
+    # Creates a new comment for a commit.
+    #
+    # @example
+    #   Gitlab.create_commit_comment(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b', 'Nice work on this commit!')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag.
+    # @param  [String] note The text of a comment.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :path The file path.
+    # @option options [Integer] :line The line number.
+    # @option options [String] :line_type The line type (new or old).
+    # @return [Gitlab::ObjectifiedHash] Information about created comment.
+    def create_commit_comment(project, commit, note, options={})
+      post("/projects/#{project}/repository/commits/#{commit}/comments", body: options.merge(note: note))
+    end
+    alias_method :repo_create_commit_comment, :create_commit_comment
+
+    # Get the status of a commit
+    #
+    # @example
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins' })
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', { name: 'jenkins', all: true })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref Filter by ref name, it can be branch or tag
+    # @option options [String] :stage Filter by stage
+    # @option options [String] :name Filter by status name, eg. jenkins
+    # @option options [Boolean] :all The flag to return all statuses, not only latest ones
+    def commit_status(id, sha, options={})
+      get("/projects/#{id}/repository/commits/#{sha}/statuses", query: options)
+    end
+    alias_method :repo_commit_status, :commit_status
+
+    # Adds or updates a status of a commit.
+    #
+    # @example
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'success')
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'failed', { name: 'jenkins' })
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'canceled', { name: 'jenkins', target_url: 'http://example.com/builds/1' })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash
+    # @param  [String] state of the status. Can be: pending, running, success, failed, canceled
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref The ref (branch or tag) to which the status refers
+    # @option options [String] :name Filter by status name, eg. jenkins
+    # @option options [String] :target_url The target URL to associate with this status
+    def update_commit_status(id, sha, state, options={})
+      post("/projects/#{id}/statuses/#{sha}", query: options.merge(state: state))
+    end
+    alias_method :repo_update_commit_status, :update_commit_status
+  end
+end

data/lib/gitlab/client/groups.rb

@@ -0,0 +1,144 @@
+class Gitlab::Client
+  # Defines methods related to groups.
+  # @see https://docs.gitlab.com/ce/api/groups.html
+  module Groups
+    # Gets a list of groups.
+    #
+    # @example
+    #   Gitlab.groups
+    #   Gitlab.groups({ per_page: 40, page: 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.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def groups(options={})
+      get("/groups", query: options)
+    end
+
+    # Gets a single group.
+    #
+    # @example
+    #   Gitlab.group(42)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @return [Gitlab::ObjectifiedHash]
+    def group(id)
+      get("/groups/#{id}")
+    end
+
+    # Creates a new group.
+    #
+    # @example
+    #   Gitlab.create_group('new-group', 'group-path')
+    #   Gitlab.create_group('gitlab', 'gitlab-path', { description: 'New Gitlab project' })
+    #
+    # @param  [String] name The name of a group.
+    # @param  [String] path The path of a group.
+    # @return [Gitlab::ObjectifiedHash] Information about created group.
+    def create_group(name, path, options={})
+      body = { name: name, path: path }.merge(options)
+      post("/groups", body: body)
+    end
+
+    # Delete's a group.
+    #
+    # @example
+    #   Gitlab.delete_group(42)
+    # @param  [Integer] id The ID of a group
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted group.
+    def delete_group(id)
+      delete("/groups/#{id}")
+    end
+
+    # Get a list of group members.
+    #
+    # @example
+    #   Gitlab.group_members(1)
+    #   Gitlab.group_members(1, { per_page: 40 })
+    #
+    # @param  [Integer] id The ID of a group.
+    # @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 group_members(id, options={})
+      get("/groups/#{id}/members", query: options)
+    end
+
+    # Adds a user to group.
+    #
+    # @example
+    #   Gitlab.add_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id to add a member to.
+    # @param  [Integer] user_id The user id of the user to add to the team.
+    # @param  [Integer] access_level Project access level.
+    # @return [Gitlab::ObjectifiedHash] Information about added team member.
+    def add_group_member(team_id, user_id, access_level)
+      post("/groups/#{team_id}/members", body: { user_id: user_id, access_level: access_level })
+    end
+
+    # Edit a user of a group.
+    #
+    # @example
+    #   Gitlab.edit_group_member(1, 2, 40)
+    #
+    # @param  [Integer] team_id The group id of member to edit.
+    # @param  [Integer] user_id The user id of the user to edit.
+    # @param  [Integer] access_level Project access level.
+    # @return [Gitlab::ObjectifiedHash] Information about edited team member.
+    def edit_group_member(team_id, user_id, access_level)
+      put("/groups/#{team_id}/members/#{user_id}", body: { access_level: access_level })
+    end
+
+    # Removes user from user group.
+    #
+    # @example
+    #   Gitlab.remove_group_member(1, 2)
+    #
+    # @param  [Integer] team_id The group ID.
+    # @param  [Integer] user_id The ID of a user.
+    # @return [Gitlab::ObjectifiedHash] Information about removed team member.
+    def remove_group_member(team_id, user_id)
+      delete("/groups/#{team_id}/members/#{user_id}")
+    end
+
+    # Transfers a project to a group
+    #
+    # @example
+    #   Gitlab.transfer_project_to_group(3, 50)
+    #
+    # @param  [Integer] id The ID of a group.
+    # @param  [Integer] project_id The ID of a project.
+    def transfer_project_to_group(id, project_id)
+      body = { id: id, project_id: project_id }
+      post("/groups/#{id}/projects/#{project_id}", body: body)
+    end
+
+    # Search for groups by name
+    #
+    # @example
+    #   Gitlab.group_search('gitlab')
+    #
+    # @param  [String] search A string to search for in group names and paths.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :per_page Number of projects to return per page
+    # @option options [String] :page The page to retrieve
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def group_search(search, options={})
+      options[:search] = search
+      get("/groups", query: options)
+    end
+
+    # Get a list of projects under a group
+    # @example
+    #   Gitlab.group_projects(1)
+    #
+    # @param [Integer] id The ID of a group
+    # @return [Array<Gitlab::ObjectifiedHash>] List of projects under a group
+    def group_projects(id, options={})
+      get("/groups/#{id}/projects", query: options)
+    end
+  end
+end

data/lib/gitlab/client/issues.rb

@@ -0,0 +1,113 @@
+class Gitlab::Client
+  # Defines methods related to issues.
+  # @see https://docs.gitlab.com/ce/api/issues.html
+  module Issues
+    # Gets a list of user's issues.
+    # Will return a list of project's issues if project ID passed.
+    #
+    # @example
+    #   Gitlab.issues
+    #   Gitlab.issues(5)
+    #   Gitlab.issues({ per_page: 40 })
+    #
+    # @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 issues(project=nil, options={})
+      if project.to_i.zero?
+        get("/issues", query: options)
+      else
+        get("/projects/#{project}/issues", query: options)
+      end
+    end
+
+    # Gets a single issue.
+    #
+    # @example
+    #   Gitlab.issue(5, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash]
+    def issue(project, id)
+      get("/projects/#{project}/issues/#{id}")
+    end
+
+    # Creates a new issue.
+    #
+    # @example
+    #   Gitlab.create_issue(5, 'New issue')
+    #   Gitlab.create_issue(5, 'New issue', { description: 'This is a new issue', assignee_id: 42 })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] title The title of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @option options [String] :labels Comma-separated label names for an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about created issue.
+    def create_issue(project, title, options={})
+      body = { title: title }.merge(options)
+      post("/projects/#{project}/issues", body: body)
+    end
+
+    # Updates an issue.
+    #
+    # @example
+    #   Gitlab.edit_issue(6, 1, { title: 'Updated title' })
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :title The title of an issue.
+    # @option options [String] :description The description of an issue.
+    # @option options [Integer] :assignee_id The ID of a user to assign issue.
+    # @option options [Integer] :milestone_id The ID of a milestone to assign issue.
+    # @option options [String] :labels Comma-separated label names for an issue.
+    # @option options [String] :state_event The state event of an issue ('close' or 'reopen').
+    # @return [Gitlab::ObjectifiedHash] Information about updated issue.
+    def edit_issue(project, id, options={})
+      put("/projects/#{project}/issues/#{id}", body: options)
+    end
+
+    # Closes an issue.
+    #
+    # @example
+    #   Gitlab.close_issue(3, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about closed issue.
+    def close_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", body: { state_event: 'close' })
+    end
+
+    # Reopens an issue.
+    #
+    # @example
+    #   Gitlab.reopen_issue(3, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about reopened issue.
+    def reopen_issue(project, id)
+      put("/projects/#{project}/issues/#{id}", body: { state_event: 'reopen' })
+    end
+
+    # Deletes  an issue.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_issue(3, 42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted issue.
+    def delete_issue(project, id)
+      delete("/projects/#{project}/issues/#{id}")
+    end
+  end
+end