labclient 0.1.0

data/lib/labclient/merge_requests/merge_request.rb

@@ -0,0 +1,211 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  # rubocop:disable Metrics/ClassLength
+  class MergeRequest < Klass
+    include ClassHelpers
+    # extend Docs
+
+    def inspect
+      "#<MergeRequest id: #{id}, title: #{title}, state: #{state}>"
+    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
+
+    def participants
+      client.merge_requests.participants(project_id, iid)
+    end
+
+    def changes
+      client.merge_requests.changes(project_id, iid)
+    end
+
+    def commits
+      client.merge_requests.commits(project_id, iid)
+    end
+
+    def pipelines
+      client.merge_requests.pipelines(project_id, iid)
+    end
+
+    def create_pipeline
+      client.merge_requests.create_pipeline(project_id, iid)
+    end
+
+    def update(query)
+      update_self client.merge_requests.update(project_id, iid, query)
+    end
+
+    def delete
+      client.merge_requests.delete(project_id, iid)
+    end
+
+    def accept
+      client.merge_requests.accept(project_id, iid)
+    end
+
+    def merge_ref
+      client.merge_requests.merge_ref(project_id, iid)
+    end
+
+    def cancel_auto_merge
+      client.merge_requests.cancel_auto_merge(project_id, iid)
+    end
+
+    def rebase(skip_ci = false)
+      client.merge_requests.rebase(project_id, iid, skip_ci)
+    end
+
+    def add_spent_time(duration)
+      client.merge_requests.add_spent_time(project_id, iid, duration)
+    end
+
+    def time_estimate(duration)
+      client.merge_requests.time_estimate(project_id, iid, duration)
+    end
+
+    def reset_time_estimate
+      client.merge_requests.reset_time_estimate(project_id, iid)
+    end
+
+    def reset_spent_time
+      client.merge_requests.reset_spent_time(project_id, iid)
+    end
+
+    def closes_issues
+      client.merge_requests.closes_issues(project_id, iid)
+    end
+
+    def subscribe
+      client.merge_requests.subscribe(project_id, iid)
+    end
+
+    def unsubscribe
+      client.merge_requests.unsubscribe(project_id, iid)
+    end
+
+    def notes
+      client.notes.merge_requests.list(project_id, iid)
+    end
+
+    def todo
+      client.merge_requests.todo(project_id, iid)
+    end
+
+    def time_stats
+      client.merge_requests.time_stats(project_id, iid)
+    end
+
+    def diff_versions
+      client.merge_requests.diff_versions(project_id, iid)
+    end
+
+    # Default to Source Project
+    def project
+      client.projects.show(source_project_id)
+    end
+
+    def source_project
+      client.projects.show(source_project_id)
+    end
+
+    def target_project
+      client.projects.show(target_project_id)
+    end
+
+    # Approvals
+    def approvals
+      client.approvals.merge_request.show(project_id, iid)
+    end
+
+    def approvals_update(approvals_required)
+      client.approvals.merge_request.update(project_id, iid, approvals_required)
+    end
+
+    def approvals_rules
+      client.approvals.merge_request.rules(project_id, iid)
+    end
+
+    def approvals_rule_create(query = {})
+      client.approvals.merge_request.create_rule(project_id, iid, query)
+    end
+
+    def approvals_rule_update(approval_rule_id, query = {})
+      client.approvals.merge_request.update_rule(project_id, iid, approval_rule_id, query)
+    end
+
+    def approvals_rule_delete(approval_rule_id)
+      client.approvals.merge_request.delete_rule(project_id, iid, approval_rule_id)
+    end
+
+    def approve(query = {})
+      client.approvals.merge_request.approve(project_id, iid, query)
+    end
+
+    def unapprove
+      client.approvals.merge_request.unapprove(project_id, iid)
+    end
+
+    # Resource Labels
+    def resource_labels
+      client.resource_labels.merge_requests.list(project_id, iid)
+    end
+
+    def resource_label(resource_event_id)
+      client.resource_labels.merge_requests.show(project_id, iid, resource_event_id)
+    end
+
+    help do
+      subtitle 'MergeRequest'
+      option 'accept', 'Merge changes submitted'
+      option 'add_time_spent', 'Adds spent time. Accepts Duration or Human Format. (1.hour or "1h")'
+      option 'changes', 'Show merge request changes'
+      option 'closes_issues', 'Show issues that this merge request will close'
+      option 'commits', 'List associated commits.'
+      option 'create_pipeline', 'Create new pipeline for this merge request.'
+      option 'delete', 'Delete this merge request.'
+      option 'merge_ref', 'Show Merge Ref'
+      option 'notes', 'List notes/comments.'
+      option 'participants', 'List participants in this merge request.'
+      option 'pipelines', 'List pipelines in this merge request.'
+      option 'reset_spent_time', 'Resets the spent time'
+      option 'reset_time_estimate', 'Resets the estimated time'
+      option 'subscribe', 'Subscribe to notifications'
+      option 'time_estimate', 'Sets an estimated time. Accepts Duration or Human Format. (1.hour or "1h")'
+      option 'time_stats', 'Get time tracking stats.'
+      option 'todo', 'Create todo'
+      option 'unsubscribe', 'Unsubscribe to notifications'
+      option 'update', 'Update merge request (accepts hash).'
+      option 'project', 'Return associated Project (default to source project).'
+      option 'source_project', 'MR Source Project'
+      option 'target_project', 'MR Target Project'
+
+      # Approvals
+      option 'approvals', 'Show Merge Request approval configuration'
+      option 'approvals_update', 'Change approval configuration [Integer]'
+      option 'approvals_rules', 'Show Merge Request approval rules'
+
+      option 'approvals_rule_create', 'Create Approval Rule [Hash]'
+      option 'approvals_rule_update', 'Updating existing Approval Rule [Rule ID, Hash]'
+      option 'approvals_rule_delete', 'Delete Approval Rule [Rule ID]'
+      option 'approve', 'Approve Merge Request [Hash]'
+      option 'unapprove', 'Unapprove Merge Request'
+
+      # Resource Labels
+      option 'resource_labels', 'List of all label events'
+      option 'resource_label', 'Show single label event [Resource Event ID]'
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/labclient/merge_requests/notes.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Notes'
+      desc 'Notes are handled via the Notes resource. Accessible via the object or notes'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.notes
+      DOC
+
+      result <<~DOC
+        => [#<Note id: 21, type: MergeRequest>, #<Note id: 20, type: MergeRequest>, .. ]
+      DOC
+    end
+  end
+end

data/lib/labclient/merge_requests/participants.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      title 'Participants'
+      desc 'Get a list of merge request participants. [project id, mr iid]'
+      example 'client.merge_requests.participants(333,1)'
+      result <<~DOC
+        => [#<User id: 1, username: braum>, #<User id: 52, username: anivia>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,1)
+        mr.participants
+      DOC
+      result <<~DOC
+        mr = client.merge_requests.show(343,1)
+        => #<MergeRequest id: 1, title: Update README.md>
+        mr.participants
+        => [#<User id: 1, username: root>]
+      DOC
+    end
+
+    # Show Specific
+    def participants(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}/participants", User)
+    end
+  end
+end

data/lib/labclient/merge_requests/pipelines.rb

@@ -0,0 +1,63 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Pipelines' do
+      title 'List'
+      desc 'Get a list of merge request pipelines. [project id, mr iid]'
+      example 'client.merge_requests.pipelines(343,1)'
+      result <<~DOC
+        => [#<Pipeline id: 4, ref: branch, status: success>]
+      DOC
+    end
+
+    doc 'Pipelines' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,1)
+        mr.pipelines
+      DOC
+
+      result <<~DOC
+        => [#<Pipeline id: 4, ref: branch, status: success>]
+      DOC
+    end
+
+    # Show Specific
+    def pipelines(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}/pipelines", Pipeline)
+    end
+
+    doc 'Pipelines' do
+      title 'Create'
+      desc 'Create a new pipeline for a merge request. Requires .gitlab-ci.yml to be configured with only: [merge_requests] to create jobs. [project id, mr iid]'
+      example 'client.merge_requests.create_pipeline(343, 1)'
+      result <<~DOC
+        => #<Pipeline id: 7, ref: refs/merge-requests/1/head, status: pending>
+      DOC
+    end
+
+    doc 'Pipelines' do
+      desc 'Create through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,1)
+        mr.create_pipeline
+      DOC
+
+      result <<~DOC
+        => #<Pipeline id: 8, ref: refs/merge-requests/1/head, status: pending>
+      DOC
+    end
+
+    # Create New Pipeline
+    def create_pipeline(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}/pipelines", Pipeline)
+    end
+  end
+end

data/lib/labclient/merge_requests/rebase.rb

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Rebase'
+      desc 'Rebase a merge request [project id, merge request iid, skip_ci (true/false)]'
+      markdown <<~DOC
+        - Automatically rebase the `source_branch` of the merge request against its `target_branch`.
+
+        - If you don't have permissions to push to the merge request's source branch you'll get a `403 Forbidden` response.
+      DOC
+
+      example 'client.merge_requests.rebase(343, 3)'
+
+      result <<~DOC
+        => {:rebase_in_progress=>true}
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Rebase skipping CI'
+
+      example 'client.merge_requests.rebase(343, 3, true)'
+      result <<~DOC
+        => {:rebase_in_progress=>true}
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Rebase through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.rebase
+      DOC
+    end
+
+    def rebase(project_id, merge_request_id, skip_ci = false)
+      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}/rebase", nil, skip_ci: skip_ci)
+    end
+  end
+end

data/lib/labclient/merge_requests/show.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Show' do
+      desc 'Shows information about a single merge request. [project id, mr iid]'
+      example 'client.merge_requests.show(333,1)'
+      result <<~DOC
+        => #<MergeRequest id: 37, title: Add new file>
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Parameters'
+      markdown <<~DOC
+        | Attribute                      | Description                                                         |
+        | ------------------------------ | ------------------------------------------------------------------- |
+        | render_html                    | If true response includes rendered HTML for title and description   |
+        | include_diverged_commits_count | If true response includes the commits behind the target branch      |
+        | include_rebase_in_progress     | If true response includes whether a rebase operation is in progress |
+      DOC
+    end
+
+    # Show Specific
+    def show(project_id, merge_request_id = nil, query = {})
+      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}", MergeRequest, query)
+    end
+  end
+end

data/lib/labclient/merge_requests/subscribe.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Subscribe'
+      desc 'Subscribes the authenticated user to a merge request to receive notification. [project id, merge request iid]'
+
+      example 'client.merge_requests.subscribe(343, 7)'
+
+      result <<~DOC
+        => #<MergeRequest id: 3, title: Add new file>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Subscribe through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.subscribe
+      DOC
+    end
+
+    def subscribe(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}/subscribe", MergeRequest)
+    end
+  end
+end

data/lib/labclient/merge_requests/time_stats.rb

@@ -0,0 +1,157 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Time Stats' do
+      title 'Show'
+      desc 'Get time tracking stats. [project id, mr iid]'
+      example 'client.merge_requests.time_stats(333, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333, 1)'
+        mr.time_stats
+      DOC
+    end
+
+    def time_stats(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}/time_stats")
+    end
+
+    doc 'Time Stats' do
+      title 'Add'
+      desc 'Adds spent time for this merge request. [project id, mr iid, duration]'
+      markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Duration Example'
+      example 'client.merge_requests.add_spent_time(333, 1, 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Human Format Example'
+      example 'client.merge_requests.add_spent_time(333, 1, "1h")'
+    end
+
+    doc 'Time Stats' do
+      desc 'Add through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333, 1)
+        mr.add_spent_time(1.hour)
+      DOC
+
+      result <<~DOC
+        mr.add_spent_time(1.hour)
+        => {:time_estimate=>0, :total_time_spent=>12978000, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h"}
+        mr.add_spent_time('1h')
+        => {:time_estimate=>0, :total_time_spent=>12978001, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h 1s"}
+      DOC
+    end
+
+    def add_spent_time(project_id, merge_request_id, duration)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      duration = ChronicDuration.output(ChronicDuration.parse(duration.to_s), format: :short)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_id}/add_spent_time", nil, duration: duration)
+    end
+
+    doc 'Time Stats' do
+      title 'Estimate'
+      desc 'Sets an estimated time of work for this merge request. [project id, mr iid, duration]'
+      markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Duration Example'
+      example 'client.merge_requests.time_estimate(333, 1, 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Human Format Example'
+      example 'client.merge_requests.time_estimate(333, 1, "1h")'
+    end
+
+    doc 'Time Stats' do
+      desc 'Add through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333, 1)
+        mr.add_spent_time(1.hour)
+      DOC
+
+      result <<~DOC
+        mr.add_spent_time(1.hour)
+        => {:time_estimate=>0, :total_time_spent=>12978000, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h"}
+        mr.add_spent_time('1h')
+        => {:time_estimate=>0, :total_time_spent=>12978001, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h 1s"}
+      DOC
+    end
+
+    def time_estimate(project_id, merge_request_id, duration)
+      project_id = format_id(project_id)
+      merge_request_id = format_id(merge_request_id)
+
+      duration = ChronicDuration.output(ChronicDuration.parse(duration.to_s), format: :short)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_id}/time_estimate", nil, duration: duration)
+    end
+
+    # Resets
+    doc 'Time Stats' do
+      title 'Reset'
+      subtitle 'Estimate'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, mr iid]'
+      example 'client.merge_requests.reset_time_estimate(333, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333, 1)'
+        mr.reset_time_estimate
+      DOC
+    end
+
+    def reset_time_estimate(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}/reset_time_estimate")
+    end
+
+    doc 'Time Stats' do
+      subtitle 'Time Spent'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, mr iid]'
+      example 'client.merge_requests.reset_spent_time(333, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(333, 1)
+        mr.reset_spent_time
+      DOC
+    end
+
+    def reset_spent_time(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}/reset_spent_time")
+    end
+  end
+end

data/lib/labclient/merge_requests/todo.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Todo'
+      desc 'Manually creates a todo for the current user on a merge request. [project id, merge request iid]'
+
+      example 'client.merge_requests.todo(343, 7)'
+
+      result <<~DOC
+        => #<Todo id: 7513, state: pending>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Create Todo through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.todo
+      DOC
+    end
+
+    def todo(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}/todo", Todo)
+    end
+  end
+end

data/lib/labclient/merge_requests/unsubscribe.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      title 'Unsubscribe'
+      desc 'Subscribes the authenticated user to a merge request to receive notification. [project id, merge request iid]'
+
+      example 'client.merge_requests.unsubscribe(343, 7)'
+
+      result <<~DOC
+        => #<MergeRequest id: 3, title: Add new file>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Unsubscribe through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.unsubscribe
+      DOC
+    end
+
+    def unsubscribe(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}/unsubscribe", MergeRequest)
+    end
+  end
+end

data/lib/labclient/merge_requests/update.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequests < Common
+    doc 'Update' do
+      desc 'Updates an existing merge request. You can change the target branch, title, or even close the MR. [project id, merge request iid]'
+
+      example <<~DOC
+        client.merge_requests.update(343, 2, {
+          title: 'Better Title'
+        })
+      DOC
+
+      result <<~DOC
+        => #<MergeRequest id: 2, title: Better Title>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(343,2)
+        mr.update(title: 'Dew it')
+      DOC
+    end
+
+    # Update
+    def update(project_id, merge_request_id, query)
+      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}", MergeRequest, query)
+    end
+  end
+end