labclient 0.1.0

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

@@ -0,0 +1,69 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class PipelineSchedule < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<PipelineSchedule id: #{id}, ref: #{ref}>"
+    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.pipeline_schedules.update(project_id, id, query)
+    end
+
+    def play
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.play(project_id, id)
+    end
+
+    def take_ownership
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.take_ownership(project_id, id)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.delete(project_id, id)
+    end
+
+    # Vars
+    def create_variable(query = {})
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.variables.create(project_id, id, query)
+    end
+
+    def update_variable(variable_key, query = {})
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.variables.update(project_id, id, variable_key, query)
+    end
+
+    def delete_variable(variable_key)
+      project_id = collect_project_id
+      client.projects.pipeline_schedules.variables.delete(project_id, id, variable_key)
+    end
+
+    date_time_attrs %i[created_at updated_at next_run_at]
+    user_attrs %i[owner]
+
+    help do
+      subtitle 'Project Pipeline Schedule'
+      option 'project', 'Show project for pipeline_schedule.'
+      option 'play', 'Trigger a new scheduled pipeline.'
+      option 'take_ownership', 'Update the owner of the pipeline schedule of a project.'
+      option 'delete', 'Delete this pipeline_schedule.'
+      option 'update', 'Update this this pipeline_schedule. [Hash]'
+
+      # Variables
+      option 'create_variable', 'Create a new variable. [Hash]'
+      option 'update_variable', 'Update existing variable. [Variable Key, Hash]'
+      option 'delete_variable', 'Delete existing variable. [Variable Key,  Hash]'
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'Update' do
+      title 'Play'
+      desc 'Trigger a new scheduled pipeline, which runs immediately. The next scheduled run of this pipeline is not affected. [Project ID, Pipeline Schedule ID]'
+      example 'client.projects.pipeline_schedules.play(16, 1)'
+      result <<~DOC
+        => { "message": "201 Created" }
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via PipelineSchedule'
+      example <<~DOC
+        pipeline_schedule = client.projects.pipeline_schedules.show(16,1)
+        pipeline_schedule.play
+      DOC
+    end
+
+    def play(project_id, pipeline_schedule_id)
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}/play")
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'Update' do
+      title 'Take Ownership'
+      desc 'Update the owner of the pipeline schedule of a project.  [Project ID, Pipeline Schedule ID]'
+      example 'client.projects.pipeline_schedules.take_ownership(16, 2)'
+      result <<~DOC
+        => #<PipelineSchedule id: 2, ref: master>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via the Project Pipeline Schedule'
+      example <<~DOC
+        pipeline_schedule = client.pipeline_schedules.burndown(2)
+        pipeline_schedule.take_ownership
+      DOC
+    end
+
+    def take_ownership(project_id, pipeline_schedule_id)
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}/take_ownership", PipelineSchedule)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineSchedules < Common
+    doc 'Update' do
+      desc 'Updates the pipeline schedule of a project. Once the update is done, it will be rescheduled automatically. [Project ID, Pipeline Schedule ID, Hash]'
+
+      example <<~DOC
+        client.projects.pipeline_schedules.update(16, 1, description: 'Better Detail')
+      DOC
+
+      result <<~DOC
+        => #<PipelineSchedule id: 1, ref: master>
+      DOC
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute     | Type    | required | Description              |
+        |---------------|---------|----------|--------------------------|
+        | description   | string  | no       | The description of pipeline schedule         |
+        | ref           | string  | no       | The branch/tag name will be triggered         |
+        | cron          | string  | no       | 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
+
+    doc 'Update' do
+      desc 'Via Pipeline Schedule'
+      example <<~DOC
+        pipeline_schedule.update(title: 'One Pipeline Schedule to find them!')
+      DOC
+    end
+
+    def update(project_id, pipeline_schedule_id, query = {})
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}", PipelineSchedule, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineVariables < Common
+    @group_name = 'Pipeline Schedules'
+    doc 'Variables' do
+      title 'Create'
+      desc 'Create a new variable of a pipeline schedule. [Project ID, Pipeline Schedule ID, Hash]'
+      example 'client.projects.pipeline_schedules.variables.create(16, 1, key: :key_name, value: :var_value)'
+      result <<~DOC
+        => {:variable_type=>"env_var", :key=>"key_name", :value=>"var_value"}
+      DOC
+    end
+
+    doc 'Variables' do
+      markdown <<~DOC
+        | Attribute              | Type           | required | Description              |
+        |------------------------|----------------|----------|--------------------------|
+        | pipeline_schedule_id   | integer        | yes      | The pipeline schedule ID |
+        | key                    | string         | yes      | The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed |
+        | value                  | string         | yes      | The value of a variable |
+        | variable_type          | string         | no       | The type of a variable. Available types are: env_var (default) and file |
+      DOC
+    end
+
+    doc 'Variables' do
+      desc 'via PipelineSchedule'
+      example <<~DOC
+        pipeline_schedule = client.projects.pipeline_schedules.show(16,1)
+        pipeline_schedule.create_variable(key: :key_name, value: :var_value)
+      DOC
+    end
+
+    def create(project_id, pipeline_schedule_id, query)
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}/variables", nil, query)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineVariables < Common
+    @group_name = 'Pipeline Schedules'
+    doc 'Variables' do
+      title 'Delete'
+      desc 'Delete a new variable of a pipeline schedule. [Project ID, Pipeline Schedule ID, Variable Key]'
+      example 'client.projects.pipeline_schedules.variables.delete(16, 1, :key_name)'
+    end
+
+    doc 'Variables' do
+      markdown <<~DOC
+        | Attribute              | Type           | required | Description              |
+        |------------------------|----------------|----------|--------------------------|
+        | pipeline_schedule_id   | integer        | yes      | The pipeline schedule ID |
+        | key                    | string         | yes      | The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed |
+        | value                  | string         | yes      | The value of a variable |
+        | variable_type          | string         | no       | The type of a variable. Available types are: env_var (default) and file |
+      DOC
+    end
+
+    doc 'Variables' do
+      desc 'via PipelineSchedule'
+      example <<~DOC
+        pipeline_schedule = client.projects.pipeline_schedules.show(16,1)
+        pipeline_schedule.delete_variable(:key_name, value: :var_value)
+      DOC
+    end
+
+    def delete(project_id, pipeline_schedule_id, variable_key)
+      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}/variables/#{variable_key}")
+    end
+  end
+end

data/lib/labclient/projects/pipeline_schedules/variables/update.rb

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PipelineVariables < Common
+    @group_name = 'Pipeline Schedules'
+    doc 'Variables' do
+      title 'Update'
+      desc 'Update a new variable of a pipeline schedule. [Project ID, Pipeline Schedule ID, Variable Key, Hash]'
+      example 'client.projects.pipeline_schedules.variables.update(16, 1, :key_name, value: :better)'
+      result <<~DOC
+        => {:variable_type=>"env_var", :key=>"key_name", :value=>"better"}
+      DOC
+    end
+
+    doc 'Variables' do
+      markdown <<~DOC
+        | Attribute              | Type           | required | Description              |
+        |------------------------|----------------|----------|--------------------------|
+        | pipeline_schedule_id   | integer        | yes      | The pipeline schedule ID |
+        | key                    | string         | yes      | The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed |
+        | value                  | string         | yes      | The value of a variable |
+        | variable_type          | string         | no       | The type of a variable. Available types are: env_var (default) and file |
+      DOC
+    end
+
+    doc 'Variables' do
+      desc 'via PipelineSchedule'
+      example <<~DOC
+        pipeline_schedule = client.projects.pipeline_schedules.show(16,1)
+        pipeline_schedule.update_variable(:key_name, value: :var_value)
+      DOC
+    end
+
+    def update(project_id, pipeline_schedule_id, variable_key, query)
+      pipeline_schedule_id = format_id(pipeline_schedule_id)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{variable_key}", nil, query)
+    end
+  end
+end

data/lib/labclient/projects/project.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Project Definition
+  class Project < Klass
+    include ProjectDeployKey
+    include ProjectCommits
+    include ClassHelpers
+    include ProjectMethods
+    def inspect
+      "#<Project id: #{id} #{path_with_namespace}>"
+    end
+
+    date_time_attrs %i[last_activity_at created_at]
+
+    user_attrs %i[owner]
+  end
+end

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

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

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

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PushRules < Common
+    doc 'Create' do
+      desc 'Adds a push rule to a specified project. [Project ID]'
+      example <<~DOC
+        client.projects.push_rules.create(16, deny_delete_tag: true, branch_name_regex: '\d+\..*' )
+      DOC
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute                      | Type           | Required | Description |
+        | -------------------------------| -------------- | -------- | ----------- |
+        | deny_delete_tag                | boolean        | no       | Deny deleting a tag |
+        | member_check                   | boolean        | no       | Restrict commits by author (email) to existing GitLab users |
+        | prevent_secrets                | boolean        | no       | GitLab will reject any files that are likely to contain secrets |
+        | commit_message_regex           | string         | no       | All commit messages must match this, e.g. Fixed \d+\..* |
+        | commit_message_negative_regex  | string         | no       | No commit message is allowed to match this, e.g. ssh\:\/\/ |
+        | branch_name_regex              | string         | no       | All branch names must match this, e.g. (feature|hotfix)\/* |
+        | author_email_regex             | string         | no       | All commit author emails must match this, e.g. @my-company.com$ |
+        | file_name_regex                | string         | no       | All committed filenames must **not** match this, e.g. (jar|exe)$ |
+        | max_file_size                  | integer        | no       | Maximum file size (MB) |
+        | commit_committer_check         | boolean        | no       | Users can only push commits to this repository that were committed with one of their own verified emails. |
+        | reject_unsigned_commits        | boolean        | no       | Reject commit when it is not signed through GPG. |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project [Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.push_rules_create(deny_delete_tag: false)
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/push_rule", PushRule, query)
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PushRules < Common
+    doc 'Delete' do
+      desc 'Removes a push rule from a project. [Project ID]'
+      example 'client.projects.push_rules.delete(16)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        hook = project.push_rule_delete
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via PushRule'
+      example <<~DOC
+        rule = client.projects.push_rules.show(16, 1)
+        rule.delete
+      DOC
+    end
+
+    def delete(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/push_rule")
+    end
+  end
+end

data/lib/labclient/projects/push_rules/push_rule.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class PushRule < Klass
+    include ClassHelpers
+    def inspect
+      "#<PushRule id: #{id}>"
+    end
+
+    def project
+      client.projects.show project_id
+    end
+
+    def update(query)
+      update_self client.projects.push_rules.update(project_id, query)
+    end
+
+    def delete
+      client.projects.push_rules.delete(project_id)
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      subtitle 'Push Rules'
+      option 'project', 'Show Project'
+      option 'update', 'Update this hook [Hash]'
+      option 'delete', 'Delete this hook'
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PushRules < Common
+    doc 'Show' do
+      desc 'Get the push rules of a project. [Project ID]'
+      example 'client.projects.push_rules.show(16)'
+
+      result <<~DOC
+        project = client.projects.show(16)
+        => [
+          #<PushRule id: 5 >, ...
+        ]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.push_rules
+      DOC
+    end
+
+    def show(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/push_rule", PushRule)
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class PushRules < Common
+    doc 'Update' do
+      desc 'Edits a push rule for a specified project. [Project ID, Params]'
+      example 'client.projects.push_rules.update(16, max_file_size: 100)'
+      result '=>  #<PushRule id: 2>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute                      | Type           | Required | Description |
+        | -------------------------------| -------------- | -------- | ----------- |
+        | deny_delete_tag                | boolean        | no       | Deny deleting a tag |
+        | member_check                   | boolean        | no       | Restrict commits by author (email) to existing GitLab users |
+        | prevent_secrets                | boolean        | no       | GitLab will reject any files that are likely to contain secrets |
+        | commit_message_regex           | string         | no       | All commit messages must match this, e.g. Fixed \d+\..* |
+        | commit_message_negative_regex  | string         | no       | No commit message is allowed to match this, e.g. ssh\:\/\/ |
+        | branch_name_regex              | string         | no       | All branch names must match this, e.g. (feature|hotfix)\/* |
+        | author_email_regex             | string         | no       | All commit author emails must match this, e.g. @my-company.com$ |
+        | file_name_regex                | string         | no       | All committed filenames must **not** match this, e.g. (jar|exe)$ |
+        | max_file_size                  | integer        | no       | Maximum file size (MB) |
+        | commit_committer_check         | boolean        | no       | Users can only push commits to this repository that were committed with one of their own verified emails. |
+        | reject_unsigned_commits        | boolean        | no       | Reject commit when it is not signed through GPG. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.push_rules_update(deny_delete_tag: true)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via PushRule [Params]'
+      example <<~DOC
+        rule = client.projects.push_rules.show(16)
+        rule.update(deny_delete_tag: true)
+      DOC
+    end
+
+    def update(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/push_rule", PushRule, query)
+    end
+  end
+end