labclient 0.1.0

data/lib/labclient/issues/list.rb

@@ -0,0 +1,58 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'List' do
+      desc 'Get all issues the authenticated user has access to. By default it returns only issues created by the current user. To get all issues, use parameter scope=all.'
+      example 'client.issues.list'
+      result <<~DOC
+        => #<Issue id: 1, title: Front-line global approach, state: opened>
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        See [API docs here](https://docs.gitlab.com/ee/api/issues.html#list-issues) for full list of attributes
+
+        | Attribute           | Type           | Description                                                                                                                                         |
+        | ------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+        | labels            | string           | Comma-separated list of label names, issues must have all labels to be returned. None lists all issues with no labels. Any lists all issues with at least one label.|
+        | milestone         | string           | The milestone title. None lists all issues with no milestone. Any lists all issues that have an assigned milestone. |
+        | order_by          | string           | Return issues ordered by created_at, updated_at, priority, due_date, relative_position, label_priority, milestone_due, popularity, weight fields. Default is created_at |
+        | sort              | string           | Return issues sorted in asc or desc order. Default is desc |
+        | search            | string           | Search issues against their title and description |
+        | created_after     | datetime         | Return issues created on or after the given time. Accepts DateTime |
+        | created_before    | datetime         | Return issues created on or before the given time. Accepts DateTime |
+        | updated_after     | datetime         | Return issues updated on or after the given time. Accepts DateTime |
+        | updated_before    | datetime         | Return issues updated on or before the given time. Accepts DateTime |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by State'
+      example 'client.issues.list(state: :opened)'
+    end
+
+    doc 'List' do
+      desc 'Filter by Labels'
+      example 'client.issues.list(labels: ["11sadf"])'
+    end
+
+    doc 'List' do
+      desc 'Search in Title'
+      example 'client.issues.list(search: "Title Text", in: :title)'
+    end
+
+    doc 'List' do
+      desc 'Filter by time'
+      example 'client.issues.list(created_before: 1.year.ago)'
+    end
+
+    def list(query = {})
+      query[:created_after] = query[:created_after].to_time.iso8601 if format_time?(query[:created_after])
+      query[:created_before] = query[:created_before].to_time.iso8601 if format_time?(query[:created_before])
+
+      client.request(:get, 'issues', Issue, query)
+    end
+  end
+end

data/lib/labclient/issues/move.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Move' do
+      desc 'Moves an issue to a different project. [project id, issue iid, target project id]'
+      example 'client.issues.move(5, 1, 6)'
+      result <<~DOC
+        => #<Issue id: 1, title: Moar Fancy!, state: opened>
+      DOC
+    end
+
+    doc 'Move' do
+      desc 'Through Issue Object [target project id]'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.move(6)
+      DOC
+    end
+
+    def move(project_id, issue_id, target_id)
+      project_id = format_id(project_id)
+      target_id = format_id(target_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/move", Issue, to_project_id: target_id)
+    end
+  end
+end

data/lib/labclient/issues/notes.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      title 'Notes'
+      desc 'Notes are handled via the Notes resource. Accessible via the object or notes'
+      example <<~DOC
+        issue = client.issues.show(30,2)
+        issue.notes
+      DOC
+
+      result <<~DOC
+        => [#<Note id: 21, type: Issue>, #<Note id: 20, type: Issue>, .. ]
+      DOC
+    end
+  end
+end

data/lib/labclient/issues/participants.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      title 'Participants'
+      desc 'Get a list of issue participants. [project id, issue iid]'
+      example 'client.issues.participants(30,1)'
+      result <<~DOC
+        => [#<User id: 1, username: braum>, #<User id: 52, username: anivia>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'List through MergeRequest'
+      example <<~DOC
+        mr = client.issues.show(30,1)
+        mr.participants
+      DOC
+      result <<~DOC
+        issue = client.issues.show(30,1)
+        => #<Issue id: 1, title: Robust incremental superstructure, state: opened>
+        issue.participants
+        => [#<User id: 1, username: root>]
+      DOC
+    end
+
+    # Show Specific
+    def participants(project_id, issue_id = nil)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/participants", User)
+    end
+  end
+end

data/lib/labclient/issues/project_issues.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'List' do
+      title 'Project'
+      desc 'Get a list of a project’s issues.'
+      example 'client.issues.project_issues(1)'
+      result <<~DOC
+        => [#<Issue id: 1, title: Front-line global approach, state: opened>, ..]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.issues
+      DOC
+    end
+
+    def project_issues(project_id, query = {})
+      project_id = format_id(project_id)
+
+      query[:created_after] = query[:created_after].to_time.iso8601 if format_time?(query[:created_after])
+      query[:created_before] = query[:created_before].to_time.iso8601 if format_time?(query[:created_before])
+
+      client.request(:get, "projects/#{project_id}/issues", Issue, query)
+    end
+  end
+end

data/lib/labclient/issues/related_merge_requests.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      title 'Merge Requests'
+      subtitle 'Related'
+      desc 'Get all the merge requests that are related to the issue. [project id, issue iid]'
+      example 'client.issues.related_merge_requests(5, 1)'
+      result <<~DOC
+        => [#<MergeRequest id: 5, title: Update README.md, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.related_merge_requests
+      DOC
+    end
+
+    def related_merge_requests(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/related_merge_requests", MergeRequest)
+    end
+  end
+end

data/lib/labclient/issues/show.rb

@@ -0,0 +1,21 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      desc 'Get a single project issue. [project, issue iid]'
+      example 'client.issues.show(343, 1)'
+      result <<~DOC
+        => #<Issue id: 1, title: Front-line global approach, state: opened>
+      DOC
+    end
+
+    # Show
+    def show(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}", Issue)
+    end
+  end
+end

data/lib/labclient/issues/subscribe.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Update' do
+      title 'Subscribe'
+      desc 'Subscribes the authenticated user to an issue to receive notifications. [project id, issue iid]'
+
+      example 'client.issues.subscribe(343, 7)'
+
+      result <<~DOC
+        => #<Issue id: 3, title: Add new file>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Subscribe through Issue'
+      example <<~DOC
+        issue = client.issues.show(30,2)
+        issue.subscribe
+      DOC
+    end
+
+    def subscribe(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/subscribe", Issue)
+    end
+  end
+end

data/lib/labclient/issues/time_stats.rb

@@ -0,0 +1,157 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Time Stats' do
+      title 'Show'
+      desc 'Get time tracking stats. [project id, issue iid]'
+      example 'client.issues.time_stats(30, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through Issue'
+      example <<~DOC
+        issue = client.issues.show(30, 1)'
+        issue.time_stats
+      DOC
+    end
+
+    def time_stats(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/time_stats")
+    end
+
+    doc 'Time Stats' do
+      title 'Add'
+      desc 'Adds spent time for this merge request. [project id, issue iid, duration]'
+      markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Duration Example'
+      example 'client.issues.add_spent_time(30, 1, 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Human Format Example'
+      example 'client.issues.add_spent_time(30, 1, "1h")'
+    end
+
+    doc 'Time Stats' do
+      desc 'Add through Issue'
+      example <<~DOC
+        issue = client.issues.show(30, 1)
+        issue.add_spent_time(1.hour)
+      DOC
+
+      result <<~DOC
+        issue.add_spent_time(1.hour)
+        => {:time_estimate=>0, :total_time_spent=>12978000, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h"}
+        issue.add_spent_time('1h')
+        => {:time_estimate=>0, :total_time_spent=>12978001, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h 1s"}
+      DOC
+    end
+
+    def add_spent_time(project_id, mr_id, duration)
+      project_id = format_id(project_id)
+      mr_id = format_id(mr_id)
+
+      duration = ChronicDuration.output(ChronicDuration.parse(duration.to_s), format: :short)
+      client.request(:post, "projects/#{project_id}/issues/#{mr_id}/add_spent_time", nil, duration: duration)
+    end
+
+    doc 'Time Stats' do
+      title 'Estimate'
+      desc 'Sets an estimated time of work for this merge request. [project id, issue iid, duration]'
+      markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Duration Example'
+      example 'client.issues.time_estimate(30, 1, 1.hour)'
+    end
+
+    doc 'Time Stats' do
+      desc 'Human Format Example'
+      example 'client.issues.time_estimate(30, 1, "1h")'
+    end
+
+    doc 'Time Stats' do
+      desc 'Add through Issue'
+      example <<~DOC
+        issue = client.issues.show(30, 1)
+        issue.add_spent_time(1.hour)
+      DOC
+
+      result <<~DOC
+        issue.add_spent_time(1.hour)
+        => {:time_estimate=>0, :total_time_spent=>12978000, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h"}
+        issue.add_spent_time('1h')
+        => {:time_estimate=>0, :total_time_spent=>12978001, :human_time_estimate=>nil, :human_total_time_spent=>"22mo 2w 5h 1s"}
+      DOC
+    end
+
+    def time_estimate(project_id, mr_id, duration)
+      project_id = format_id(project_id)
+      mr_id = format_id(mr_id)
+
+      duration = ChronicDuration.output(ChronicDuration.parse(duration.to_s), format: :short)
+      client.request(:post, "projects/#{project_id}/issues/#{mr_id}/time_estimate", nil, duration: duration)
+    end
+
+    # Resets
+    doc 'Time Stats' do
+      title 'Reset'
+      subtitle 'Estimate'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, issue iid]'
+      example 'client.issues.reset_time_estimate(30, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through Issue'
+      example <<~DOC
+        issue = client.issues.show(30, 1)
+        issue.reset_time_estimate
+      DOC
+    end
+
+    def reset_time_estimate(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/reset_time_estimate")
+    end
+
+    doc 'Time Stats' do
+      subtitle 'Time Spent'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, issue iid]'
+      example 'client.issues.reset_spent_time(30, 1)'
+      result <<~DOC
+        => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
+      DOC
+    end
+
+    doc 'Time Stats' do
+      desc 'Show through Issue'
+      example <<~DOC
+        issue = client.issues.show(30, 1)
+        issue.reset_spent_time
+      DOC
+    end
+
+    def reset_spent_time(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/reset_spent_time")
+    end
+  end
+end

data/lib/labclient/issues/todo.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Update' do
+      title 'Todo'
+      desc 'Manually creates a todo for the current user on an issue. [project id, merge request iid]'
+
+      example 'client.issues.todo(30, 1)'
+
+      result <<~DOC
+        => #<Todo id: 7513, state: pending>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Create Todo through Issue'
+      example <<~DOC
+        issue = client.issues.show(30,2)
+        issue.todo
+      DOC
+    end
+
+    def todo(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/todo", Todo)
+    end
+  end
+end

data/lib/labclient/issues/unsubscribe.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Update' do
+      title 'Unsubscribe'
+      desc 'Unsubscribes the authenticated user from the issue to not receive notifications from it. [project id, issue iid]'
+
+      example 'client.issues.unsubscribe(343, 7)'
+
+      result <<~DOC
+        => #<Issue id: 10, title: Compatible holistic solution, state: opened>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Unsubscribe through Issue'
+      example <<~DOC
+        issue = client.issues.show(343,2)
+        issue.unsubscribe
+      DOC
+    end
+
+    def unsubscribe(project_id, issue_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/unsubscribe", Issue)
+    end
+  end
+end

data/lib/labclient/issues/update.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Update' do
+      desc 'Updates an existing project issue. This call is also used to mark an issue as closed. [project id, issue iid]'
+      example 'client.issues.update(5, 1, title: "Moar Fancy!")'
+      result <<~DOC
+        => #<Issue id: 1, title: Moar Fancy!, state: opened>
+      DOC
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        See [API docs here](https://docs.gitlab.com/ee/api/issues.html#edit-issue) for full list of attributes
+
+        | Attribute                                 | Type           | Required | Description  |
+        |-------------------------------------------|----------------|----------|--------------|
+        | title                                   | string         | no      | The title of an issue |
+        | description                             | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Close Ticket'
+      example 'client.issues.update(5, 1, state_event: :close)'
+    end
+
+    doc 'Update' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.update(title: "Dew it!")
+      DOC
+    end
+
+    def update(project_id, issue_id, query = {})
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:put, "projects/#{project_id}/issues/#{issue_id}", Issue, query)
+    end
+  end
+end

data/lib/labclient/jobs/artifacts.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Artifacts' do
+      desc 'Get the job’s artifacts zipped archive of a project. [Project ID, Job ID, File Path, Job Token]'
+      example 'client.jobs.artifacts(264, 1)'
+
+      markdown <<~DOC
+        File Output will default to the current directory + job id + file extension. 14.zip
+
+        Job Token: To be used with triggers for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`.
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'Specific output location'
+      example <<~DOC
+        client.jobs.artifacts(264, 1, '/tmp/output.zip')
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_artifacts(7)
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264, 7)
+        job.artifacts
+      DOC
+    end
+
+    def artifacts(project_id, job_id, file_path = nil, job_token = nil)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      file_path ||= "#{Dir.pwd}/#{job_id}.zip"
+      query = { job_token: job_token } if job_token
+      output = client.request(:get, "projects/#{project_id}/jobs/#{job_id}/artifacts", nil, query)
+
+      File.write(file_path, output)
+    end
+  end
+end

data/lib/labclient/jobs/artifacts_latest.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Artifacts' do
+      title 'Latest'
+      desc 'Download the artifacts zipped archive from the latest successful pipeline for the given reference name and job, provided the job finished successfully [Project ID, Branch Name, Job Name, File Path, Job Token]'
+      example 'client.jobs.artifacts_latest(264, :master, :artifacts)'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+
+        File Output will default to the current directory + job name + file extension. job_name.zip
+
+
+          Job Token: To be used with triggers for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`.
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_artifacts_latest(:master, :artifacts)
+      DOC
+    end
+
+    def artifacts_latest(project_id, branch_name, job_name, file_path = nil, job_token = nil)
+      query = { job: job_name }
+      query[:job_token] = job_token if job_token
+      file_path ||= "#{Dir.pwd}/#{job_name}.zip"
+
+      project_id = format_id(project_id)
+      output = client.request(:get, "projects/#{project_id}/jobs/artifacts/#{branch_name}/download", nil, query)
+
+      File.write(file_path, output)
+    end
+  end
+end

data/lib/labclient/jobs/artifacts_path.rb

@@ -0,0 +1,50 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Jobs < Common
+    doc 'Artifacts' do
+      title 'Path'
+      desc 'Download a single artifact file from a job with a specified ID from within the job’s artifacts zipped archive. The file is extracted from the archive and streamed to the client. [Project ID, Job ID, Artifact Path, File Output]'
+      example 'client.jobs.artifacts_path(264, 1, "test.txt")'
+
+      markdown <<~DOC
+        File Output will default to the current directory + job id + file extension. 14.zip
+
+        artifact_path: 	Path to a file inside the artifacts archive.
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'Specific output location'
+      example <<~DOC
+        client.jobs.artifacts(264, 1, '/tmp/output.zip')
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.job_artifacts_path(7, 'path/file.txt')
+      DOC
+    end
+
+    doc 'Artifacts' do
+      desc 'via Job'
+      example <<~DOC
+        job = client.jobs.show(264, 7)
+        job.artifacts_path('path/file.txt')
+      DOC
+    end
+
+    def artifacts_path(project_id, job_id, artifact_path, file_path = nil)
+      job_id = format_id(job_id)
+      project_id = format_id(project_id)
+      file_path ||= "#{Dir.pwd}/#{artifact_path}"
+
+      output = client.request(:get, "projects/#{project_id}/jobs/#{job_id}/artifacts/#{artifact_path}", nil)
+
+      File.write(file_path, output)
+    end
+  end
+end