labclient 0.1.0

data/lib/labclient/members/projects/show.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMembers < Common
+    doc 'Project' do
+      title 'Show'
+      desc 'Gets a member of a group or project [Project ID, User ID]'
+      example 'client.members.projects.show(264, 14)'
+      result '#<Member name: Annie, access: developer>'
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.member(14)
+      DOC
+    end
+
+    doc 'Project' do
+      subtitle 'Show All'
+      desc 'Gets a member of a group or project, including members inherited through ancestor groups [Project ID, User ID]'
+      example 'client.members.project.show(264, 14)'
+      result '#<Member name: Annie, access: developer>'
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.member_all(14)
+      DOC
+    end
+
+    # Default to False
+    def show(project_id, user_id, all = nil)
+      all = '/all' if all # Reset and Use
+
+      user_id = format_id(user_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/members#{all}/#{user_id}", Member)
+    end
+
+    # Default to True
+    def show_all(project_id, user_id)
+      show(project_id, user_id, true)
+    end
+  end
+end

data/lib/labclient/members/projects/update.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMembers < Common
+    doc 'Project' do
+      title 'Update'
+      desc 'Updates a member of a group or project. [Project ID, User ID, Hash]'
+      example 'client.members.projects.update(264, 14, access_level: :reporter)'
+      result '=> #<Member name: Tristana, access: reporter>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | access_level | integer | yes | A valid access level |
+        | expires_at | string | no | A date string in the format YEAR-MONTH-DAY |
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.member_update(14, access_level: :developer)
+      DOC
+    end
+
+    def update(project_id, user_id, query)
+      query_format_time(query, :expires_at)
+      query_access_level(query, :access_level)
+      project_id = format_id(project_id)
+      user_id = format_id(user_id)
+
+      client.request(:put, "projects/#{project_id}/members/#{user_id}", Member, query)
+    end
+  end
+end

data/lib/labclient/merge_requests/accept.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Accept'
+      desc 'Merge changes submitted with MR. [project id, merge request iid]'
+
+      markdown <<~DOC
+        - <small>if merge request is unable to be accepted (ie: Work in Progress, Closed, Pipeline Pending Completion, or Failed while requiring Success) - you'll get a `405` and the error message 'Method Not Allowed'</small>
+        - <small>If it has some conflicts and can not be merged - you'll get a `406` and the error message 'Branch cannot be merged'</small>
+        - <small>If the `sha` parameter is passed and does not match the HEAD of the source - you'll get a `409` and the error message 'SHA </small>does not match HEAD of source branch'
+        - <small>If you don't have permissions to accept this merge request - you'll get a `401`</small>
+      DOC
+
+      example 'client.merge_requests.accept(343, 3)'
+
+      result <<~DOC
+        => #<MergeRequest id: 3, title: Add new file>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Accept through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.accept
+      DOC
+    end
+
+    # Accept
+    def accept(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/merge", MergeRequest)
+    end
+  end
+end

data/lib/labclient/merge_requests/cancel_auto_merge.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Cancel Auto Merge'
+      desc 'Cancel Automatic Merge When Pipeline Succeeds [project id, merge request iid]'
+      markdown <<~DOC
+        - If you don't have permissions to accept this merge request - you'll get a `401`
+
+        - If the merge request is already merged or closed - you get `405` and error message 'Method Not Allowed'
+
+        - In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a `406` error.
+      DOC
+
+      example 'client.merge_requests.cancel_auto_merge(343, 3)'
+
+      result <<~DOC
+        => #<MergeRequest id: 3, title: Add new file>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Cancel through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.cancel_auto_merge
+      DOC
+    end
+
+    def cancel_auto_merge(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_id}/cancel_merge_when_pipeline_succeeds", MergeRequest)
+    end
+  end
+end

data/lib/labclient/merge_requests/change.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Inspect Helper, 'Changes' result for MR
+  class Changes < Klass
+    include ClassHelpers
+    # extend Docs
+
+    def inspect
+      "#<Changes MR: #{id}, title: #{title}>"
+    end
+
+    # User Fields
+    user_attrs %i[author assignee merged_by closed_by]
+
+    # DateTime Fields
+    date_time_attrs %i[
+      closed_at created_at first_deployed_to_production_at
+      latest_build_finished_at latest_build_started_at merged_at updated_at
+    ]
+
+    def assignees
+      @table[:assignees].map { |x| User.new(x, response, client) } if has? :assignees
+    end
+  end
+end

data/lib/labclient/merge_requests/changes.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Changes'
+      desc 'Shows information about the merge request including its files and changes. [project id, mr iid]'
+      example 'client.merge_requests.changes(333,1)'
+      result <<~DOC
+        => #<Changes MR: 1, title: Update README.md>
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Show through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333,1)'
+        mr.changes
+      DOC
+
+      result <<~DOC
+        => #<Changes MR: 1, title: Update README.md>
+      DOC
+    end
+
+    # Show Specific
+    def changes(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/changes", Changes)
+    end
+  end
+end

data/lib/labclient/merge_requests/closes_issues.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Closes Issues'
+      desc 'Get all the issues that would be closed by merging the provided merge request. [project id, mr iid]'
+      example 'client.merge_requests.closes_issues(343, 1)'
+      result <<~DOC
+        => => [#<Issue id: 1, title: Problem!, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.closes_issues.show(343,7)
+        mr.participants
+      DOC
+      result <<~DOC
+        mr = client.merge_requests.show(343,1)
+        => #<MergeRequest id: 1, title: Update README.md>
+        mr.closes_issues
+        => [#<Issue id: 1, title: Problem!, state: opened>]
+      DOC
+    end
+
+    def closes_issues(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/closes_issues", Issue)
+    end
+  end
+end

data/lib/labclient/merge_requests/commits.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Commits'
+      desc 'Get a list of merge request commits. [project id, mr iid]'
+      example 'client.merge_requests.commits(333,1)'
+      result <<~DOC
+        => [#<Commit title: Update README.md, sha: 50c90734>, #<Commit title: Add new file, sha: 6534a685>]
+      DOC
+    end
+
+    # Show Specific
+    def commits(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/commits", Commit)
+    end
+  end
+end

data/lib/labclient/merge_requests/create.rb

@@ -0,0 +1,51 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Create' do
+      desc 'Creates a new merge request'
+
+      example <<~DOC
+        client.merge_requests.create(343, {
+          title: 'New MR!',
+          source_branch: 'sweet-release',
+          target_branch: :master
+        })
+      DOC
+
+      result <<~DOC
+        => #<MergeRequest id: 2, title: New MR!>
+      DOC
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute                  | Type           | Required | Description                                                                     |
+        | ---------                  | ----           | -------- | -----------                                                                     |
+        | id                         | integer/string | yes      | The ID or owned by the authenticated user |
+        | source_branch              | string         | yes      | The source branch                                                               |
+        | target_branch              | string         | yes      | The target branch                                                               |
+        | title                      | string         | yes      | Title of MR                                                                     |
+        | assignee_id                | integer        | no       | Assignee user ID                                                                |
+        | assignee_ids               | integer array  | no       | The ID of the user(s) to assign the MR to. Set to 0 or provide an empty value to unassign all assignees.  |
+        | description                | string         | no       | Description of MR. Limited to 1,048,576 characters. |
+        | target_project_id          | integer        | no       | The target project (numeric id)                                                 |
+        | labels                     | string         | no       | Labels for MR as a comma-separated list                                         |
+        | milestone_id               | integer        | no       | The global ID of a milestone                                                           |
+        | remove_source_branch       | boolean        | no       | Flag indicating if a merge request should remove the source branch when merging |
+        | allow_collaboration        | boolean        | no       | Allow commits from members who can merge to the target branch                   |
+        | allow_maintainer_to_push   | boolean        | no       | Deprecated, see allow_collaboration                                             |
+        | squash                     | boolean        | no       | Squash commits into a single commit when merging                                |
+
+
+      DOC
+    end
+
+    # Create
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/merge_requests", MergeRequest, query)
+    end
+  end
+end

data/lib/labclient/merge_requests/delete.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Delete' do
+      desc 'Only for admins and project owners. Deletes the merge request in question. [project id, merge request iid]'
+
+      example 'client.merge_requests.delete(343, 2)'
+
+      result <<~DOC
+        => nil
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Delete through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.delete
+      DOC
+    end
+
+    # Delete
+    def delete(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:delete, "projects/#{project_id}/merge_requests/#{merge_request_id}")
+    end
+  end
+end

data/lib/labclient/merge_requests/diff.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class MergeRequestDiff < Klass
+    include ClassHelpers
+    # extend Docs
+
+    def inspect
+      "#<MergeRequestDiff id: #{id}, MR: #{merge_request_id}, state: #{state}>"
+    end
+
+    def details
+      project_id = collect_project_id
+
+      update_self client.merge_requests.diff_versions(project_id, merge_request_id, id)
+    end
+
+    # DateTime Fields
+    date_time_attrs %i[created_at]
+
+    help do
+      @group_name = 'Merge Requests'
+      subtitle 'Diff'
+      desc 'Details is only needed if accessing a diff via the list. Diff loaded via `details` produces the same result'
+      option 'details', 'Requests all Diff details and will reload.'
+    end
+  end
+end

data/lib/labclient/merge_requests/diff_versions.rb

@@ -0,0 +1,70 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Diff' do
+      title 'Versions'
+      desc 'Get a list of merge request diff versions. [project id, mr iid]'
+      example 'client.merge_requests.diff_versions(333,1)'
+      result <<~DOC
+        => [#<MergeRequestDiff id: 3, MR: 1, state: collected>, #<MergeRequestDiff id: 2, MR: 1, state: collected>, ..]
+      DOC
+    end
+
+    doc 'Diff' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,1)
+        mr.diff_versions
+      DOC
+
+      result <<~DOC
+        mr = client.merge_requests.show(343,1)
+        => #<MergeRequest id: 1, title: Update README.md, state: opened>
+        mr.diff_versions
+        => [#<MergeRequestDiff id: 3, MR: 1, state: collected>, #<MergeRequestDiff id: 2, MR: 1, state: collected>, ..]
+      DOC
+    end
+
+    doc 'Diff' do
+      title 'Details'
+      example 'client.merge_requests.diff_versions(333,1, 3)'
+      result <<~DOC
+        => #<MergeRequestDiff id: 3, MR: 1, state: collected>
+      DOC
+    end
+
+    doc 'Diff' do
+      desc 'Details through MergeRequestDiff'
+      example <<~DOC
+        diff = client.merge_requests.diff_versions(343,1).first
+        diff.details
+      DOC
+
+      result <<~DOC
+        mr = client.merge_requests.show(343,1)
+        => #<MergeRequest id: 1, title: Update README.md, state: opened>
+        mr.diff_versions
+        => [#<MergeRequestDiff id: 3, MR: 1, state: collected>, #<MergeRequestDiff id: 2, MR: 1, state: collected>, ..]
+        diff = mr.diff_versions.first
+        => #<DiffMergeRequestDiff id: 3, MR: 1, state: collected>
+        # Commits and Diffs available with details
+        diff.details.keys - mr.diff_versions.first.keys
+        => [:commits, :diffs]
+      DOC
+    end
+
+    # Show Specific
+    def diff_versions(project_id, mr_id, diff_id = nil)
+      project_id = format_id(project_id)
+      mr_id = format_id(mr_id)
+      diff_id = format_id(diff_id)
+
+      if diff_id
+        client.request(:get, "projects/#{project_id}/merge_requests/#{mr_id}/versions/#{diff_id}", MergeRequestDiff)
+      else
+        client.request(:get, "projects/#{project_id}/merge_requests/#{mr_id}/versions", MergeRequestDiff)
+      end
+    end
+  end
+end

data/lib/labclient/merge_requests/list.rb

@@ -0,0 +1,105 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'List' do
+      desc 'Get all merge requests the authenticated user has access to. By default it returns only merge requests created by the current user. To get all merge requests, use parameter scope=all.'
+      example 'client.merge_requests.list'
+      result <<~DOC
+        => [#<MergeRequest id: 37, title: Add new file>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'List only opened'
+      example 'client.merge_requests.list(state: :opened)'
+      result <<~DOC
+        => [#<MergeRequest id: 32, title: Just Opened>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by date'
+      example 'client.merge_requests.list(created_after: 10.day.ago)'
+      result <<~DOC
+        => [#<MergeRequest id: 37, title: Add new file>, #<MergeRequest id: 36, title: Update README.md>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Parameters'
+      markdown <<~DOC
+        | Attribute           | Type           | Required | Description                                                                                                            |
+        | ------------------- | --------       | -------- | ---------------------------------------------------------------------------------------------------------------------- |
+        | state             | string         | no       | Return all merge requests or just those that are opened, closed, locked, or merged                             |
+        | order_by          | string         | no       | Return requests ordered by created_at or updated_at fields. Default is created_at                                |
+        | sort              | string         | no       | Return requests sorted in asc or desc order. Default is desc                                                     |
+        | milestone         | string         | no       | Return merge requests for a specific milestone. None returns merge requests with no milestone. Any returns merge requests that have an assigned milestone. |
+        | view              | string         | no       | If simple, returns the iid, URL, title, description, and basic state of merge request                              |
+        | labels            | string         | no       | Return merge requests matching a comma separated list of labels. None lists all merge requests with no labels. Any lists all merge requests with at least one label. No+Label (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. |
+        | with_labels_details | Boolean        | no         | If true, response will return more details for each label in labels field: :name, :color, :description, :description_html, :text_color. Default is false. Introduced in GitLab 12.7 |
+        | created_after     | datetime       | no       | Return merge requests created on or after the given time                                                               |
+        | created_before    | datetime       | no       | Return merge requests created on or before the given time                                                              |
+        | updated_after     | datetime       | no       | Return merge requests updated on or after the given time                                                               |
+        | updated_before    | datetime       | no       | Return merge requests updated on or before the given time                                                              |
+        | scope             | string         | no       | Return merge requests for the given scope: created_by_me, assigned_to_me or all. Defaults to created_by_me<br> For versions before 11.0, use the now deprecated created-by-me or assigned-to-me scopes instead. |
+        | author_id         | integer        | no       | Returns merge requests created by the given user id. Combine with scope=all or scope=assigned_to_me              |
+        | assignee_id       | integer        | no       | Returns merge requests assigned to the given user id. None returns unassigned merge requests. Any returns merge requests with an assignee. |
+        | approver_ids **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given ids as individual approvers. None returns merge requests without approvers. Any returns merge requests with an approver. |
+        | my_reaction_emoji | string         | no       | Return merge requests reacted by the authenticated user by the given emoji. None returns issues not given a reaction. Any returns issues given at least one reaction. Introduced in GitLab 10.0 |
+        | source_branch     | string         | no       | Return merge requests with the given source branch                                                                     |
+        | target_branch     | string         | no       | Return merge requests with the given target branch                                                                     |
+        | search            | string         | no       | Search merge requests against their title and description                                                          |
+        | in                | string         | no       | Modify the scope of the search attribute. title, description, or a string joining them with comma. Default is title,description |
+        | wip               | string         | no       | Filter merge requests against their wip status. yes to return *only* WIP merge requests, no to return *non* WIP merge requests |
+      DOC
+    end
+
+    doc 'List' do
+      title 'Project'
+      desc 'List project merge requests [Project ID, Hash]'
+      example 'client.merge_requests.list(16, created_after: 10.day.ago)'
+      result <<~DOC
+        => [#<MergeRequest id: 37, title: Add new file>, #<MergeRequest id: 36, title: Update README.md>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      title 'Group'
+      desc 'List group merge requests [Group ID, Hash]'
+      example 'client.merge_requests.list_group(5, created_after: 10.day.ago)'
+      result <<~DOC
+        => [#<MergeRequest id: 37, title: Add new file>, #<MergeRequest id: 36, title: Update README.md>, ...]
+      DOC
+    end
+
+    # List
+    def list(query = {})
+      %i[created_after created_before updated_after updated_before].each do |field|
+        query[field] = query[field].to_time.iso8601 if format_time?(query[field])
+      end
+
+      client.request(:get, 'merge_requests', MergeRequest, query)
+    end
+
+    # Project
+    def list_project(project_id, query = {})
+      project_id = format_id(project_id)
+      %i[created_after created_before updated_after updated_before].each do |field|
+        query[field] = query[field].to_time.iso8601 if format_time?(query[field])
+      end
+
+      client.request(:get, "projects/#{project_id}/merge_requests", MergeRequest, query)
+    end
+
+    # Group
+    def list_group(group_id, query = {})
+      group_id = format_id(group_id)
+      %i[created_after created_before updated_after updated_before].each do |field|
+        query[field] = query[field].to_time.iso8601 if format_time?(query[field])
+      end
+
+      client.request(:get, "groups/#{group_id}/merge_requests", MergeRequest, query)
+    end
+  end
+end

data/lib/labclient/merge_requests/merge_ref.rb

@@ -0,0 +1,48 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Merge Ref'
+      markdown <<~DOC
+        - Merge the changes between the merge request source and target branches into `refs/merge-requests/:iid/merge` ref, of the target project repository, if possible. This ref will have the state the target branch would have if a regular merge action was taken.
+
+        - This is not a regular merge action given it doesn't change the merge request target branch state in any manner.
+
+        - This ref (`refs/merge-requests/:iid/merge`) isn't necessarily overwritten when submitting
+        requests to this API, though it'll make sure the ref has the latest possible state.
+
+        - If the merge request has conflicts, is empty or already merged, you'll get a `400` and a descriptive error message.
+
+        - It returns the HEAD commit of `refs/merge-requests/:iid/merge` in the response body in case of `200`.
+
+        - [Official Docs](https://docs.gitlab.com/ee/api/merge_requests.html#merge-to-default-merge-ref-path)
+
+        ---
+      DOC
+
+      example <<~DOC
+        client.merge_requests.merge_ref(343, 2)
+      DOC
+
+      result <<~DOC
+        => {:commit_id=>"f9b62f6aaaabe2f0bd7563701670fcd74d694c37"}
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.merge_ref
+      DOC
+    end
+
+    def merge_ref(project_id, merge_request_id)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/merge_ref")
+    end
+  end
+end