labclient 0.1.1 → 0.2.0

data/lib/labclient/license/list.rb

@@ -32,12 +32,12 @@ module LabClient
                            :expires_at => "2050-11-14",
                            :historical_max => 0,
                            :maximum_user_count => 48,
-                           :licensee => OpenStruct {
+                           :licensee => LabStruct {
                            :Name => "GitLab Henley",
                            :Email => "test_user@gitlab.com",
                            :Company => "GitLab, Inc."
                },
-                           :add_ons => OpenStruct {},
+                           :add_ons => LabStruct {},
                            :expired => false,
                            :overage => 0,
                            :user_limit => 100,

data/lib/labclient/members/member.rb

@@ -51,6 +51,7 @@ module LabClient
       option 'level', 'Humanized symbol of access level. e.g. :developer'
       option 'user', 'Collect user object.'
       option '<permission>?', 'True/False evaluation each guest?, developer? etc'
+      option 'greater_than', 'True/False if user has greater than [Permission Name]'
     end
   end
 end

data/lib/labclient/merge_requests/accept.rb

@@ -7,10 +7,19 @@ module LabClient
       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>
+          - <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>
+
+        | **Attribute**                | **Attribute**                                                                                     |
+        | ---------------------------- | ------------------------------------------------------------------------------------------------- |
+        | merge_commit_message         | Custom merge commit message                                                                       |
+        | squash_commit_message        | Custom squash commit message                                                                      |
+        | squash                       | if true the commits will be squashed into a single commit on merge                                |
+        | should_remove_source_branch  | if true removes the source branch                                                                 |
+        | merge_when_pipeline_succeeds | if true the MR is merged when the pipeline succeeds                                               |
+        | sha                          | if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail |
       DOC
 
       example 'client.merge_requests.accept(343, 3)'
@@ -29,11 +38,11 @@ module LabClient
     end
 
     # Accept
-    def accept(project_id, merge_request_id)
+    def accept(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}/merge", MergeRequest)
+      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/merge", MergeRequest, query)
     end
   end
 end

data/lib/labclient/merge_requests/create.rb

@@ -41,6 +41,18 @@ module LabClient
       DOC
     end
 
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.merge_request_create(
+          title: 'New MR!',
+          source_branch: 'sweet-release',
+          target_branch: :master
+        )
+      DOC
+    end
+
     # Create
     def create(project_id, query)
       project_id = format_id(project_id)

data/lib/labclient/merge_requests/merge_request.rb

@@ -51,8 +51,8 @@ module LabClient
       client.merge_requests.delete(project_id, iid)
     end
 
-    def accept
-      client.merge_requests.accept(project_id, iid)
+    def accept(query = {})
+      client.merge_requests.accept(project_id, iid, query)
     end
 
     def merge_ref
@@ -99,6 +99,10 @@ module LabClient
       client.notes.merge_requests.list(project_id, iid)
     end
 
+    def note_create(query)
+      client.notes.merge_requests.create(project_id, iid, query)
+    end
+
     def todo
       client.merge_requests.todo(project_id, iid)
     end
@@ -166,9 +170,42 @@ module LabClient
       client.resource_labels.merge_requests.show(project_id, iid, resource_event_id)
     end
 
+    # Reload
+    def reload
+      update_self client.merge_requests.show(project_id, iid)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_merge_status(total_time = 300, sleep_time = 15)
+      # :unchecked
+      # :cannot_be_merged_recheck
+      # :checking
+      # :cannot_be_merged_rechecking
+      # :can_be_merged
+      # :cannot_be_merged
+
+      # Success
+      # [unchecked, can_be_merged]
+
+      # Fail
+      # [cannot_be_merged cannot_be_merged_recheck]
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts "Waiting for Merge Status: #{merge_status}"
+          break if %w[can_be_merged unchecked].include? merge_status
+          raise "Cannot be merged! #{import_error}" if %w[cannot_be_merged cannot_be_merged_recheck].include? merge_status
+
+          sleep sleep_time
+        end
+      end
+    end
+
+    # rubocop:disable Metrics/BlockLength
     help do
       subtitle 'MergeRequest'
-      option 'accept', 'Merge changes submitted'
+      option 'accept', 'Merge changes submitted [Hash]'
       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'
@@ -176,7 +213,13 @@ module LabClient
       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 'reload', 'Reload this merge request object (New API Call)'
+      option 'wait_for_merge_status', 'Looping, wait for merge request status [Timeout, Interval]'
+
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
+
       option 'participants', 'List participants in this merge request.'
       option 'pipelines', 'List pipelines in this merge request.'
       option 'reset_spent_time', 'Resets the spent time'
@@ -206,6 +249,8 @@ module LabClient
       option 'resource_labels', 'List of all label events'
       option 'resource_label', 'Show single label event [Resource Event ID]'
     end
+
+    # rubocop:enable Metrics/BlockLength
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/notes/epics/create.rb

@@ -4,13 +4,21 @@ module LabClient
   class EpicNotes < Common
     doc 'Epics' do
       title 'Create'
-      desc 'Creates a new note for a single merge request [Project, Epic IID]'
+      desc 'Creates a new note for a single epic [Project, Epic IID]'
       example 'client.notes.epics.create(16, 2, body: "Hello!")'
       result <<~DOC
         => #<Note id: 44, type: Epic>
       DOC
     end
 
+    doc 'Epics' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(16, 2)
+        epic.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Epics' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |
@@ -20,13 +28,13 @@ module LabClient
       DOC
     end
 
-    def create(project_id, epic_id, query = {})
-      project_id = format_id(project_id)
+    def create(group_id, epic_id, query = {})
+      group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
-      client.request(:post, "projects/#{project_id}/epics/#{epic_id}/notes", Note, query)
+      client.request(:post, "groups/#{group_id}/epics/#{epic_id}/notes", Note, query)
     end
   end
 end

data/lib/labclient/notes/epics/delete.rb

@@ -9,12 +9,12 @@ module LabClient
     end
 
     # Delete
-    def delete(project_id, epic_id, note_id)
-      project_id = format_id(project_id)
+    def delete(group_id, epic_id, note_id)
+      group_id = format_id(group_id)
       epic_id = format_id(epic_id)
       note_id = format_id(note_id)
 
-      client.request(:delete, "projects/#{project_id}/epics/#{epic_id}/notes/#{note_id}")
+      client.request(:delete, "groups/#{group_id}/epics/#{epic_id}/notes/#{note_id}")
     end
   end
 end

data/lib/labclient/notes/epics/list.rb

@@ -5,18 +5,35 @@ module LabClient
     @group_name = 'Notes'
     doc 'Epics' do
       title 'List'
-      desc 'Gets a list of all notes for a single merge request. [Project ID, Epic IID]'
+      desc 'Gets a list of all notes for a single epic. [Project ID, Epic IID]'
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description                                                                          |
+        | --------- | ------ | -------- | ------------------------------------------------------------------------------------ |
+        | sort      | string | no       | Return epic notes sorted in asc or desc order. Default is desc                      |
+        | order_by  | string | no       | Return epic notes ordered by created_at or updated_at fields. Default is created_at |
+      DOC
+    end
+
+    doc 'Epics' do
       example 'client.notes.epics.list(16, 1)'
       result <<~DOC
         => [#<Note id: 21, type: Epic>, #<Note id: 20, type: Epic> .. ]
       DOC
     end
 
-    def list(project_id, epic_id)
-      project_id = format_id(project_id)
+    doc 'Epics' do
+      desc 'Filter or Sort'
+      example 'client.notes.epics.list(16, 1, order_by: :created_at, sort: :asc)'
+      result <<~DOC
+        => [#<Note id: 21, type: Epic>, #<Note id: 20, type: Epic> .. ]
+      DOC
+    end
+
+    def list(group_id, epic_id, query = {})
+      group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/notes", Note)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/notes", Note, query)
     end
   end
 end

data/lib/labclient/notes/epics/show.rb

@@ -4,19 +4,19 @@ module LabClient
   class EpicNotes < Common
     doc 'Epics' do
       title 'Show'
-      desc 'Returns a single note for a given merge request. [Project ID, Epic IID, Note ID]'
+      desc 'Returns a single note for a given epic. [Project ID, Epic IID, Note ID]'
       example 'client.notes.epics.show(16, 1, 43)'
       result <<~DOC
         => #<Note id: 21, type: Epic>
       DOC
     end
 
-    def show(project_id, epic_id, note_id)
-      project_id = format_id(project_id)
+    def show(group_id, epic_id, note_id)
+      group_id = format_id(group_id)
       epic_id = format_id(epic_id)
       note_id = format_id(note_id)
 
-      client.request(:get, "projects/#{project_id}/epics/#{epic_id}/notes/#{note_id}", Note)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/notes/#{note_id}", Note)
     end
   end
 end

data/lib/labclient/notes/epics/update.rb

@@ -4,7 +4,7 @@ module LabClient
   class EpicNotes < Common
     doc 'Epics' do
       title 'Update'
-      desc 'Get a single project epic. [Project ID, Epic IID, Note ID]'
+      desc 'Get a single group epic. [Project ID, Epic IID, Note ID]'
       example 'client.notes.epics.update(16, 1, 43, "Updaaate")'
       result <<~DOC
         => #<Note id: 43, type: Epic>
@@ -20,13 +20,13 @@ module LabClient
     end
 
     # Show
-    def update(project_id, epic_id, note_id, body)
-      project_id = format_id(project_id)
+    def update(group_id, epic_id, note_id, body)
+      group_id = format_id(group_id)
       epic_id = format_id(epic_id)
       note_id = format_id(note_id)
       query = { body: body }
 
-      client.request(:put, "projects/#{project_id}/epics/#{epic_id}/notes/#{note_id}", Note, query)
+      client.request(:put, "groups/#{group_id}/epics/#{epic_id}/notes/#{note_id}", Note, query)
     end
   end
 end

data/lib/labclient/notes/issues/create.rb

@@ -4,13 +4,21 @@ module LabClient
   class IssueNotes < Common
     doc 'Issues' do
       title 'Create'
-      desc 'Creates a new note for a single merge request [Project, Issue IID]'
+      desc 'Creates a new note for a single issue [Project, Issue IID]'
       example 'client.notes.issues.create(16, 2, body: "Hello!")'
       result <<~DOC
         => #<Note id: 44, type: Issue>
       DOC
     end
 
+    doc 'Issues' do
+      desc 'Via Issue'
+      example <<~DOC
+        issue = client.issues.show(16, 1)
+        issue.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Issues' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |
@@ -26,6 +34,8 @@ module LabClient
 
       query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
 
+      # POST /projects/:id/issues/:issue_iid/notes
+
       client.request(:post, "projects/#{project_id}/issues/#{issue_id}/notes", Note, query)
     end
   end

data/lib/labclient/notes/issues/list.rb

@@ -3,20 +3,35 @@ module LabClient
   # Specifics
   class IssueNotes < Common
     @group_name = 'Notes'
+
     doc 'Issues' do
       title 'List'
-      desc 'Gets a list of all notes for a single merge request. [Project ID, Issue IID]'
+      desc 'Gets a list of all notes for a single issue. [Project ID, Issue IID]'
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description                                                                          |
+        | --------- | ------ | -------- | ------------------------------------------------------------------------------------ |
+        | sort      | string | no       | Return issue notes sorted in asc or desc order. Default is desc                      |
+        | order_by  | string | no       | Return issue notes ordered by created_at or updated_at fields. Default is created_at |
+      DOC
+    end
+
+    doc 'Issues' do
       example 'client.notes.issues.list(16, 1)'
       result <<~DOC
         => [#<Note id: 21, type: Issue>, #<Note id: 20, type: Issue> .. ]
       DOC
     end
 
-    def list(project_id, issue_id)
+    doc 'Issues' do
+      desc 'Sort or Filter'
+      example 'client.notes.issues.list(16, 1, order_by: :created_at, sort: :asc)'
+    end
+
+    def list(project_id, issue_id, query = {})
       project_id = format_id(project_id)
       issue_id = format_id(issue_id)
 
-      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/notes", Note)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/notes", Note, query)
     end
   end
 end

data/lib/labclient/notes/issues/show.rb

@@ -4,7 +4,7 @@ module LabClient
   class IssueNotes < Common
     doc 'Issues' do
       title 'Show'
-      desc 'Returns a single note for a given merge request. [Project ID, Issue IID, Note ID]'
+      desc 'Returns a single note for a given issue. [Project ID, Issue IID, Note ID]'
       example 'client.notes.issues.show(16, 1, 43)'
       result <<~DOC
         => #<Note id: 21, type: Issue>

data/lib/labclient/notes/merge_requests/create.rb

@@ -11,6 +11,14 @@ module LabClient
       DOC
     end
 
+    doc 'Merge Request' do
+      desc 'Via Merge Request'
+      example <<~DOC
+        merge_request = client.merge_requests.show(16, 2)
+        merge_request.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Merge Requests' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |

data/lib/labclient/notes/merge_requests/list.rb

@@ -6,17 +6,35 @@ module LabClient
     doc 'Merge Requests' do
       title 'List'
       desc 'Gets a list of all notes for a single merge request. [Project ID, Merge Request IID]'
+
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description                                                                                  |
+        | --------- | ------ | -------- | -------------------------------------------------------------------------------------------- |
+        | sort      | string | no       | Return merge request notes sorted in asc or desc order. Default is desc                      |
+        | order_by  | string | no       | Return merge request notes ordered by created_at or updated_at fields. Default is created_at |
+      DOC
+    end
+
+    doc 'Merge Requests' do
       example 'client.notes.merge_requests.list(16, 1)'
       result <<~DOC
         => [#<Note id: 21, type: MergeRequest>, #<Note id: 20, type: MergeRequest> .. ]
       DOC
     end
 
-    def list(project_id, merge_request_id)
+    doc 'Merge Requests' do
+      desc 'Sort or Filter'
+      example 'client.notes.merge_requests.list(16, 1, order_by: :created_at, sort: :asc)'
+      result <<~DOC
+        => [#<Note id: 21, type: MergeRequest>, #<Note id: 20, type: MergeRequest> .. ]
+      DOC
+    end
+
+    def list(project_id, merge_request_id, 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}/notes", Note)
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_id}/notes", Note, query)
     end
   end
 end