labclient 0.1.0

data/lib/labclient/jobs/cancel.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Cancel'
+      desc 'Cancel a single job of a project [Project ID, Job ID]'
+      example 'client.jobs.cancel(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_cancel(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.cancel
+      DOC
+    end
+
+    def cancel(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/jobs/#{job_id}/cancel", Job)
+    end
+  end
+end

data/lib/labclient/jobs/delete.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Retry'
+      desc 'Delete artifacts of a job. [Project ID, Job ID]'
+      example 'client.jobs.delete(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_delete(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.delete
+      DOC
+    end
+
+    def delete(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/jobs/#{job_id}/artifacts")
+    end
+  end
+end

data/lib/labclient/jobs/erase.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Erase'
+      desc 'Erase a single job of a project [Project ID, Job ID]'
+      example 'client.jobs.erase(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_erase(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.erase
+      DOC
+    end
+
+    def erase(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/jobs/#{job_id}/erase", Job)
+    end
+  end
+end

data/lib/labclient/jobs/job.rb

@@ -0,0 +1,79 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Job < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Job id: #{id}, status: #{status}, stage: #{stage}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show(project_id)
+    end
+
+    def pipeline
+      Pipeline.new(@table[:pipeline], response, client)
+    end
+
+    def artifacts(file_path = nil, job_token = nil)
+      project_id = collect_project_id
+      client.jobs.artifacts(project_id, id, file_path, job_token)
+    end
+
+    def artifacts_path(artifacts_path, file_path = nil)
+      project_id = collect_project_id
+      client.jobs.artifacts_path(project_id, id, artifacts_path, file_path)
+    end
+
+    def trace
+      project_id = collect_project_id
+      client.jobs.trace(project_id, id)
+    end
+
+    def cancel
+      project_id = collect_project_id
+      client.jobs.cancel(project_id, id)
+    end
+
+    def retry
+      project_id = collect_project_id
+      client.jobs.retry(project_id, id)
+    end
+
+    def erase
+      project_id = collect_project_id
+      client.jobs.erase(project_id, id)
+    end
+
+    def keep
+      project_id = collect_project_id
+      client.jobs.keep(project_id, id)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.jobs.delete(project_id, id)
+    end
+
+    def play
+      project_id = collect_project_id
+      client.jobs.play(project_id, id)
+    end
+
+    help do
+      @group_name = 'Jobs'
+      subtitle 'Job'
+      option 'artifacts', 'Download Job artifacts. [File Path, Job Token]'
+      option 'artifacts_path', 'Download Job artifacts path. [File Path, Output Path]'
+      option 'trace', 'Get Job Output'
+      option 'cancel', 'Cancel Job'
+      option 'retry', 'Retry Job'
+      option 'erase', 'Erase Job'
+      option 'keep', 'Prevents artifacts from being deleted when expiration is set.'
+      option 'delete', 'Delete artifacts of a job.'
+      option 'play', 'Triggers a manual action to start a job.'
+    end
+  end
+end

data/lib/labclient/jobs/keep.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Retry'
+      desc 'Prevents artifacts from being deleted when expiration is set. [Project ID, Job ID]'
+      example 'client.jobs.keep(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_keep(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.keep
+      DOC
+    end
+
+    def keep(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/jobs/#{job_id}/keep", Job)
+    end
+  end
+end

data/lib/labclient/jobs/pipeline_list.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'List' do
+      title 'Pipeline'
+      desc 'Get a list of jobs for a pipeline. [Project ID, Pipeline ID, Scope]'
+      example 'client.jobs.pipeline(264, 7)'
+      result '[#<Job id: 13, status: success, stage: build>, #<Job id: 14, status: success, stage: build>]'
+
+      markdown <<~DOC
+        Scope of jobs to show. Either one of or an array of the following: created, pending, running, failed, success, canceled, skipped, or manual. All jobs are returned if scope is not provided.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Pipeline'
+      example <<~DOC
+        pipeline = client.pipelines.show(264, 7)
+        pipeline.jobs
+      DOC
+    end
+
+    def pipeline(project_id, pipeline_id, scope = nil)
+      pipeline_id = format_id(pipeline_id)
+      project_id = format_id(project_id)
+
+      query = { scope: scope } if scope
+
+      client.request(:get, "projects/#{project_id}/pipelines/#{pipeline_id}/jobs", Job, query)
+    end
+  end
+end

data/lib/labclient/jobs/play.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Retry'
+      desc 'Triggers a manual action to start a job. [Project ID, Job ID]'
+      example 'client.jobs.play(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_play(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.play
+      DOC
+    end
+
+    def play(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/jobs/#{job_id}/play", Job)
+    end
+  end
+end

data/lib/labclient/jobs/project_list.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'List' do
+      title 'Project'
+      desc 'Get a list of jobs in a project. Jobs are sorted in descending order of their IDs. [Project ID, Scope]'
+      example 'client.jobs.project(264)'
+      result '[#<Job id: 10, status: failed>, ...]'
+
+      markdown <<~DOC
+        Scope of jobs to show. Either one of or an array of the following: created, pending, running, failed, success, canceled, skipped, or manual. All jobs are returned if scope is not provided.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.jobs
+      DOC
+    end
+
+    def project(project_id, scope = nil)
+      project_id = format_id(project_id)
+      query = { scope: scope } if scope
+      client.request(:get, "projects/#{project_id}/jobs", Job, query)
+    end
+  end
+end

data/lib/labclient/jobs/retry.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Update' do
+      title 'Retry'
+      desc 'Retry a single job of a project [Project ID, Job ID]'
+      example 'client.jobs.retry(264, 14)'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_retry(1)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.retry
+      DOC
+    end
+
+    def retry(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/jobs/#{job_id}/retry", Job)
+    end
+  end
+end

data/lib/labclient/jobs/show.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Show' do
+      desc 'Get a list of jobs for a pipeline. [Project ID, Job ID]'
+      example 'client.jobs.show(264, 1)'
+      result '#<Job id: 13, status: success, stage: build>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job(1)
+      DOC
+    end
+
+    def show(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/jobs/#{job_id}", Job)
+    end
+  end
+end

data/lib/labclient/jobs/trace.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Show' do
+      title 'Trace'
+      desc 'Get a log (trace) of a specific job of a project [Project ID, Job ID]'
+      example 'client.jobs.show(264, 14)'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_trace(1)
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264,1)
+        job.trace
+      DOC
+    end
+
+    def trace(project_id, job_id)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      puts client.request(:get, "projects/#{project_id}/jobs/#{job_id}/trace")
+    end
+  end
+end

data/lib/labclient/keys/fingerprint.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Keys < Common
+    doc 'Show' do
+      title 'Fingerprint'
+      desc 'Get user by fingerprint of SSH key'
+      example 'client.keys.fingerprint("05:50:87:08:...9:7d:37:30:fe")'
+      result '# => #<Key id: 2, username: root>'
+
+      markdown <<~DOC
+        | Attribute    | Type  | Required  | Description                   |
+        |--------------|-------|---------- |------------------------------|
+        | fingerprint  | string | yes      | The fingerprint of an SSH key |
+
+
+        Deploy keys are bound to the creating user, so if you query with a deploy key fingerprint you get additional information about the projects using that key.
+      DOC
+    end
+
+    def fingerprint(key_id)
+      query = { fingerprint: key_id }
+
+      client.request(:get, 'keys', Key, query)
+    end
+  end
+end

data/lib/labclient/keys/key.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Key < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Key id: #{id}#{inspect_username}>"
+    end
+
+    def inspect_username
+      ", username: #{@table[:user].username}" if has? :user
+    end
+
+    def user
+      if has? :user
+        LabClient::User.new(@table[:user], response, client)
+      else
+        user_id = collect_user_id
+        client.users.show(user_id)
+      end
+    end
+
+    date_time_attrs %i[created_at]
+  end
+end

data/lib/labclient/keys/project.rb

@@ -0,0 +1,68 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Events < Common
+    doc 'Project' do
+      desc 'Get a list of visible events for a particular project. [ project id ]'
+      example 'client.events.project(1)'
+      result <<~DOC
+        => [#<Event type: imported>, #<Event type: created>, #<Event type: pushed to>, ...]
+      DOC
+    end
+
+    doc 'Project' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action | string | no | Include only events of a particular action type |
+        | target_type | string | no | Include only events of a particular target type] |
+        | before | date | no |  Include only events created before a particular date. |
+        | after | date | no |  Include only events created after a particular date. |
+        | scope | string | no | Include all events across a user's projects. |
+        | sort | string | no | Sort events in asc or desc order by created_at. Default is desc |
+
+
+
+        **Available parameters for the `target_type` and `action`**:
+
+        | Type        | Parameters |
+        | ----------- | ---------- |
+        | action      | issue, merge_request, milestone, note, project, snippet, user |
+        | target_type | closed, commented, created, destroyed, expired, joined, left, merged, pushed, reopened, updated |
+
+
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'Filter by Action'
+      example 'client.events.project(1, action: :created)'
+    end
+
+    doc 'Project' do
+      desc 'Filter by Target Type'
+      example 'client.events.project(1, target_type: :issue)'
+    end
+
+    doc 'Project' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both :after and :before can be used with Date or Time objects. (responds_to: to_time)
+      DOC
+
+      example <<~DOC
+        client.events.project(1, after: 2.day.ago)
+      DOC
+    end
+
+    def project(project_id, query = {})
+      project_id = format_id(project_id)
+
+      query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
+      query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
+
+      client.request(:get, "projects/#{project_id}/events", Event, query)
+    end
+  end
+end

data/lib/labclient/keys/show.rb

@@ -0,0 +1,15 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Keys < Common
+    doc 'Show' do
+      desc 'Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key.'
+      example 'client.keys.show(1)'
+      result '=> #<Key id: 1, username: root>'
+    end
+
+    def show(key_id)
+      client.request(:get, "keys/#{key_id}", Key)
+    end
+  end
+end

data/lib/labclient/keys/user.rb

@@ -0,0 +1,66 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Events < Common
+    doc 'User' do
+      desc 'Get the contribution events for the specified user, sorted from newest to oldest [ user id ]'
+      example 'client.events.user(1)'
+      result <<~DOC
+        => [#<Event type: imported>, #<Event type: created>, #<Event type: pushed to>, ...]
+      DOC
+    end
+
+    doc 'User' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action | string | no | Include only events of a particular action type |
+        | target_type | string | no | Include only events of a particular target type] |
+        | before | date | no |  Include only events created before a particular date. |
+        | after | date | no |  Include only events created after a particular date. |
+        | scope | string | no | Include all events across a user's projects. |
+        | sort | string | no | Sort events in asc or desc order by created_at. Default is desc |
+
+
+
+        **Available parameters for the `target_type` and `action`**:
+
+        | Type        | Parameters |
+        | ----------- | ---------- |
+        | action      | issue, merge_request, milestone, note, project, snippet, user |
+        | target_type | closed, commented, created, destroyed, expired, joined, left, merged, pushed, reopened, updated |
+
+
+      DOC
+    end
+
+    doc 'User' do
+      desc 'Filter by Action'
+      example 'client.events.user(1, action: :created)'
+    end
+
+    doc 'User' do
+      desc 'Filter by Target Type'
+      example 'client.events.user(1, target_type: :issue)'
+    end
+
+    doc 'User' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both :after and :before can be used with Date or Time objects. (responds_to: to_time)
+      DOC
+
+      example <<~DOC
+        client.events.user(1, after: 2.day.ago)
+      DOC
+    end
+
+    def user(user_id, query = {})
+      query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
+      query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
+
+      client.request(:get, "users/#{user_id}/events", Event, query)
+    end
+  end
+end