labclient 0.1.2 → 0.1.3

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

@@ -4,7 +4,7 @@ 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>
@@ -20,13 +20,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,7 +4,7 @@ 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>
@@ -26,6 +26,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/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

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

@@ -4,7 +4,7 @@ module LabClient
   class SnippetNotes < Common
     doc 'Snippets' do
       title 'Create'
-      desc 'Creates a new note for a single merge request [Project, Snippet ID]'
+      desc 'Creates a new note for a single snippet [Project, Snippet ID]'
       example 'client.notes.snippets.create(16, 2, body: "Hello!")'
       result <<~DOC
         => #<Note id: 44, type: Snippet>

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

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

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

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

data/lib/labclient/notifications/update.rb

@@ -33,7 +33,7 @@ module LabClient
       result <<~DOC
            OpenStruct {
              :level => "custom",
-            :events => OpenStruct {
+            :events => LabStruct {
                            :new_release => nil,
                               :new_note => nil,
                              :new_issue => nil,

data/lib/labclient/paginated_response.rb

@@ -86,7 +86,7 @@ module LabClient
     end
 
     def link_regex
-      /<([^>]+)>; rel=\"([^\"]+)\"/
+      /<([^>]+)>; rel="([^"]+)"/
     end
 
     def next_page

data/lib/labclient/pipelines/pipeline.rb

@@ -33,6 +33,45 @@ module LabClient
       client.jobs.pipeline(project_id, id, scope)
     end
 
+    def reload
+      project_id = collect_project_id
+      update_self client.pipelines.show(project_id, id)
+    end
+
+    # The status of pipelines, one of: running, pending, success, failed, canceled, skipped, created, manual
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_status(total_time = 300, sleep_time = 15)
+      # running
+      # pending
+      # success
+      # failed
+      # canceled
+      # skipped
+      # manual
+      # created
+
+      # Wait
+      # [running created pending]
+
+      # Success
+      # [skipped manual canceled success]
+
+      # Fail
+      # [failed]
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts "Waiting for Pipeline: #{status}"
+          break if %w[skipped manual canceled success].include? status
+          raise 'Pipeline failed' if status == 'failed'
+
+          sleep sleep_time
+        end
+      end
+    end
+
     # DateTime Fields
     date_time_attrs %i[created_at updated_at finished_at started_at]
     user_attrs %i[user]
@@ -43,6 +82,8 @@ module LabClient
       option 'retry', 'Retry jobs in this pipeline'
       option 'cancel', 'Cancel jobs in this pipeline'
       option 'delete', 'Delete this pipeline'
+      option 'reload', 'Reload this pipeline object (New API Call)'
+      option 'wait_for_status', 'Looping, wait for merge request status [Timeout, Interval]'
     end
   end
 end

data/lib/labclient/projects/methods.rb

@@ -7,8 +7,8 @@ module LabClient
       client.projects.users(id)
     end
 
-    def events
-      client.events.project(id)
+    def events(query = {})
+      client.events.project(id, query)
     end
 
     def delete
@@ -346,6 +346,10 @@ module LabClient
       client.branches.show(id, branch_id)
     end
 
+    def branch_create(query)
+      client.branches.create(id, query)
+    end
+
     def branch_delete(branch_id)
       client.branches.delete(id, branch_id)
     end
@@ -620,6 +624,10 @@ module LabClient
       client.merge_requests.list_project(id, query)
     end
 
+    def merge_request_create(query)
+      client.merge_requests.create(id, query)
+    end
+
     # Access Requests
     def request_access
       client.projects.access_requests.create(id)
@@ -687,6 +695,25 @@ module LabClient
       update_self client.projects.show(id)
     end
 
+    # Parent Helper
+    def parent
+      case namespace.kind
+      when 'user'
+        client.users.show(namespace.id)
+      when 'group'
+        client.groups.show(namespace.id)
+      end
+    end
+
+    # Snippets
+    def snippets
+      client.projects.snippets.list(id)
+    end
+
+    def snippet_create(query)
+      client.projects.snippets.create(id, query)
+    end
+
     # Wait for Import / Set a Hard Limit
     def wait_for_import(total_time = 300, sleep_time = 15)
       # none
@@ -698,6 +725,7 @@ module LabClient
       Timeout.timeout(total_time) do
         loop do
           reload
+          puts "Waiting for Import Status: #{import_status}"
           break if %w[none finished].include? import_status
           raise "Import Failed: #{import_error}" if import_status == 'failed'
 

data/lib/labclient/projects/reference.rb

@@ -204,6 +204,7 @@ module LabClient
       # Branches
       option 'branches', 'List repository branches [String]'
       option 'branch', 'Get a single repository branches [Branch Name]'
+      option 'branch_create', 'Create a repository branches [Hash]'
       option 'branch_delete', 'Delete a single repository branches [Branch Name]'
       option 'branch_delete_merged', 'Will delete all branches that are merged into the project’s default branch'
 
@@ -241,6 +242,7 @@ module LabClient
 
       # Merge Requests
       option 'merge_requests', 'List project merge requests, [Hash]'
+      option 'merge_request_create', 'Create new merge request [Hash]'
 
       # Access Requests
       option 'access_requests', 'List access requests for project'
@@ -254,6 +256,9 @@ module LabClient
 
       # Clusters
       option 'clusters', 'Returns a list of project clusters.'
+
+      option 'events', 'List project events [Hash]'
+      option 'parent', 'Show (API Call) Project Parent, returns either Group or User'
     end
   end
   # rubocop:enable Metrics/BlockLength, Metrics/ClassLength