labclient 0.1.0

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

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class MergeRequestApprovals < Common
+    @group_name = 'Approvals'
+    doc 'MergeRequest' do
+      title 'Update Rule'
+      desc 'Update Merge Request approval rule. [Project ID, MergeRequest ID, Rule ID, Hash]'
+      example 'client.approvals.merge_request.update_rule(1, 2, name: "Checky Check", approvals_required: 3)'
+      result '#<ApprovalRule id: 2, name: Checky Check>'
+      markdown <<~DOC
+        **Parameters:**
+
+        | Attribute              | Type    | Required | Description                                                      |
+        |------------------------|---------|----------|------------------------------------------------------------------|
+        | approval_rule_id     | integer | yes      | The ID of a approval rule                                        |
+        | 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_update(1, name: "Sanity Check", approvals_required: 2)
+      DOC
+    end
+
+    def update_rule(project_id, merge_request_iid, approval_rule_id, query = {})
+      project_id = format_id(project_id)
+      merge_request_iid = format_id(merge_request_iid)
+      approval_rule_id = format_id(approval_rule_id)
+      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_iid}/approval_rules/#{approval_rule_id}", ApprovalRule, query)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectApprovals < Common
+    @group_name = 'Approvals'
+    doc 'Project' do
+      title 'Create Rule'
+      desc 'Create project approval rules. [Project ID, Hash]'
+      example 'client.approvals.project.create_rule(1, name: "Sanity Check", approvals_required: 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 'Project' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.approvals_rule_create(name: "Sanity Check", approvals_required: 2)
+      DOC
+    end
+
+    def create_rule(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/approval_rules", ApprovalRule, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectApprovals < Common
+    @group_name = 'Approvals'
+    doc 'Project' do
+      title 'Rules'
+      desc 'Show project approval rules. [Project ID]'
+      example 'client.approvals.project.rules(1)'
+      result '[#<ApprovalRule id: 1, name: Root>]'
+    end
+
+    doc 'Project' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.approval_rules
+      DOC
+    end
+
+    def rules(project_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/approval_rules", ApprovalRule)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectApprovals < Common
+    @group_name = 'Approvals'
+    doc 'Project' do
+      title 'Show'
+      desc 'Show project’s approval configuration. [Project ID]'
+      example 'client.approvals.project.show(1)'
+      result <<~DOC
+        {
+                                  approvals_before_merge: 0,
+                                         approver_groups: [],
+                                               approvers: [],
+          disable_overriding_approvers_per_merge_request: nil,
+                          merge_requests_author_approval: nil,
+              merge_requests_disable_committers_approval: nil,
+                             require_password_to_approve: nil,
+                                 reset_approvals_on_push: true
+        }
+
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.approvals
+      DOC
+    end
+
+    def show(project_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/approvals")
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectApprovals < Common
+    @group_name = 'Approvals'
+    doc 'Project' do
+      title 'Update'
+      desc 'Change approval configuration [Project ID, Hash]'
+      example 'client.approvals.project.update(1, reset_approvals_on_push: true)'
+      result <<~DOC
+        {
+                                  approvals_before_merge: 0,
+                                         approver_groups: [],
+                                               approvers: [],
+          disable_overriding_approvers_per_merge_request: nil,
+                          merge_requests_author_approval: nil,
+              merge_requests_disable_committers_approval: nil,
+                             require_password_to_approve: nil,
+                                 reset_approvals_on_push: true
+        }
+
+      DOC
+
+      markdown <<~DOC
+
+        **Parameters:**
+
+        | Attribute                                        | Type    | Required | Description                                                                                         |
+        | ------------------------------------------------ | ------- | -------- | --------------------------------------------------------------------------------------------------- |
+        | approvals_before_merge                         | integer | no       | How many approvals are required before an MR can be merged. Deprecated in 12.0 in favor of Approval Rules API. |
+        | reset_approvals_on_push                        | boolean | no       | Reset approvals on a new push                                                                       |
+        | disable_overriding_approvers_per_merge_request | boolean | no       | Allow/Disallow overriding approvers per MR                                                          |
+        | merge_requests_author_approval                 | boolean | no       | Allow/Disallow authors from self approving merge requests; true means authors cannot self approve |
+        | merge_requests_disable_committers_approval     | boolean | no       | Allow/Disallow committers from self approving merge requests                                        |
+        | require_password_to_approve                    | boolean | no       | Require approver to enter a password in order to authenticate before adding the approval         |
+
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.approvals_update(require_password_to_approve: true)
+      DOC
+    end
+
+    def update(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/approvals", nil, query)
+    end
+  end
+end

data/lib/labclient/approvals/project/update_rule.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectApprovals < Common
+    @group_name = 'Approvals'
+    doc 'Project' do
+      title 'Update Rule'
+      desc 'Update project approval rule. [Project ID, Rule ID, Hash]'
+      example 'client.approvals.project.update_rule(1, 2, name: "Checky Check", approvals_required: 3)'
+      result '#<ApprovalRule id: 2, name: Checky Check>'
+      markdown <<~DOC
+        **Parameters:**
+
+        | Attribute              | Type    | Required | Description                                                      |
+        |------------------------|---------|----------|------------------------------------------------------------------|
+        | approval_rule_id     | integer | yes      | The ID of a approval rule                                        |
+        | 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 'Project' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(1)
+        project.approvals_rule_update(1, name: "Sanity Check", approvals_required: 2)
+      DOC
+    end
+
+    def update_rule(project_id, approval_rule_id, query = {})
+      project_id = format_id(project_id)
+      approval_rule_id = format_id(approval_rule_id)
+      client.request(:put, "projects/#{project_id}/approval_rules/#{approval_rule_id}", ApprovalRule, query)
+    end
+  end
+end

data/lib/labclient/approvals/rule.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ApprovalRule < Klass
+    @group_name = 'Approvals'
+    include ClassHelpers
+
+    def inspect
+      "#<ApprovalRule id: #{id}, name: #{name}>"
+    end
+
+    def eligible_approvers
+      @table[:eligible_approvers].map do |user_data|
+        User.new(user_data, response, client)
+      end
+    end
+
+    def protected_branches
+      @table[:protected_branches].map do |branch_data|
+        LabClient::Branch.new(branch_data, response, client)
+      end
+    end
+
+    def users
+      @table[:users].map do |user_data|
+        User.new(user_data, response, client)
+      end
+    end
+
+    def groups
+      @table[:groups].map do |group_data|
+        Group.new(group_data, response, client)
+      end
+    end
+  end
+end

data/lib/labclient/audit_events/audit_event.rb

@@ -0,0 +1,12 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class AuditEvent < Klass
+    include ClassHelpers
+    def inspect
+      "#<AuditEvent id: #{id}, type: #{entity_type}>"
+    end
+
+    date_time_attrs %i[created_at]
+  end
+end

data/lib/labclient/audit_events/group_list.rb

@@ -0,0 +1,63 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class AuditEvents < Common
+    doc 'Group' do
+      title 'Group List'
+      desc 'Retrive and filter group events '
+      example 'client.audit_events.group_list(15)'
+      result <<~DOC
+        => [#<AuditEvent id: 25, type: Group>]
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Description |
+        | --------- | ---- | | ----------- |
+        | created_after | string | Return audit events created on or after the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ  |
+        | created_before | string | Return audit events created on or before the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
+      DOC
+    end
+
+    doc 'Group' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both `:created_after` and `:created_before` will access Date or Time objects. (responds_to: `to_time`)
+      DOC
+
+      example <<~DOC
+        client.audit_events.group_list(80,created_after: Date.today)
+      DOC
+
+      result <<~DOC
+        => [#<AuditEvent id: 359, type: Project>]
+      DOC
+    end
+
+    doc 'Group' do
+      example <<~DOC
+        client.audit_events.group_list(80, created_before: 1.month.ago )
+      DOC
+
+      result <<~DOC
+        => [#<AuditEvent id: 24, type: Group>]
+      DOC
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(5)
+        group.audit_events
+      DOC
+    end
+
+    # List
+    def group_list(group_id, query = {})
+      query_format_time(query, :created_before)
+      query_format_time(query, :created_after)
+
+      client.request(:get, "groups/#{group_id}/audit_events", AuditEvent, query)
+    end
+  end
+end

data/lib/labclient/audit_events/group_show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class AuditEvents < Common
+    doc 'Group' do
+      title 'Group Show'
+      desc 'Retrieve single group audit event (group, audit)'
+      example 'client.audit_events.group_show(15,24)'
+      result <<~DOC
+        => #<AuditEvent id: 24, type: Group>
+      DOC
+    end
+
+    doc 'Group' do
+      title 'via Group'
+      example <<~DOC
+        group = client.group.show(5)
+        group.audit_events(24)
+      DOC
+    end
+
+    # Show
+    def group_show(group_id = nil, audit_event_id = nil)
+      client.request(:get, "groups/#{group_id}/audit_events/#{audit_event_id}", AuditEvent)
+    end
+  end
+end

data/lib/labclient/audit_events/instance_list.rb

@@ -0,0 +1,73 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class AuditEvents < Common
+    doc 'Instance' do
+      title 'List'
+      desc 'Retrive and filter instance events '
+      example 'client.audit_events.list'
+      result <<~DOC
+        => [
+            #<AuditEvent id: 372, type: User>,
+            #<AuditEvent id: 371, type: User>,
+            #<AuditEvent id: 370, type: Project>,
+            #<AuditEvent id: 369, type: Group>
+        ]
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Description |
+        | --------- | ---- | | ----------- |
+        | created_after | string | Return audit events created on or after the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ  |
+        | created_before | string | Return audit events created on or before the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
+        | entity_type | string | Return audit events for the given entity type. Valid values are: User, Group, or Project.  |
+        | entity_id | integer | Return audit events for the given entity ID. Requires entity_type attribute to be present. |
+      DOC
+    end
+
+    doc 'Instance' do
+      desc 'Filter by Type'
+      example 'client.audit_events.list(entity_type: "Group")'
+      result <<~DOC
+        => [
+            #<AuditEvent id: 369, type: Group>,
+            #<AuditEvent id: 380, type: Group>,
+        ]
+      DOC
+    end
+
+    doc 'Instance' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both `:created_after` and `:created_before` can be used with Date or Time objects. (responds_to: `to_time`)
+      DOC
+
+      example <<~DOC
+        client.audit_events.list(created_after: Date.today)
+      DOC
+
+      result <<~DOC
+        => [#<AuditEvent id: 359, type: Project>]
+      DOC
+    end
+
+    doc 'Instance' do
+      example <<~DOC
+        client.audit_events.list(created_before: 1.month.ago )
+      DOC
+
+      result <<~DOC
+        => [#<AuditEvent id: 159, type: User>]
+      DOC
+    end
+
+    # List
+    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, 'audit_events', AuditEvent, query)
+    end
+  end
+end

data/lib/labclient/audit_events/instance_show.rb

@@ -0,0 +1,19 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class AuditEvents < Common
+    doc 'Instance' do
+      title 'Show'
+      desc 'Retrieve single instance audit event'
+      example 'client.audit_events.show(50)'
+      result <<~DOC
+        => #<AuditEvent id: 50, type: Group>
+      DOC
+    end
+
+    # Show
+    def show(audit_event_id = nil)
+      client.request(:get, "audit_events/#{audit_event_id}", AuditEvent)
+    end
+  end
+end

data/lib/labclient/avatar/avatar.rb

@@ -0,0 +1,14 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Avatar < Klass
+    include ClassHelpers
+    def inspect
+      "#<Avatar url: #{avatar_url}>"
+    end
+
+    def url
+      avatar_url
+    end
+  end
+end

data/lib/labclient/avatar/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Avatars < Common
+    @group_name = 'Avatar'
+
+    doc 'Show' do
+      desc 'Get a single avatar URL for a user with the given email address.'
+      example 'client.avatar.show(email: "jeanlucpicard@example", size: 512)'
+      result <<~DOC
+        =>  #<Avatar url: https://secure.gravatar.com/avatar/1f218446d7b40a24b0eae6b741d97fe6?s=1024&d=identicon>
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description                                                                                                                             |
+        |---------- |-------- |--------- |----------------------------------------------------------------------------------------------------------------------------------------|
+        | email   | string  | yes      | Public email address of the user.                                                                                                       |
+        | size    | integer | no       | Single pixel dimension (since images are squares). Only used for avatar lookups at Gravatar or at the configured Libravatar server. |
+      DOC
+    end
+
+    # List/Search users
+    def show(query = {})
+      client.request(:get, 'avatar', Avatar, query)
+    end
+  end
+end

data/lib/labclient/awards/award.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Award < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Award id: #{id} name: #{name}>"
+    end
+
+    # DateTime Fields
+    date_time_attrs %i[created_at updated_at]
+
+    # User Fields
+    user_attrs %i[user]
+  end
+end

data/lib/labclient/awards/issues/client.rb

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

data/lib/labclient/awards/issues/create.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class IssueAwards < Common
+    doc 'Issues' do
+      title 'Create'
+      desc 'Create an award emoji [Project, Issue IID, Name]'
+      example 'client.awards.issues.create(16, 1, :blowfish)'
+      result <<~DOC
+        => #<Award id: 2 name: blowfish>
+      DOC
+    end
+
+    def create(project_id, issue_id, name)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+
+      query = { name: name }
+
+      client.request(:post, "projects/#{project_id}/issues/#{issue_id}/award_emoji", Award, query)
+    end
+  end
+end

data/lib/labclient/awards/issues/delete.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class IssueAwards < Common
+    doc 'Issues' do
+      title 'Delete'
+      desc 'Sometimes it’s just not meant to be and you’ll have to remove the award. [Project ID, Issue IID, Award ID]'
+      example 'client.awards.issues.delete(16, 2, 2)'
+    end
+
+    # Delete
+    def delete(project_id, issue_id, award_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+      award_id = format_id(award_id)
+
+      client.request(:delete, "projects/#{project_id}/issues/#{issue_id}/award_emoji/#{award_id}")
+    end
+  end
+end

data/lib/labclient/awards/issues/list.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class IssueAwards < Common
+    @group_name = 'Awards'
+    doc 'Issues' do
+      title 'List'
+      desc 'Get a list of all award emoji for a specified awardable. [Project ID, Issue IID]'
+      example 'client.awards.issues.list(16, 1)'
+      result <<~DOC
+        => [#<Award id: 2dc2a8d>, .. ]
+      DOC
+    end
+
+    def list(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}/award_emoji", Award)
+    end
+  end
+end

data/lib/labclient/awards/issues/show.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class IssueAwards < Common
+    doc 'Issues' do
+      title 'Show'
+      desc 'Get a single award emoji [Project ID, Issue IID, Award ID]'
+      example 'client.awards.issues.show(16, 1, 1)'
+      result <<~DOC
+        => #<Award id: 1 name: badminton>
+      DOC
+    end
+
+    def show(project_id, issue_id, award_id)
+      project_id = format_id(project_id)
+      issue_id = format_id(issue_id)
+      award_id = format_id(award_id)
+
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/award_emoji/#{award_id}", Award)
+    end
+  end
+end