labclient 0.1.0 → 0.1.5

data/lib/labclient/merge_requests/todo.rb

@@ -4,7 +4,7 @@ module LabClient
   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]'
+      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)'
 

data/lib/labclient/merge_requests/unsubscribe.rb

@@ -4,7 +4,7 @@ module LabClient
   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]'
+      desc 'Subscribes the authenticated user to a merge request to receive notification. [Project ID, merge request iid]'
 
       example 'client.merge_requests.unsubscribe(343, 7)'
 

data/lib/labclient/merge_requests/update.rb

@@ -3,7 +3,7 @@ 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]'
+      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, {

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

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/overview.rb

@@ -7,11 +7,15 @@ module LabClient
 
     doc 'Overview' do
       title 'About'
-      desc <<~DOC
+      markdown <<~DOC
         Labclient is another Gitlab API Gem. A focus on ease of use and helpers and snippets.
 
         <a href="https://github.com/NARKOZ/gitlab">Gitlab</a> is an excellent gem, and is nearly complete in its implementation. While this is still a work in progress and you are looking for general use you should use it.
+
+        Here's a quick whirlwind example of some of the features:
       DOC
+
+      demo '350689'
     end
 
     doc 'Overview' do
@@ -44,6 +48,41 @@ module LabClient
       DOC
     end
 
+    doc 'Authentication' do
+      title 'Named Profiles'
+      markdown 'Within the `~/.gitlab-labclient` you can also specify profile names'
+      example <<~DOC
+        {
+          "prod": {
+            "url": "https://labclient-prod",
+            "token": "super_secure",
+            "paginate": false
+          },
+          "dev": {
+            "url": "https://labclient-dev",
+            "token": "super_secure",
+            "ssl_verify": false,
+            "paginate": true
+          }
+        }
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Manually select a named profile'
+      example <<~DOC
+        client = LabClient::Client.new(profile: 'prod')
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Automatically select via ENV Variables'
+      example <<~DOC
+        ENV['LABCLIENT_PROFILE'] = 'dev'
+        client = LabClient::Client.new
+      DOC
+    end
+
     doc 'Authentication' do
       title 'Environment Variables'
       desc 'If not provided, and credentials file does not exist will attempt to use ENV variables'
@@ -143,6 +182,27 @@ module LabClient
       DOC
     end
 
+    doc 'Response' do
+      title 'Status'
+      desc 'Each object/call will return a "response" object or the instantiated class object. On each of these you can use "success?" to verify the response of a call.'
+
+      result <<~DOC
+        project = client.projects.show 123123
+        # => #<TyphoeusResponse code: 404>
+        project.success?
+        # => false
+
+        user = client.users.show 1
+        => #<User id: 1, username: root>
+        user.success?
+        => true
+      DOC
+
+      result <<~DOC
+        curl -k -H "Private-Token: super_secret_token" -H "Accept: application/json" "https://labclient/api/v4/users?"
+      DOC
+    end
+
     doc 'Other' do
       title 'Common Helpers'
       markdown <<~DOC
@@ -173,6 +233,38 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      title 'Object Helpers'
+      markdown <<~DOC
+        Each created object will have additional helper methods
+      DOC
+
+      result <<~DOC
+        project = client.projects.show(5)
+
+        # Awesome Print all details
+        project.verbose
+
+        # Awesome Print all details
+        project.valid_group_project_levels
+        # => [:guest, :reporter, :developer, :maintainer, :owner]
+      DOC
+    end
+
+    doc 'Other' do
+      desc 'Object Help'
+
+      result <<~DOC
+        project = client.projects.show(5)
+
+        # List Possible Methods
+        project.help
+
+        # Array result of methods
+        project.api_methods
+      DOC
+    end
+
     doc 'Other' do
       title 'Object IDs'
 
@@ -199,21 +291,6 @@ module LabClient
       DOC
     end
 
-    doc 'Other' do
-      title 'Docker'
-      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
-
-      example 'docker run -it registry.gitlab.com/labclient/labclient'
-
-      result <<~DOC
-        # Run Container
-        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="token" registry.gitlab.com/labclient/labclient
-
-        client = LabClient::Client.new
-        client.users.list
-      DOC
-    end
-
     doc 'Other' do
       title 'Curl'
       desc 'Sometimes you just wana have a curl example to test or send someone'
@@ -238,6 +315,30 @@ module LabClient
         - [API Authentication](https://docs.gitlab.com/ee/api/README.html#authentication)
       DOC
     end
+
+    doc 'Docker' do
+      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        # Run Container
+        docker run -it registry.gitlab.com/labclient/labclient
+        # Without settings configured, initial will prompt for credentials
+
+        client.users.list
+      DOC
+    end
+
+    doc 'Docker' do
+      desc 'The docker container configured and execute code snippets'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="secure_token" labclient 'puts client.users.list.count'
+      DOC
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength