labclient 0.1.0

data/lib/labclient/projects/milestones/create.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Create' do
+      desc 'Creates a new project milestone. [Project ID, Hash]'
+
+      example <<~DOC
+        client.projects.milestones.create(16, title: "Sweet Code")
+      DOC
+
+      result <<~DOC
+        => #<ProjectMilestone id: 2, title: Sweet Code>
+      DOC
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute    | Type   | Required | Description                       |
+        |--------------|------- |--------- |---------------------------------- |
+        | title        | string | yes      | Title of a milestone.             |
+        | description  | string | no       | The description of the milestone  |
+        | due_date     | string | no       | The due date of the milestone     |
+        | start_date   | string | no       | The start date of the milestone   |
+      DOC
+    end
+
+    def create(project_id, query = {})
+      project_id = format_id(project_id)
+
+      query[:due_date] = query[:due_date].to_time.iso8601 if format_time?(query[:due_date])
+      query[:start_date] = query[:start_date].to_time.iso8601 if format_time?(query[:start_date])
+
+      client.request(:post, "projects/#{project_id}/milestones", ProjectMilestone, query)
+    end
+  end
+end

data/lib/labclient/projects/milestones/delete.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Delete' do
+      desc 'Deletes an existing project milestone. [Project ID, Project Milestone ID]'
+      example <<~DOC
+        client.projects.milestones.delete(16,2)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'via Project Milestone'
+      example <<~DOC
+        milestone = client.projects.milestones.show(16,1)
+        milestone.delete
+      DOC
+    end
+
+    def delete(project_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/milestones/#{milestone_id}")
+    end
+  end
+end

data/lib/labclient/projects/milestones/issues.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Show' do
+      title 'Issues'
+      desc 'Gets all issues assigned to a single project milestone. [Project ID, Project Milestone ID]'
+      example 'client.projects.milestones.issues(16, 1)'
+      result <<~DOC
+        => [#<Issue id: 36, title: Implemented high-level process improvement, state: opened>, #<Issue id: 35, title: Proactive didactic implementation, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via ProjectMilestone'
+      example <<~DOC
+        milestone = client.projects.milestones.show(16,1)
+        milestone.issues
+      DOC
+    end
+
+    def issues(project_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/milestones/#{milestone_id}/issues", Issue)
+    end
+  end
+end

data/lib/labclient/projects/milestones/list.rb

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'List' do
+      desc 'Get a list of project milestones. [Project ID, Hash]'
+      example 'client.projects.milestones.list(16)'
+      result <<~DOC
+        => [#<ProjectMilestone id: 1, title: Its a mile long stone>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+
+        | Attribute | Type   | Required | Description |
+        | --------- | ------ | -------- | ----------- |
+        | iids[]  | integer array | optional | Return only the milestones having the given iid |
+        | state   | string | optional | Return only active or closed milestones |
+        | title   | string | optional | Return only the milestones having the given title |
+        | search  | string | optional | Return only milestones with a title or description matching the provided string |
+
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.milestones
+      DOC
+    end
+
+    # List
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/milestones", ProjectMilestone, query)
+    end
+  end
+end

data/lib/labclient/projects/milestones/merge_requests.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Show' do
+      title 'Merge Requests'
+      desc 'Gets all merge requests assigned to a single project milestone. [Project ID, Project Milestone ID]'
+      example 'client.projects.milestones.merge_requests(16, 1)'
+      result <<~DOC
+        => [#<MergeRequest id: 7, title: Update README.md, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via ProjectMilestone'
+      example <<~DOC
+        milestone = client.projects.milestones.show(16,1)
+        milestone.merge_requests
+      DOC
+    end
+
+    def merge_requests(project_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/milestones/#{milestone_id}/merge_requests", MergeRequest)
+    end
+  end
+end

data/lib/labclient/projects/milestones/project_milestone.rb

@@ -0,0 +1,58 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectMilestone < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<ProjectMilestone id: #{id}, title: #{title}>"
+    end
+
+    def project
+      client.projects.show project_id
+    end
+
+    def update(query = {})
+      project_id = collect_project_id
+      update_self client.projects.milestones.update(project_id, id, query)
+    end
+
+    def promote
+      project_id = collect_project_id
+      client.projects.milestones.promote(project_id, id)
+    end
+
+    def issues
+      project_id = collect_project_id
+      client.projects.milestones.issues(project_id, id)
+    end
+
+    def merge_requests
+      project_id = collect_project_id
+      client.projects.milestones.merge_requests(project_id, id)
+    end
+
+    def burndown
+      project_id = collect_project_id
+      client.projects.milestones.burndown(project_id, id)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.projects.milestones.delete(project_id, id)
+    end
+
+    date_time_attrs %i[updated_at created_at due_date start_date]
+
+    help do
+      subtitle 'Project Project Milestone'
+      option 'project', 'Show project for milestone.'
+      option 'issues', 'Show issues assigned to milestone.'
+      option 'merge_requests', 'Show merge requests assigned to milestone.'
+      option 'promote', 'Promote to group milestone.'
+      option 'delete', 'Delete this milestone.'
+      option 'burndown', 'Show burndown events.'
+      option 'update', 'Update this this milestone. [Hash]'
+    end
+  end
+end

data/lib/labclient/projects/milestones/promote.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Update' do
+      title 'Promote'
+      desc 'Promote project milestone to a group milestone [Project ID, Project Milestone ID]'
+      example <<~DOC
+        client.projects.milestones.promote(16,2)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Project Milestone'
+      example <<~DOC
+        milestone = client.projects.milestones.show(16,1)
+        milestone.promote
+      DOC
+    end
+
+    def promote(project_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/milestones/#{milestone_id}/promote")
+    end
+  end
+end

data/lib/labclient/projects/milestones/show.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Show' do
+      desc 'Get a single project milestone. [Project ID, Project Milestone ID]'
+      example 'client.projects.milestones.show(16, 1)'
+      result <<~DOC
+        => #<ProjectMilestone id: 1, title: Its a mile long stone>
+      DOC
+    end
+
+    # Show Specific
+    def show(project_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/milestones/#{milestone_id}", ProjectMilestone)
+    end
+  end
+end

data/lib/labclient/projects/milestones/update.rb

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMilestones < Common
+    doc 'Update' do
+      desc 'Updates an existing project milestone [Project ID, Project Milestone ID, Hash]'
+
+      example <<~DOC
+        client.projects.milestones.update(16, 2, title: 'Better Title')
+      DOC
+
+      result <<~DOC
+        => #<ProjectMilestone id: 2, title: Better Title>
+      DOC
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute    | Type   | Required | Description                       |
+        |--------------|------- |--------- |---------------------------------- |
+        | title        | string | yes      | Title of a milestone.             |
+        | description  | string | no       | The description of the milestone  |
+        | due_date     | string | no       | The due date of the milestone     |
+        | start_date   | string | no       | The start date of the milestone   |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project Milestone'
+      example <<~DOC
+        milestone.update(title: 'One Project Milestone to find them!')
+      DOC
+    end
+
+    def update(project_id, milestone_id, query = {})
+      milestone_id = format_id(milestone_id)
+      project_id = format_id(project_id)
+
+      query[:due_date] = query[:due_date].to_time.iso8601 if format_time?(query[:due_date])
+      query[:start_date] = query[:start_date].to_time.iso8601 if format_time?(query[:start_date])
+
+      client.request(:put, "projects/#{project_id}/milestones/#{milestone_id}", ProjectMilestone, query)
+    end
+  end
+end

data/lib/labclient/projects/mirror_start.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Start Mirror'
+      desc 'Start the pull mirroring process for a Project [Project ID]'
+      example 'client.projects.mirror_start(296)'
+      result '# => 200'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.mirror_start
+      DOC
+    end
+
+    def mirror_start(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/mirror/pull", nil)
+    end
+  end
+end

data/lib/labclient/projects/mirrors/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectMirrors < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def mirrors
+      ProjectMirrors.new(client)
+    end
+  end
+end

data/lib/labclient/projects/mirrors/create.rb

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMirrors < Common
+    doc 'Create' do
+      desc 'Create a remote mirror for a project. The mirror will be disabled by default. [Project ID, Hash]'
+      example <<~DOC
+        client.projects.mirrors.create(
+          310,
+          url: 'https://labclient/test'
+        )
+      DOC
+
+      result '=>  #<ProjectMirror id: 2, status: none>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute              | Type    | Required   | Description                                         |
+        | ----------             | -----   | ---------  | ------------                                        |
+        | url                    | String  | yes        | The URL of the remote repository to be mirrored.    |
+        | enabled                | Boolean | no         | Determines if the mirror is enabled.                |
+        | only_protected_branches| Boolean | no         | Determines if only protected branches are mirrored. |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(100)
+        project.mirror_create(310,  url: 'https://labclient/test')
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/remote_mirrors", ProjectMirror, query)
+    end
+  end
+end

data/lib/labclient/projects/mirrors/list.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMirrors < Common
+    doc '' do
+      markdown '**Note:** __This is for push mirroring__'
+    end
+
+    doc 'List' do
+      desc 'List remote mirrors and their statuses. [Project ID]'
+      example 'client.projects.mirrors.list(16)'
+
+      result <<~DOC
+        => [#<ProjectMirror id: 1, status: finished>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.mirrors
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/remote_mirrors", ProjectMirror)
+    end
+  end
+end

data/lib/labclient/projects/mirrors/project_mirror.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectMirror < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectMirror id: #{id}, status: #{update_status}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show project_id
+    end
+
+    def update(query)
+      project_id = collect_project_id
+
+      update_self client.projects.mirrors.update(project_id, id, query)
+    end
+
+    date_time_attrs %i[last_update_started_at last_successful_update_at]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectMirror'
+      option 'project', 'Show Project'
+      option 'update', 'Update this Mirror [Hash]'
+    end
+  end
+end

data/lib/labclient/projects/mirrors/update.rb

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMirrors < Common
+    doc 'Update' do
+      desc 'Toggle a remote mirror on or off, or change which types of branches are mirrored: [Project ID, Mirror ID, Params]'
+      example 'client.projects.mirrors.update(310, 3, enabled: true)'
+
+      result '=>  #<ProjectMirror id: 3, name: planet bob>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute              | Type    | Required   | Description                                         |
+        | ----------             | -----   | ---------  | ------------                                        |
+        | url                    | String  | yes        | The URL of the remote repository to be mirrored.    |
+        | enabled                | Boolean | no         | Determines if the mirror is enabled.                |
+        | only_protected_branches| Boolean | no         | Determines if only protected branches are mirrored. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Mirror ID, Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        mirror = project.mirror_update(2, enabled: false)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectMirror [Params]'
+      example <<~DOC
+        mirror = client.projects.mirrors.list(310).first
+        mirror.update(enabled: false)
+      DOC
+    end
+
+    def update(project_id, mirror_id, query)
+      project_id = format_id(project_id)
+      mirror_id = format_id(mirror_id)
+
+      client.request(:put, "projects/#{project_id}/remote_mirrors/#{mirror_id}", ProjectMirror, query)
+    end
+  end
+end

data/lib/labclient/projects/pipeline_schedules/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class PipelineSchedules < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def pipeline_schedules
+      PipelineSchedules.new(client)
+    end
+  end
+end

data/lib/labclient/projects/pipeline_schedules/create.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'Create' do
+      desc 'Creates a new project pipeline_schedule. [Project ID, Hash]'
+
+      example <<~DOC
+        client.projects.pipeline_schedules.create(16, description: 'Regular Run', cron: '0 1 * * *', ref: :master)
+      DOC
+
+      result <<~DOC
+        => #<PipelineSchedule id: 1, ref: master>
+      DOC
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute     | Type    | required | Description              |
+        |---------------|---------|----------|--------------------------|
+        | description   | string  | yes      | The description of pipeline schedule         |
+        | ref           | string  | yes      | The branch/tag name will be triggered         |
+        | cron          | string  | yes      | The cron (e.g. 0 1 * * *) ([Cron syntax](https://en.wikipedia.org/wiki/Cron))       |
+        | cron_timezone | string  | no       | The timezone supported by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC')     |
+        | active        | boolean | no       | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true) |
+      DOC
+    end
+
+    def create(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/pipeline_schedules", PipelineSchedule, query)
+    end
+  end
+end

data/lib/labclient/projects/pipeline_schedules/delete.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'Delete' do
+      desc 'Delete the pipeline schedule of a project. [Project ID, Pipeline Schedule ID]'
+      example <<~DOC
+        client.projects.pipeline_schedules.delete(16, 2)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'via Pipeline Schedule'
+      example <<~DOC
+        pipeline_schedule = client.projects.pipeline_schedules.show(16, 1)
+        pipeline_schedule.delete
+      DOC
+    end
+
+    def delete(project_id, pipeline_schedule_id)
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}")
+    end
+  end
+end

data/lib/labclient/projects/pipeline_schedules/list.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'List' do
+      desc 'Get a list of the pipeline schedules of a project. [Project ID]'
+      example 'client.projects.pipeline_schedules.list(16)'
+      result <<~DOC
+        => [#<PipelineSchedule id: 1, ref: master>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.pipeline_schedules
+      DOC
+    end
+
+    # List
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/pipeline_schedules", PipelineSchedule, query)
+    end
+  end
+end