labclient 0.1.0

data/lib/labclient/groups/hooks/create.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupHooks < Common
+    doc 'Create' do
+      desc 'Adds a hook to a specified group. [Group ID, Hash]'
+      example 'client.groups.hooks.create(16, url: "http://labclient.com")'
+
+      result '=>  #<GroupHook id: 2, url: http://labclient.com>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | url | string | yes | The hook URL |
+        | push_events | boolean | no | Trigger hook on push events |
+        | push_events_branch_filter | string | no | Trigger hook on push events for matching branches only |
+        | issues_events | boolean | no | Trigger hook on issues events |
+        | confidential_issues_events | boolean | no | Trigger hook on confidential issues events |
+        | merge_requests_events | boolean | no | Trigger hook on merge requests events |
+        | tag_push_events | boolean | no | Trigger hook on tag push events |
+        | note_events | boolean | no | Trigger hook on note events |
+        | job_events | boolean | no | Trigger hook on job events |
+        | pipeline_events | boolean | no | Trigger hook on pipeline events |
+        | wiki_page_events | boolean | no | Trigger hook on wiki events |
+        | enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook |
+        | token | string | no | Secret token to validate received payloads; this will not be returned in the response |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Group [Hook ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        hook = group.hook_create(url: "https://dothething")
+      DOC
+    end
+
+    def create(group_id, query)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/hooks", GroupHook, query)
+    end
+  end
+end

data/lib/labclient/groups/hooks/delete.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupHooks < Common
+    doc 'Delete' do
+      desc 'Removes a hook from a group. [Group ID, Hook ID]'
+      example 'client.groups.hooks.delete(16, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Group [Hook ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.hook_delete(1)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via GroupHook'
+      example <<~DOC
+        hook = client.groups.hooks.show(16, 1)
+        hook.delete
+      DOC
+    end
+
+    def delete(group_id, hook_id)
+      group_id = format_id(group_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:delete, "groups/#{group_id}/hooks/#{hook_id}")
+    end
+  end
+end

data/lib/labclient/groups/hooks/group_hook.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupHook < Klass
+    include ClassHelpers
+    def inspect
+      "#<GroupHook id: #{id}, url: #{url}>"
+    end
+
+    def group
+      group_id = collect_group_id
+      client.groups.show group_id
+    end
+
+    def update(query)
+      group_id = collect_group_id
+
+      update_self client.groups.hooks.update(group_id, id, query)
+    end
+
+    def delete
+      group_id = collect_group_id
+
+      client.groups.hooks.delete(group_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      @group_name = 'Groups'
+      subtitle 'GroupHook'
+      option 'group', 'Show Group'
+      option 'update', 'Update this hook [Hash]'
+      option 'delete', 'Delete this hook'
+    end
+  end
+end

data/lib/labclient/groups/hooks/list.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupHooks < Common
+    doc 'List' do
+      desc 'Get a list of group hooks. [Group ID]'
+      example 'client.groups.hooks.list(16)'
+
+      result <<~DOC
+        => [
+          #<GroupHook id: 1, url: https://labclient.url>,
+          ...
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.hooks
+      DOC
+    end
+
+    def list(group_id)
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/hooks", GroupHook)
+    end
+  end
+end

data/lib/labclient/groups/hooks/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupHooks < Common
+    doc 'Show' do
+      desc 'Get a specific hook for a group. [Group ID, Hook ID]'
+      example 'client.groups.hooks.show(16, 1)'
+
+      result '=>  #<GroupHook id: 1, url: https://labclient>'
+    end
+
+    doc 'Show' do
+      desc 'Via Group [Hook ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        hook = group.hook_show(1)
+      DOC
+    end
+
+    def show(group_id, hook_id)
+      group_id = format_id(group_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:get, "groups/#{group_id}/hooks/#{hook_id}", GroupHook)
+    end
+  end
+end

data/lib/labclient/groups/hooks/update.rb

@@ -0,0 +1,55 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupHooks < Common
+    doc 'Update' do
+      desc 'Edits a hook for a specified group. [Group ID, Hook ID, Params]'
+      example 'client.groups.hooks.update(16, 1, url: "http://labclient.com")'
+
+      result '=>  #<GroupHook id: 2, url: http://labclient.com>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | url | string | yes | The hook URL |
+        | push_events | boolean | no | Trigger hook on push events |
+        | push_events_branch_filter | string | no | Trigger hook on push events for matching branches only |
+        | issues_events | boolean | no | Trigger hook on issues events |
+        | confidential_issues_events | boolean | no | Trigger hook on confidential issues events |
+        | merge_requests_events | boolean | no | Trigger hook on merge requests events |
+        | tag_push_events | boolean | no | Trigger hook on tag push events |
+        | note_events | boolean | no | Trigger hook on note events |
+        | job_events | boolean | no | Trigger hook on job events |
+        | pipeline_events | boolean | no | Trigger hook on pipeline events |
+        | wiki_page_events | boolean | no | Trigger hook on wiki events |
+        | enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook |
+        | token | string | no | Secret token to validate received payloads; this will not be returned in the response |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Group [Hook ID, Params]'
+      example <<~DOC
+        group = client.groups.show(16)
+        hook = group.hook_update(1, url: "https://dothething")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via GroupHook [Params]'
+      example <<~DOC
+        hook = client.groups.hooks.show(16, 1)
+        hook.update(url: "https://dothething")
+      DOC
+    end
+
+    def update(group_id, hook_id, query)
+      group_id = format_id(group_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:put, "groups/#{group_id}/hooks/#{hook_id}", GroupHook, query)
+    end
+  end
+end

data/lib/labclient/groups/labels/client.rb

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

data/lib/labclient/groups/labels/create.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Create' do
+      desc 'Creates a new label for the given repository with the given name and color. [Group ID, Hash]'
+      example <<~DOC
+        client.groups.labels.create(16, name: :feature, color: :green)
+      DOC
+
+      result '=> #<GroupLabel id: 3, name: feature>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute     | Type    | Required | Description                  |
+        | ------------- | ------- | -------- | ---------------------------- |
+        | name          | string  | yes      | The name of the label        |
+        | color         | string  | yes      | The color of the label given in 6-digit hex notation or CSS Color Names|
+        | description   | string  | no       | The description of the label |
+        | priority      | integer | no       | The priority of the label. Must be greater or equal than zero or null to remove the priority. |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Group [Hash]'
+      example <<~DOC
+        group = client.groups.show(16)
+        label = group.label_create(name: :bug, color: :red)
+      DOC
+    end
+
+    def create(group_id, query)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/labels", GroupLabel, query)
+    end
+  end
+end

data/lib/labclient/groups/labels/delete.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Delete' do
+      desc 'Deletes a label with a given name. [Group ID, Label ID]'
+      example 'client.groups.labels.delete(16, 7)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Group [Label ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.label_delete(7)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via GroupLabel'
+      example <<~DOC
+        label = client.groups.labels.show(16, 7)
+        label.delete
+      DOC
+    end
+
+    def delete(group_id, label_id)
+      group_id = format_id(group_id)
+      label_id = format_id(label_id)
+
+      client.request(:delete, "groups/#{group_id}/labels/#{label_id}", GroupLabel)
+    end
+  end
+end

data/lib/labclient/groups/labels/group_label.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupLabel < Klass
+    include ClassHelpers
+    def inspect
+      "#<GroupLabel id: #{id}, name: #{name}>"
+    end
+
+    def group
+      group_id = collect_group_id
+      client.groups.show group_id
+    end
+
+    def update(query)
+      group_id = collect_group_id
+
+      update_self client.groups.labels.update(group_id, id, query)
+    end
+
+    def delete
+      group_id = collect_group_id
+
+      client.groups.labels.delete(group_id, id)
+    end
+
+    def subscribe
+      group_id = collect_group_id
+
+      client.groups.labels.subscribe(group_id, id)
+    end
+
+    def unsubscribe
+      group_id = collect_group_id
+
+      client.groups.labels.unsubscribe(group_id, id)
+    end
+
+    help do
+      @group_name = 'Groups'
+      subtitle 'GroupLabel'
+      option 'group', 'Show Group'
+      option 'update', 'Update this label [Hash]'
+      option 'delete', 'Delete this label'
+      option 'subscribe', 'Subscribe to label notifications'
+      option 'unsubscribe', 'Unsubscribe to label notifications'
+    end
+  end
+end

data/lib/labclient/groups/labels/list.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'List' do
+      desc 'Get all labels for a given group. [Group ID]'
+      example 'client.groups.labels.list(16)'
+
+      result <<~DOC
+        => [#<GroupLabel id: 2, name: feature>, ...]
+      DOC
+
+      markdown <<~DOC
+        | Attribute               | Type           | Description                                                                  |
+        | ---------               | -------        | ---------------------                                                        |
+        | with_counts             | boolean        | Whether or not to include issue and merge request counts. Defaults to false. |
+        | include_ancestor_groups | boolean        | Include ancestor groups. Defaults to true.                                   |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.labels
+      DOC
+    end
+
+    def list(group_id, query = {})
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/labels", GroupLabel, query)
+    end
+  end
+end

data/lib/labclient/groups/labels/show.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Show' do
+      desc 'Get a single label for a given group. [Group ID, Label ID]'
+      example 'client.groups.labels.show(16, 7)'
+
+      result '=>  #<GroupLabel id: 2, name: feature>'
+
+      markdown <<~DOC
+        | Attribute               | Type    | Description                                                                  |
+        | ---------               | ------- | ---------------------                                                        |
+        | with_counts             | boolean | Whether or not to include issue and merge request counts. Defaults to false. |
+        | include_ancestor_groups | boolean | Include ancestor groups. Defaults to true.                                   |
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Group [Label ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        label = group.label(7)
+      DOC
+    end
+
+    def show(group_id, label_id, query = {})
+      group_id = format_id(group_id)
+      label_id = format_id(label_id)
+
+      client.request(:get, "groups/#{group_id}/labels/#{label_id}", GroupLabel, query)
+    end
+  end
+end

data/lib/labclient/groups/labels/subscribe.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Subscribe' do
+      desc 'Subscribes the authenticated user to a label to receive notifications [Group ID, Label ID]'
+      example 'client.groups.labels.subscribe(16, 7)'
+
+      result '=> #<GroupLabel id: 7, name: switchy>'
+    end
+
+    doc 'Subscribe' do
+      desc 'Via Group [Label ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        label = group.label_subscribe(7)
+      DOC
+    end
+
+    doc 'Subscribe' do
+      desc 'Via GroupLabel'
+      example <<~DOC
+        label = client.groups.labels.show(16,7)
+        label.subscribe
+      DOC
+    end
+
+    def subscribe(group_id, label_id)
+      group_id = format_id(group_id)
+      label_id = format_id(label_id)
+
+      client.request(:post, "groups/#{group_id}/labels/#{label_id}/subscribe", GroupLabel)
+    end
+  end
+end

data/lib/labclient/groups/labels/unsubscribe.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Unsubscribe' do
+      desc 'Unsubscribes the authenticated user from a label to not receive notifications from it [Group ID, Label ID]'
+      example 'client.groups.labels.unsubscribe(16, 7)'
+
+      result '=> #<GroupLabel id: 7, name: switchy>'
+    end
+
+    doc 'Unsubscribe' do
+      desc 'Via Group [Label ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.label_subscribe(7)
+      DOC
+    end
+
+    doc 'Unsubscribe' do
+      desc 'Via GroupLabel'
+      example <<~DOC
+        label = client.groups.labels.show(16,7)
+        label.unsubscribe
+      DOC
+    end
+
+    def unsubscribe(group_id, label_id)
+      group_id = format_id(group_id)
+      label_id = format_id(label_id)
+
+      client.request(:post, "groups/#{group_id}/labels/#{label_id}/unsubscribe", GroupLabel)
+    end
+  end
+end

data/lib/labclient/groups/labels/update.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLabels < Common
+    doc 'Update' do
+      desc 'Updates an existing label with new name or new color. At least one parameter is required, to update the label. [Group ID, Label ID, Hash]'
+      example 'client.groups.labels.update(16, 7, new_name: "planet bob")'
+
+      result '=> #<GroupLabel id: 7, name: planet bob>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute     | Type    | Required | Description                  |
+        | ------------- | ------- | -------- | ---------------------------- |
+        | new_name      | string  | yes      | The name of the label        |
+        | color         | string  | yes      | The color of the label given in 6-digit hex notation or CSS Color Names|
+        | description   | string  | no       | The description of the label |
+        | priority      | integer | no       | The priority of the label. Must be greater or equal than zero or null to remove the priority. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Group [Label ID, Hash]'
+      example <<~DOC
+        group = client.groups.show(16)
+        label = group.label_update(7, new_name: "another")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via GroupLabel [Hash]'
+      example <<~DOC
+        label = client.groups.labels.show(16, 7)
+        label.update(new_name: "switchy")
+      DOC
+    end
+
+    def update(group_id, label_id, query)
+      group_id = format_id(group_id)
+      label_id = format_id(label_id)
+
+      client.request(:put, "groups/#{group_id}/labels/#{label_id}", GroupLabel, query)
+    end
+  end
+end

data/lib/labclient/groups/ldap/client.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupLdap < Common
+    @group_name = 'Group LDAP'
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    def ldap
+      GroupLdap.new(client)
+    end
+  end
+end

data/lib/labclient/groups/ldap/create.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLdap < Common
+    @group_name = 'Group LDAP'
+
+    doc 'Create' do
+      desc 'Adds an LDAP group link. [Group ID, Hash]'
+      example 'client.groups.ldap.create(5, cn: "admins", group_access: :developer, provider: :ldapmain)'
+      result '=> #<GroupLink provider: ldapmain, level: developer'
+
+      markdown <<~DOC
+        | Param        | Description  |
+        |--------------|----------------|
+        | cn           | The CN of a LDAP group |
+        | group_access | Minimum access level for members of the LDAP group, number or name |
+        | provider     | LDAP provider for the LDAP group |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(96)
+        group.ldap_create(cn: "admins", group_access: :developer, provider: :ldapmain)
+      DOC
+    end
+
+    def create(group_id, query)
+      group_id = format_id(group_id)
+      query_access_level(query, :group_access)
+      client.request(:post, "groups/#{group_id}/ldap_group_links", GroupLink, query)
+    end
+  end
+end

data/lib/labclient/groups/ldap/delete.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLdap < Common
+    @group_name = 'Group LDAP'
+
+    doc 'Delete' do
+      desc 'Deletes an LDAP group link. [Group ID, CN, Provider(optional)]'
+      example 'client.groups.ldap.delete(5, "admin")'
+
+      markdown <<~DOC
+        | Param        | Description  |
+        |--------------|----------------|
+        | cn           | The CN of a LDAP group |
+        | group_access | Minimum access level for members of the LDAP group, number or name |
+        | provider     | LDAP provider for the LDAP group |
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(96)
+        group.ldap_delete("admins", :ldapmain)
+      DOC
+    end
+
+    def delete(group_id, name, provider = nil)
+      group_id = format_id(group_id)
+      if provider
+        client.request(:delete, "groups/#{group_id}/ldap_group_links/#{provider}/#{name}")
+      else
+        client.request(:delete, "groups/#{group_id}/ldap_group_links/#{name}")
+      end
+    end
+  end
+end

data/lib/labclient/groups/ldap/link.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupLink < Klass
+    include AccessLevel
+    include ClassHelpers
+    @group_name = 'Group LDAP'
+
+    def inspect
+      "#<GroupLink provider: #{provider}, level: #{access_level}>"
+    end
+
+    def access_level
+      human_access_level group_access
+    end
+  end
+end