labclient 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79977702325d9d9a7df2569a8e1e948db351fc35deea828a832a548048efa7b3
+  data.tar.gz: 1febe4b7a2eab857c37fc814b299678a35c86be61c8d346806c5d8092ea154af
+SHA512:
+  metadata.gz: 14eabf457805cece5387012fcd28ae9922ce554a6981aa21653d98404b274e6438b49686e0b6a7f8f3dbd14f16520089c58141ff08f2310c5314b52d31facc6c
+  data.tar.gz: 93b298936e970390a1886e03ddb4473d57df7adcfe75be983770fe09d5674cd5544776abd239c02c11a9ab93445aeee10c77fcb7cd2236e884174d844eec4e9b

data/lib/labclient/access_levels.rb

@@ -0,0 +1,47 @@
+# Top Namesapce
+module LabClient
+  # Shared Methods
+  module AccessLevel
+    def human_access_level(level = 10)
+      case level
+      when 0 then :none
+      when 10 then :guest
+      when 20 then :reporter
+      when 30 then :developer
+      when 40 then :maintainer
+      when 50 then :owner
+      when 60 then :admin
+      end
+    end
+
+    def machine_access_level(level = :developer)
+      case level
+      when :none then 0
+      when :guest then 10
+      when :reporter then 20
+      when :developer then 30
+      when :maintainer then 40
+      when :owner then 50
+      when :admin then 60
+      end
+    end
+
+    def machine_protected_access_level(level = :developer)
+      case level
+      when :none then 0
+      when :developer then 30
+      when :maintainer then 40
+      when :admin then 60
+      end
+    end
+
+    def human_protected_access_level(level = 10)
+      case level
+      when 0 then :none
+      when 30 then :developer
+      when 40 then :maintainer
+      when 60 then :admin
+      end
+    end
+  end
+end

data/lib/labclient/appearance/appearance.rb

@@ -0,0 +1,7 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Appearance < Klass
+    include ClassHelpers
+  end
+end

data/lib/labclient/appearance/show.rb

@@ -0,0 +1,19 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Appearances < Common
+    @group_name = 'Appearance'
+
+    doc 'Show' do
+      desc 'List the current appearance configuration of the GitLab instance.'
+      example 'client.appearance.show'
+      result <<~DOC
+        => => {:title=>"", :description=>"", :logo=>nil, :header_logo=>nil, :favicon=>nil, :new_project_guidelines=>"", :header_message=>"", :footer_message=>"", :message_background_color=>"#E75E40", :message_font_color=>"#FFFFFF", :email_header_and_footer_enabled=>false}
+      DOC
+    end
+
+    def show
+      client.request(:get, 'application/appearance', Appearance)
+    end
+  end
+end

data/lib/labclient/appearance/update.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Appearances < Common
+    @group_name = 'Appearance'
+
+    doc 'Update' do
+      desc 'Use an API call to modify GitLab instance appearance configuration.'
+      example 'client.appearance.update(title: "Gitlaaaab!")'
+      result <<~DOC
+        => {:title=>"Gitlaaaab!", :description=>"", :logo=>nil, :header_logo=>nil, :favicon=>nil, :new_project_guidelines=>"", :header_message=>"", :footer_message=>"", :message_background_color=>"#E75E40", :message_font_color=>"#FFFFFF", :email_header_and_footer_enabled=>false}
+      DOC
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute                         | Type    | Required | Description |
+        | --------------------------------- | ------- | -------- | ----------- |
+        | title                           | string  | no       | Instance title on the sign in / sign up page
+        | description                     | string  | no       | Markdown text shown on the sign in / sign up page
+        | logo                            | mixed   | no       | Instance image used on the sign in / sign up page
+        | header_logo                     | mixed   | no       | Instance image used for the main navigation bar
+        | favicon                         | mixed   | no       | Instance favicon in .ico/.png format
+        | new_project_guidelines          | string  | no       | Markdown text shown on the new project page
+        | header_message                  | string  | no       | Message within the system header bar
+        | footer_message                  | string  | no       | Message within the system footer bar
+        | message_background_color        | string  | no       | Background color for the system header / footer bar
+        | message_font_color              | string  | no       | Font color for the system header / footer bar
+        | email_header_and_footer_enabled | boolean | no       | Add header and footer to all outgoing emails if enabled
+      DOC
+    end
+
+    def update(query = {})
+      client.request(:put, 'application/appearance', Appearance, query)
+    end
+  end
+end

data/lib/labclient/application_settings/application_setting.rb

@@ -0,0 +1,10 @@
+module LabClient
+  # Inspect Helper
+  class ApplicationSetting < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Application Settings id: #{id}>"
+    end
+  end
+end

data/lib/labclient/application_settings/show.rb

@@ -0,0 +1,52 @@
+module LabClient
+  # Apllication Settings Specifics
+  class ApplicationSettings < Common
+    doc 'Show' do
+      title 'Get current settings'
+      desc 'List the current application settings of the GitLab instance'
+      example 'client.application_settings.show'
+      result <<~DOC
+        => #<Application Settings - id: 1>
+      DOC
+    end
+
+    doc 'Show' do
+      title 'Show current settings'
+      desc 'Uses built in awesome print to show all current settings.'
+      example <<~DOC
+        settings = client.application_settings.show
+        settings.verbose
+      DOC
+      result <<~DOC
+        => LabClient::ApplicationSetting {
+                                                             :id => 1,
+                               :performance_bar_allowed_group_id => nil,
+                                       :admin_notification_email => nil,
+                                            :after_sign_out_path => "",
+                                             :after_sign_up_text => "",
+                                                :akismet_api_key => nil,
+                                                :akismet_enabled => false,
+               :allow_local_requests_from_web_hooks_and_services => false,
+                         :allow_local_requests_from_system_hooks => true,
+                               :dns_rebinding_protection_enabled => true,
+                               ...
+      DOC
+    end
+
+    doc 'Show' do
+      title 'Show a single setting'
+      example <<~DOC
+        settings = client.application_settings.show
+        settings.sign_in_text
+      DOC
+      result <<~DOC
+        => "I love GitLab!"
+      DOC
+    end
+
+    # Show Settings
+    def show
+      client.request(:get, 'application/settings', ApplicationSetting)
+    end
+  end
+end

data/lib/labclient/application_settings/update.rb

@@ -0,0 +1,53 @@
+module LabClient
+  # Application Specifics
+  class ApplicationSettings < Common
+    doc 'Update' do
+      title 'Update a single setting'
+      example <<~DOC
+        client.application_settings.update(sign_in_text: "This is a test")
+      DOC
+      result <<~DOC
+        => #<Application Settings - id: 1>
+      DOC
+    end
+
+    doc 'Update' do
+      title 'Update multiple settings'
+      example <<~DOC
+        client.application_settings.update(sign_in_text: "This is a test", signup_enabled: true)
+      DOC
+      result <<~DOC
+        => #<Application Settings - id: 1>
+      DOC
+    end
+
+    doc 'Update' do
+      title 'Attributes'
+      markdown <<~DOC
+        Please see [here for a full list](https://docs.gitlab.com/ee/api/settings.html#list-of-settings-that-can-be-accessed-via-api-calls) of all attributes.
+
+        | Attribute | Type | Required |
+        | --------- | ---- | :------: |
+        | admin_notification_email             | string           | no                                |
+        | after_sign_out_path                    | string           | no                             |
+        | after_sign_up_text                     | string           | no                            |
+        | akismet_api_key                        | string           | required by: akismet_enabled |
+        | akismet_enabled                        | boolean          | no           |
+        | allow_group_owners_to_manage_ldap      | boolean          | no          |
+        | allow_local_requests_from_hooks_and_services | boolean    | no         |
+        | allow_local_requests_from_system_hooks | boolean    | no              |
+        | allow_local_requests_from_web_hooks_and_services | boolean    | no   |
+        | archive_builds_in_human_readable       | string           | no                                    |
+        | asset_proxy_enabled                    | boolean          | no                                   |
+        | asset_proxy_secret_key                 | string           | no                                   |
+        | asset_proxy_url                        | string           | no                                   |
+        | asset_proxy_whitelist                  | string or array of strings | no                         |
+      DOC
+    end
+
+    # Update Settings
+    def update(query)
+      client.request(:put, 'application/settings', ApplicationSetting, query)
+    end
+  end
+end

data/lib/labclient/application_statistics/application_statistics.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ApplicationStatistics < Common
+    doc 'Show' do
+      desc 'List the current statistics of the GitLab instance. You have to be an administrator in order to perform this action.'
+      example 'client.markdown.render(text: "# Oh Hi!")'
+      result <<~DOC
+        => {:forks=>"0", :issues=>"6,683", :merge_requests=>"0", :notes=>"0", :snippets=>"0", :ssh_keys=>"1", :milestones=>"0", :users=>"56", :projects=>"298", :groups=>"48", :active_users=>"56"}
+      DOC
+    end
+
+    def show
+      client.request(:get, 'application/statistics')
+    end
+  end
+end

data/lib/labclient/applications/application.rb

@@ -0,0 +1,19 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Application < Klass
+    include ClassHelpers
+    def inspect
+      "#<Application id: #{id}, #{application_name}>"
+    end
+
+    def delete
+      client.applications.delete id
+    end
+
+    help do
+      subtitle 'Application'
+      option 'delete', 'Delete this specific application.'
+    end
+  end
+end

data/lib/labclient/applications/create.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Applications < Common
+    doc 'Create' do
+      desc 'Register a new Application'
+      markdown <<~DOC
+        | Attribute      | Description                      |
+        |--------------- |--------------------------------- |
+        | name         | Name of the application.         |
+        | redirect_uri | Redirect URI of the application. |
+        | scope        | Scope of the application.       |
+
+        > **Scopes** - api, email, openid, profile, read_registry, read_repository, read_user, sudo, write_repository
+      DOC
+    end
+
+    doc 'Create' do
+      example <<~DOC
+        client.applications.create(
+          name: "Grafana",
+          redirect_uri: "https://gitlab.com/-/grafana/login/gitlab",
+          scopes: "email"
+        )
+      DOC
+      result <<~DOC
+        #<Application id: 11, Grafana>
+      DOC
+    end
+
+    # Create
+    def create(query = {})
+      client.request(:post, 'applications', Application, query)
+    end
+  end
+end

data/lib/labclient/applications/delete.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Applications < Common
+    doc 'Delete' do
+      markdown 'Can delete via the `applications` or via the `Application` object'
+    end
+
+    doc 'Delete' do
+      desc 'Delete through applications'
+      example <<~DOC
+        client.applications.delete(11)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Delete through result object'
+      example <<~DOC
+        application.delete
+      DOC
+
+      result <<~DOC
+        application = client.applications.list.last
+        => #<Application id: 8, Grafana>
+        application.delete
+        => nil
+      DOC
+    end
+
+    # Delete
+    def delete(application_id = nil)
+      client.request(:delete, "applications/#{application_id}")
+    end
+  end
+end

data/lib/labclient/applications/list.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Applications < Common
+    doc 'List' do
+      desc 'List'
+      example 'client.applications.list'
+      result <<~DOC
+        => [#<Application id: 1, GitLab Grafana>, #<Application id: 4, OAuth>]
+      DOC
+    end
+
+    # List
+    def list(query = {})
+      client.request(:get, 'applications', Application, query)
+    end
+  end
+end

data/lib/labclient/approvals/client.rb

@@ -0,0 +1,16 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Approvals < Common
+    @group_name = 'Approvals'
+    include ClassHelpers
+
+    def project
+      ProjectApprovals.new(client)
+    end
+
+    def merge_request
+      MergeRequestApprovals.new(client)
+    end
+  end
+end

data/lib/labclient/approvals/merge_approval.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class MergeApproval < Klass
+    @group_name = 'Approvals'
+    include ClassHelpers
+
+    def inspect
+      "#<MergeApproval iid: #{iid}, title: #{title}>"
+    end
+
+    date_time_attrs %i[created_at updated_at]
+
+    def approved_by
+      @table[:approved_by].map do |user_data|
+        User.new(user_data, response, client)
+      end
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/approve.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Approve'
+      desc 'Approve Merge Request. [Project ID, MergeRequest ID, Hash]'
+      example 'client.approvals.merge_request.approve(1,2)'
+      result '=> #<MergeApproval iid: 2, title: Add new file>'
+      markdown <<~DOC
+
+        **Parameters:**
+
+        | Attribute           | Type    | Required | Description             |
+        |---------------------|---------|----------|-------------------------|
+        | sha               | string  | no       | The HEAD of the MR      |
+        | approval_password | string  | no      | Current user's password. Required if **Require user password to approve** is enabled in the project settings. |
+      DOC
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        mr.approve
+      DOC
+    end
+
+    def approve(project_id, merge_request_iid, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_iid}/approve", MergeApproval, query)
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/create_rule.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Create Rule'
+      desc 'Create Merge Request approval rules. [Project ID, MergeRequest ID, Hash]'
+      example 'client.approvals.merge_request.create_rule(1,1, name: "Sanity Check", approvals_required: 2, user_ids: [2])'
+      result '#<ApprovalRule id: 2, name: Sanity Check>'
+      markdown <<~DOC
+
+        **Parameters:**
+
+        | Attribute              | Type    | Required | Description                                                      |
+        |------------------------|---------|----------|------------------------------------------------------------------|
+        | name                 | string  | yes      | The name of the approval rule                                    |
+        | approvals_required   | integer | yes      | The number of required approvals for this rule                   |
+        | user_ids             | Array   | no       | The ids of users as approvers                                    |
+        | group_ids            | Array   | no       | The ids of groups as approvers                                   |
+        | protected_branch_ids | Array   | no       | The ids of protected branches to scope the rule by |
+      DOC
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        mr.approvals_rule_create(name: "Sanity Check", approvals_required: 2)
+      DOC
+    end
+
+    def create_rule(project_id, merge_request_iid, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_iid}/approval_rules", ApprovalRule, query)
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/delete_rule.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Delete Rule'
+      desc 'Delete MergeRequest approval rule. [Project ID, MergeRequest ID, Rule ID]'
+      example 'client.approvals.merge_request.delete_rule(1, 2)'
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        merge_request.approvals_rule_delete(2)
+      DOC
+    end
+
+    def delete_rule(project_id, merge_request_iid, approval_rule_id)
+      project_id = format_id(project_id)
+      merge_request_iid = format_id(merge_request_iid)
+      approval_rule_id = format_id(approval_rule_id)
+      client.request(:delete, "projects/#{project_id}/merge_requests/#{merge_request_iid}/approval_rules/#{approval_rule_id}")
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/rules.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Rules'
+      desc 'Show Merge Request approval rules. [Project ID, MergeRequest IIU]'
+      example 'client.approvals.merge_request.rules(1,1)'
+      result '[#<ApprovalRule id: 1, name: All Members>, #<ApprovalRule id: 2, name: Sanity Check>]'
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.rules(1,1)
+        mr.approvals
+      DOC
+    end
+
+    def rules(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}/approval_rules", ApprovalRule)
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Show'
+      desc 'Show Merge Request approval configuration. [Project ID, MergeRequest IID]'
+      example 'client.approvals.merge_request.show(1, 1)'
+      result '#<MergeApproval iid: 1, title: Update README.md>'
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        mr.approvals
+      DOC
+    end
+
+    def show(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}/approvals", MergeApproval)
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/unapprove.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Unapprove'
+      desc 'Unapprove Merge Request. [Project ID, MergeRequest ID, Hash]'
+      example 'client.approvals.merge_request.approve(1,2)'
+      result '=> #<MergeApproval iid: 2, title: Add new file>'
+      markdown <<~DOC
+
+        **Parameters:**
+
+        | Attribute           | Type    | Required | Description             |
+        |---------------------|---------|----------|-------------------------|
+        | sha               | string  | no       | The HEAD of the MR      |
+        | approval_password | string  | no      | Current user's password. Required if **Require user password to approve** is enabled in the project settings. |
+      DOC
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        mr.unapprove
+      DOC
+    end
+
+    def unapprove(project_id, merge_request_iid)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_iid}/unapprove", MergeApproval)
+    end
+  end
+end

data/lib/labclient/approvals/merge_request/update.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Update'
+      desc 'Change approval configuration [Project ID, MergeRequest IID, Approvals Required]'
+      example 'client.approvals.merge_request.update(1, 1, 3)'
+      result '#<MergeApproval iid: 1, title: Update README.md>'
+    end
+
+    doc 'MergeRequest' do
+      desc 'Via MergeRequest'
+      example <<~DOC
+        mr = client.merge_requests.show(1,1)
+        mr.approval_update(4)
+      DOC
+    end
+
+    def update(project_id, merge_request_iid, approvals_required)
+      project_id = format_id(project_id)
+      merge_request_iid = format_id(merge_request_iid)
+      query = { approvals_required: approvals_required }
+      client.request(:post, "projects/#{project_id}/merge_requests/#{merge_request_iid}/approvals", MergeApproval, query)
+    end
+  end
+end