labclient 0.1.0

data/lib/labclient/repository/tree.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Tree' do
+      desc 'GetGet a list of repository files and directories in a project [Project ID, Hash]'
+      example 'client.repository.tree(264)'
+      result '[{:id=>"a3c86dff3a547733fd3d91432785386211481842", :name=>"README", :type=>"blob", :path=>"README", :mode=>"100644"}]'
+
+      markdown <<~DOC
+        **Parameters**:
+
+        * path (optional) - The path inside repository. Used to get content of subdirectories
+        * ref (optional) - The name of a repository branch or tag or if not given the default branch
+        * recursive (optional) - Boolean value used to get a recursive tree (false by default)
+
+      DOC
+    end
+
+    doc 'Tree' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.tree(ref: :master)
+      DOC
+    end
+
+    def tree(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/repository/tree", nil, query)
+    end
+  end
+end

data/lib/labclient/resource_labels/epics/client.rb

@@ -0,0 +1,9 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabels < Common
+    def epics
+      ResourceLabelEpics.new(client)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelEpics < Common
+    @group_name = 'Resource Labels'
+    doc 'Epics' do
+      title 'List'
+      desc 'Gets a list of all label events for a single epic. [Group ID, Epic ID]'
+      example 'client.resource_labels.epics.list(59,6)'
+      result <<~DOC
+        => [#<ResourceLabel Epic id: 4>, #<ResourceLabel Epic id: 5>]
+      DOC
+    end
+
+    doc 'Epics' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(59,3)
+        epic.resource_labels
+      DOC
+    end
+
+    def list(group_id, epic_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events", ResourceLabel)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelEpics < Common
+    @group_name = 'Resource Labels'
+    doc 'Epics' do
+      title 'Show'
+      desc 'Returns a single label event for a specific group epic [Group ID, Epic ID, Resource Event ID]'
+      example 'client.resource_labels.epics.show(59,6,5)'
+      result <<~DOC
+        => #<ResourceLabel Epic id: 5>
+      DOC
+    end
+
+    doc 'Epics' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(59,3)
+        epic.resource_label(5)
+      DOC
+    end
+
+    def show(group_id, epic_id, resource_event_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+      resource_event_id = format_id(resource_event_id)
+
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events/#{resource_event_id}", ResourceLabel)
+    end
+  end
+end

data/lib/labclient/resource_labels/issues/client.rb

@@ -0,0 +1,9 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabels < Common
+    def issues
+      ResourceLabelIssues.new(client)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelIssues < Common
+    @group_name = 'Resource Labels'
+    doc 'Issues' do
+      title 'List'
+      desc 'Gets a list of all label events for a single issue. [Project ID, Issue IID]'
+      example 'client.resource_labels.issues.list(16,2)'
+      result <<~DOC
+        => [#<ResourceLabel Issue id: 2>, #<ResourceLabel Issue id: 3>]
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Issue'
+      example <<~DOC
+        issue = client.issues.show(16,2)
+        issue.resource_labels
+      DOC
+    end
+
+    def list(project_id, issue_iid)
+      project_id = format_id(project_id)
+      issue_iid = format_id(issue_iid)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events", ResourceLabel)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelIssues < Common
+    @group_name = 'Resource Labels'
+    doc 'Issues' do
+      title 'Show'
+      desc 'Returns a single label event for a specific project issue [Project ID, Issue IID, Resource Event ID]'
+      example 'client.resource_labels.issues.show(16,3,2)'
+      result <<~DOC
+        => #<ResourceLabel Issue id: 2>
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Issue'
+      example <<~DOC
+        issue = client.issues.show(16,3)
+        issue.resource_label(2)
+      DOC
+    end
+
+    def show(project_id, issue_iid, resource_event_id)
+      project_id = format_id(project_id)
+      issue_iid = format_id(issue_iid)
+      resource_event_id = format_id(resource_event_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events/#{resource_event_id}", ResourceLabel)
+    end
+  end
+end

data/lib/labclient/resource_labels/merge_requests/client.rb

@@ -0,0 +1,9 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabels < Common
+    def merge_requests
+      ResourceLabelMergeRequests.new(client)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelMergeRequests < Common
+    @group_name = 'Resource Labels'
+    doc 'Merge Requests' do
+      title 'List'
+      desc 'Gets a list of all label events for a single merge_request. [Project ID, MergeRequest IID]'
+      example 'client.resource_labels.merge_requests.list(16,1)'
+      result <<~DOC
+        => [#<ResourceLabel MergeRequest id: 4>, #<ResourceLabel MergeRequest id: 5>]
+      DOC
+    end
+
+    doc 'Merge Requests' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        merge_request = client.merge_requests.show(16,1)
+        merge_request.resource_labels
+      DOC
+    end
+
+    def list(project_id, merge_request_iid)
+      project_id = format_id(project_id)
+      merge_request_iid = format_id(merge_request_iid)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_iid}/resource_label_events", ResourceLabel)
+    end
+  end
+end

data/lib/labclient/resource_labels/merge_requests/show.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ResourceLabelMergeRequests < Common
+    @group_name = 'Resource Labels'
+    doc 'Merge Requests' do
+      title 'Show'
+      desc 'Returns a single label event for a specific group merge_requests [Project ID, MergeRequest IID, Resource Event ID]'
+      example 'client.resource_labels.merge_requests.show(59,6,5)'
+      result <<~DOC
+        => #<ResourceLabel MergeRequest id: 5>
+      DOC
+    end
+
+    doc 'Merge Requests' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        merge_requests = client.merge_requests.show(59,3)
+        merge_requests.resource_label(5)
+      DOC
+    end
+
+    def show(project_id, merge_requests_iid, resource_event_id)
+      project_id = format_id(project_id)
+      merge_requests_iid = format_id(merge_requests_iid)
+      resource_event_id = format_id(resource_event_id)
+
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_requests_iid}/resource_label_events/#{resource_event_id}", ResourceLabel)
+    end
+  end
+end

data/lib/labclient/resource_labels/resource_label.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ResourceLabel < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<ResourceLabel #{resource_type} id: #{id}>"
+    end
+
+    date_time_attrs %i[created_at]
+    user_attrs %i[user]
+  end
+end
+
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ResourceLabels < Common
+    include ClassHelpers
+  end
+end

data/lib/labclient/runners/all.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'List' do
+      title 'All'
+      desc 'Get a list of all runners in the GitLab instance (specific and shared). [Hash]'
+      example 'client.runners.all'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+        | Attribute   | Type           | Required | Description         |
+        |-------------|----------------|----------|---------------------|
+        | type      | string         | no       | The type of runners to show, one of: instance_type, group_type, project_type |
+        | status    | string         | no       | The status of runners to show, one of: active, paused, online, offline |
+        | tag_list  | string array   | no       | List of of the runner's tags |
+      DOC
+    end
+
+    def all(query = {})
+      client.request(:get, 'runners/all', Runner, query)
+    end
+  end
+end

data/lib/labclient/runners/delete.rb

@@ -0,0 +1,14 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Delete' do
+      desc 'Delete a registered runner. [Authentication Token]'
+      example 'client.runners.delete("TokenInformation")'
+    end
+
+    def delete(token)
+      client.request(:delete, 'runners', nil, token: token)
+    end
+  end
+end

data/lib/labclient/runners/jobs.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Jobs' do
+      desc 'List jobs that are being processed or were processed by specified Runner. [Runner ID]'
+      example 'client.runners.jobs(1)'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description         |
+        |-----------|---------|----------|---------------------|
+        | status  | string  | no       | Status of the job; one of: running, success, failed, canceled |
+        | order_by| string  | no       | Order jobs by id. |
+        | sort    | string  | no       | Sort jobs in asc or desc order (default: desc) |
+
+      DOC
+    end
+
+    def jobs(runner_id, query = {})
+      runner_id = format_id(runner_id)
+      client.request(:get, "runners/#{runner_id}/jobs", Job, query)
+    end
+  end
+end

data/lib/labclient/runners/list.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'List' do
+      title 'Owned'
+      desc 'Get a list of specific runners available to the user. [Hash]'
+      example 'client.runners.list'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+        | Attribute   | Type           | Required | Description         |
+        |-------------|----------------|----------|---------------------|
+        | type      | string         | no       | The type of runners to show, one of: instance_type, group_type, project_type |
+        | status    | string         | no       | The status of runners to show, one of: active, paused, online, offline |
+        | tag_list  | string array   | no       | List of of the runner's tags |
+      DOC
+    end
+
+    def list(query = {})
+      client.request(:get, 'runners', Runner, query)
+    end
+  end
+end

data/lib/labclient/runners/register.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Register' do
+      desc 'Register a new Runner for the instance. [Hash]'
+      example 'client.runners.register(token: "Token!")'
+      result '{:id=>"12345", :token=>"6337ff461c94fd3fa32ba3b1ff4125"}'
+
+      markdown <<~DOC
+
+        | Attribute    | Type    | Required | Description         |
+        |--------------|---------|----------|---------------------|
+        | token      | string  | yes      | Registration token |
+        | description| string  | no       | Runner's description |
+        | info       | hash    | no       | Runner's metadata   |
+        | active     | boolean | no       | Whether the Runner is active   |
+        | locked     | boolean | no       | Whether the Runner should be locked for current project |
+        | run_untagged | boolean | no     | Whether the Runner should handle untagged jobs |
+        | tag_list   | string array | no  | List of Runner's tags |
+        | access_level    | string | no   | The access_level of the runner; not_protected or ref_protected |
+        | maximum_timeout | integer | no  | Maximum timeout set when this Runner will handle the job |
+      DOC
+    end
+
+    def register(query)
+      client.request(:post, 'runners', nil, query)
+    end
+  end
+end

data/lib/labclient/runners/remove.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Remove' do
+      desc 'Remove a runner. [Runner ID]'
+      example 'client.runners.delete(5)'
+    end
+
+    doc 'Remove' do
+      desc 'Via Runner'
+      example <<~DOC
+        runner = client.runners.show(5)
+        runner.delete
+      DOC
+    end
+
+    def remove(runner_id)
+      runner_id = format_id(runner_id)
+
+      client.request(:delete, "runners/#{runner_id}")
+    end
+  end
+end

data/lib/labclient/runners/runner.rb

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Runner < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Runner id: #{id}, status: #{status}>"
+    end
+
+    def details
+      update_self client.runners.show(id)
+    end
+
+    def remove
+      client.runners.remove(id)
+    end
+
+    def jobs(query = {})
+      client.runners.jobs(id, query)
+    end
+
+    def update(query)
+      update_self client.runners.update(id, query)
+    end
+
+    def verify
+      details if token.nil? # Not included in List
+      client.runners.verify(token)
+    end
+
+    help do
+      subtitle 'Runner'
+      option 'details', 'Collect runner details'
+      option 'update', 'Update this runner [Hash]'
+      option 'update', 'Remove runner'
+      option 'jobs', 'Show runner jobs [Hash]'
+      option 'verify', 'Verify authentication token'
+    end
+  end
+end

data/lib/labclient/runners/show.rb

@@ -0,0 +1,16 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Show' do
+      desc 'Get details of a runner. [Runner ID]'
+      example 'client.runners.show(3)'
+      result '#<Runner id: 3, status: online>'
+    end
+
+    def show(runner_id)
+      runner_id = format_id(runner_id)
+      client.request(:get, "runners/#{runner_id}", Runner)
+    end
+  end
+end

data/lib/labclient/runners/update.rb

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Update' do
+      desc 'Update details of a runner. [Runner ID, Hash]'
+      example 'client.runners.update(3, description: :rawr)'
+      result '#<Runner id: 3, status: online>'
+      markdown <<~DOC
+
+        | Attribute     | Type    | Required | Description         |
+        |---------------|---------|----------|---------------------|
+        | description | string  | no       | The description of a runner |
+        | active      | boolean | no       | The state of a runner; can be set to true or false |
+        | tag_list    | array   | no       | The list of tags for a runner; put array of tags, that should be finally assigned to a runner |
+        | run_untagged| boolean | no       | Flag indicating the runner can execute untagged jobs |
+        | locked      | boolean | no       | Flag indicating the runner is locked |
+        | access_level | string | no       | The access_level of the runner; not_protected or ref_protected |
+        | maximum_timeout | integer | no   | Maximum timeout set when this Runner will handle the job |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Runner'
+      example <<~DOC
+        runner = client.runners.show(5)
+        runner.update(description: 'Hello!')
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Pausing a Runner'
+      example <<~DOC
+        client.runners.update(3, active: false)
+        => #<Runner id: 3, status: paused>
+      DOC
+    end
+
+    def update(runner_id, query)
+      runner_id = format_id(runner_id)
+
+      client.request(:put, "runners/#{runner_id}", Runner, query)
+    end
+  end
+end

data/lib/labclient/runners/verify.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Verify' do
+      desc 'Validates authentication credentials for a registered Runner. [Authentication Token]'
+      example 'client.runners.verify("TokenInformation")'
+    end
+
+    doc 'Verify' do
+      desc 'Via Runner'
+      example <<~DOC
+        runner = client.runners.show(3)
+        runner.verify
+      DOC
+    end
+
+    def verify(token)
+      client.request(:post, 'runners/verify', nil, token: token)
+    end
+  end
+end

data/lib/labclient/search/search.rb

@@ -0,0 +1,18 @@
+# The glorious gitlab labclient of labs
+module LabClient
+  # Helper for Docs
+  class Search
+    extend Docs
+
+    doc 'Search' do
+      title ''
+      desc 'Lots! Search Scopes are on each of the individual scope endpoints'
+
+      markdown <<~DOC
+        - <a target="_blank" href="/#Users-Search">Users</a>
+        - <a target="_blank" href="/#Projects-Search">Projects</a>
+        - <a target="_blank" href="/#Groups-Search">Groups</a>
+      DOC
+    end
+  end
+end

data/lib/labclient/snippets/agent_detail.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Show' do
+      title 'Get user agent details'
+      example 'client.snippets.agent_detail(2)'
+      result <<~DOC
+        => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'From Snippet Object'
+      example 'snippet.agent_detail'
+      result <<~DOC
+        snippet = client.snippets.show(2)
+        => #<Snippet id: 2, Grapthar's hammer>
+        snippet.agent_detail
+        => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}
+      DOC
+    end
+
+    # Show Specific
+    def agent_detail(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "snippets/#{project_id}/user_agent_detail")
+    end
+  end
+end

data/lib/labclient/snippets/content.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Content' do
+      desc 'Get a single snippet’s raw contents.'
+      example 'client.snippets.raw(2)'
+      result <<~DOC
+        => "Here's the special content"
+      DOC
+    end
+
+    doc 'Content' do
+      markdown 'Display content from `Snippet` object.'
+      example <<~DOC
+        snippet = client.snippets.raw(2)
+        snippet.raw
+      DOC
+
+      result <<~DOC
+        snippet = client.snippets.show(2)
+        => #<Snippet id: 2, Special Title>
+        snippet.raw
+        => "Here's the special content"
+      DOC
+    end
+
+    # Show Specific
+    def raw(snippet_id)
+      client.request(:get, "snippets/#{snippet_id}/raw")
+    end
+  end
+end