labclient 0.1.0

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLdap < Common
+    @group_name = 'Group LDAP'
+
+    doc 'List' do
+      desc 'Lists LDAP group links. [Group ID]'
+      example 'client.groups.ldap.list(3)'
+      result '=> [#<GroupLink provider: ldapmain, level: maintainer>, ...'
+    end
+
+    doc 'List' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(96)
+        group.ldap_list
+      DOC
+    end
+
+    def list(group_id)
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/ldap_group_links", GroupLink)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupLdap < Common
+    @group_name = 'Group LDAP'
+
+    doc 'Sync' do
+      desc 'Syncs the group with its linked LDAP group. [Group ID]'
+      example 'client.groups.ldap.sync(5)'
+    end
+
+    doc 'Sync' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(3)
+        group.ldap_sync
+      DOC
+    end
+
+    def sync(group_id)
+      #   POST /groups/:id/ldap_sync
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/ldap_sync")
+    end
+  end
+end

data/lib/labclient/groups/list.rb

@@ -0,0 +1,76 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'List' do
+      desc 'Get a list of visible groups for the authenticated user [Hash]'
+
+      markdown <<~DOC
+
+        | Attribute                | Type              | Required | Description |
+        | ------------------------ | ----------------- | -------- | ---------- |
+        | skip_groups            | array of integers | no       | Skip the group IDs passed |
+        | all_available          | boolean           | no       | Show all the groups you have access to (defaults to false for authenticated users, true for admin); Attributes owned and min_access_level have precedence |
+        | search                 | string            | no       | Return the list of authorized groups matching the search criteria |
+        | order_by               | string            | no       | Order groups by name, path or id. Default is name |
+        | sort                   | string            | no       | Order groups in asc or desc order. Default is asc |
+        | statistics             | boolean           | no       | Include group statistics (admins only) |
+        | with_custom_attributes | boolean           | no       | Include custom attributes in response (admins only) |
+        | owned                  | boolean           | no       | Limit to groups explicitly owned by the current user |
+        | min_access_level       | integer           | no       | Limit to groups where current user has at least this access level |
+
+      DOC
+    end
+
+    doc 'List' do
+      title 'Examples'
+      example 'client.groups.list'
+      result <<~DOC
+        => [
+          #<Group id: 81 alphabetrium>,
+          #<Group id: 85 alphaquadrant>,
+          #<Group id: 86 argonath>,
+          #<Group id: 106 badlands>
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Owned'
+      example 'client.groups.list(owned: true)'
+      result <<~DOC
+        => [#<User id: 56, username: "rakan">]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Access Level (by name)'
+      example 'client.groups.list(min_access_level: :developer)'
+      result <<~DOC
+        => [
+          #<Group id: 61 cyrodiil>,
+          #<Group id: 102 demacia>,
+          #<Group id: 64 dimensionc137
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Access Level (by value)'
+      example 'client.groups.list(min_access_level: 30)'
+      result <<~DOC
+        => [
+          #<Group id: 61 cyrodiil>,
+          #<Group id: 102 demacia>,
+          #<Group id: 64 dimensionc137
+        ]
+      DOC
+    end
+
+    def list(query = {})
+      query_access_level(query, :min_access_level)
+
+      client.request(:get, 'groups', Group, query)
+    end
+  end
+end

data/lib/labclient/groups/milestones/burndown.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMilestones < Common
+    doc 'Show' do
+      title 'Burndown'
+      desc 'Gets all burndown chart events for a single milestone.  [Group ID, Group Milestone ID]'
+      example 'client.groups.milestones.burndown(16, 2)'
+      result <<~DOC
+        [
+          {
+            :created_at => "2020-04-17T14:39:18.827-06:00",
+                :weight => nil,
+                :action => "created"
+          }
+        ]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via the Group Group Milestone'
+      example <<~DOC
+        milestone = client.milestones.burndown(2)
+        milestone.burndown
+      DOC
+    end
+
+    # Show Specific
+    def burndown(group_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/milestones/#{milestone_id}/burndown_events")
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMilestones < Common
+    doc 'Create' do
+      desc 'Creates a new group milestone. [Group ID, Hash]'
+
+      example <<~DOC
+        client.groups.milestones.create(16, title: "Sweet Code")
+      DOC
+
+      result <<~DOC
+        => #<GroupMilestone 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(group_id, query = {})
+      group_id = format_id(group_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, "groups/#{group_id}/milestones", GroupMilestone, query)
+    end
+  end
+end

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

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

data/lib/labclient/groups/milestones/group_milestone.rb

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

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

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMilestones < Common
+    doc 'Show' do
+      title 'Issues'
+      desc 'Gets all issues assigned to a single group milestone. [Group ID, Group Milestone ID]'
+      example 'client.groups.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 GroupMilestone'
+      example <<~DOC
+        milestone = client.groups.milestones.show(16,1)
+        milestone.issues
+      DOC
+    end
+
+    def issues(group_id, milestone_id)
+      milestone_id = format_id(milestone_id)
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/milestones/#{milestone_id}/issues", Issue)
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMilestones < Common
+    doc 'List' do
+      desc 'Get a list of group milestones. [Group ID, Hash]'
+      example 'client.groups.milestones.list(16)'
+      result <<~DOC
+        => [#<GroupMilestone 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 Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.milestones
+      DOC
+    end
+
+    # List
+    def list(group_id, query = {})
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/milestones", GroupMilestone, query)
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMilestones < Common
+    doc 'Update' do
+      desc 'Updates an existing group milestone [Group ID, Group Milestone ID, Hash]'
+
+      example <<~DOC
+        client.groups.milestones.update(16, 2, title: 'Better Title')
+      DOC
+
+      result <<~DOC
+        => #<GroupMilestone 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 Group Milestone'
+      example <<~DOC
+        milestone.update(title: 'One Group Milestone to find them!')
+      DOC
+    end
+
+    def update(group_id, milestone_id, query = {})
+      milestone_id = format_id(milestone_id)
+      group_id = format_id(group_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, "groups/#{group_id}/milestones/#{milestone_id}", GroupMilestone, query)
+    end
+  end
+end

data/lib/labclient/groups/projects.rb

@@ -0,0 +1,54 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'List' do
+      title 'Projects'
+      desc 'Get a list of projects in this group [Hash]'
+
+      example 'client.groups.projects(68)'
+
+      result '=> [#<Project id: 77 fensofserech/flameatronach>, #<Project id: 76 fensofserech/sizechanging>, ... ]'
+
+      markdown <<~DOC
+
+        | Attribute                     | Type           | Required | Description |
+        | ----------------------------- | -------------- | -------- | ----------- | owned by the authenticated user |
+        | archived                    | boolean        | no       | Limit by archived status |
+        | visibility                  | string         | no       | Limit by visibility public, internal, or private |
+        | order_by                    | string         | no       | Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at |
+        | sort                        | string         | no       | Return projects sorted in asc or desc order. Default is desc |
+        | search                      | string         | no       | Return list of authorized projects matching the search criteria |
+        | simple                      | boolean        | no       | Return only the ID, URL, name, and path of each project |
+        | owned                       | boolean        | no       | Limit by projects owned by the current user |
+        | starred                     | boolean        | no       | Limit by projects starred by the current user |
+        | with_issues_enabled         | boolean        | no       | Limit by projects with issues feature enabled. Default is false |
+        | with_merge_requests_enabled | boolean        | no       | Limit by projects with merge requests feature enabled. Default is false |
+        | with_shared                 | boolean        | no       | Include projects shared to this group. Default is true |
+        | include_subgroups           | boolean        | no       | Include projects in subgroups of this group. Default is false   |
+        | min_access_level            | integer        | no       | Limit to projects where current user has at least this [access level](members.md) |
+        | with_custom_attributes      | boolean        | no       | Include [custom attributes](custom_attributes.md) in response (admins only) |
+        | with_security_reports       | boolean        | no       | Return only projects that have security reports artifacts present in any of their builds. This means "projects with security reports enabled". Default is false |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.list.last
+        group.projects
+      DOC
+    end
+
+    def projects(group_id, query = {})
+      group_id = format_id(group_id)
+
+      # Map Skip Groups
+      format_query_ids(:skip_groups, query)
+
+      query_access_level(query, :min_access_level)
+
+      client.request(:get, "groups/#{group_id}/projects", Project, query)
+    end
+  end
+end

data/lib/labclient/groups/restore.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'Delete' do
+      title 'Restore'
+      desc 'Restores a group marked for deletion. [Group ID]'
+      example 'client.groups.restore(3)'
+      result '=> #<Group id: 68, deleted>'
+    end
+
+    doc 'Delete' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.group.show(3)
+        group.restore
+      DOC
+    end
+
+    def restore(group_id)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/restore", Group)
+    end
+  end
+end

data/lib/labclient/groups/runners.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'Runners' do
+      desc 'List all runners (specific and shared) available in the group as well it’s ancestor groups. Shared runners are listed if at least one shared runner is defined. [Group ID, Hash]'
+      example 'client.groups.runners(15)'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+
+        | Attribute  | Type           | Required | Description         |
+        |------------|----------------|----------|---------------------|
+        | type     | string         | no       | The type of runners to show, one of: instance_type, group_type, project_type |
+        | status   | string         | no       | The status of runners to show, one of: active, paused, online, offline |
+        | tag_list | string array   | no       | List of of the runner's tags |
+      DOC
+    end
+
+    doc 'Runners' do
+      desc 'Via Group [Hash]'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.runners
+      DOC
+    end
+
+    def runners(group_id, query = {})
+      group_id = format_id(group_id)
+      client.request(:get, "groups/#{group_id}/runners", Runner, query)
+    end
+  end
+end

data/lib/labclient/groups/search.rb

@@ -0,0 +1,89 @@
+# Top namespace
+# Uses the '/search?scope=projects' endpoint
+module LabClient
+  # Projects Specifics
+  class Groups < Common
+    doc 'Search' do
+      desc 'Search for Group, or within the Group with scopes'
+
+      markdown <<~DOC
+        Search within Group scopes
+
+        - projects
+        - issues
+        - merge_requests
+        - milestones
+        - wiki_blobs
+        - commits
+        - blobs
+        - users
+      DOC
+    end
+
+    doc 'Search' do
+      subtitle 'Examples'
+      desc 'Search for Groups'
+      example "client.groups.search 'alpha'"
+      result '=> [#<Group id: 75, alphabetrium>, #<Group id: 97, alphaquadrant>]'
+    end
+
+    doc 'Search' do
+      desc 'Search within a group with :issues scope'
+      example "client.projects.search_within(311, :issues, 'rawr')"
+      result '=> [#<Issue id: 1, title: rawr, state: opened>]'
+    end
+
+    doc 'Search' do
+      desc 'Search within a Group with :users scope'
+      example "client.projects.search_within(311, :users, 'username')"
+      result '=>  [#<User id: 1, username: root>]'
+    end
+
+    doc 'Search' do
+      desc 'Search via Group'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.search(:issues, 'sweet search')
+      DOC
+    end
+
+    # Search All Projects
+    def search_within(group_id, scope, search_string = '')
+      group_id = format_id(group_id)
+
+      scope = scope.to_sym # Case Simplicity
+      query = { scope: scope, search: search_string }
+
+      klass = klass_type(scope)
+
+      client.request(:get, "groups/#{group_id}/search", klass, query)
+    end
+
+    # Search Groups
+    def search(search_string = '')
+      query = {
+        search: search_string
+      }
+
+      client.request(:get, 'groups', Group, query)
+    end
+
+    private
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # TODO - Finish Classes
+    def klass_type(scope)
+      case scope
+      when :projects then Project
+      when :issues then Issue
+      when :merge_requests then MergeRequest
+      when :wiki_blobs then nil # wiki_blobs
+      when :milestones then nil # ::Project::MileStone
+      when :blobs then nil # blobs
+      when :commits then Commit
+      when :users then User
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end