labclient 0.1.0

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

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

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

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectLabels < Common
+    doc 'Create' do
+      desc 'Creates a new label for the given repository with the given name and color. [Project ID, Hash]'
+      example <<~DOC
+        client.projects.labels.create(16, name: :feature, color: :green)
+      DOC
+
+      result '=> #<ProjectLabel 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 Project [Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        label = project.label_create(name: :bug, color: :red)
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/labels", ProjectLabel, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectLabels < Common
+    doc 'List' do
+      desc 'Get all labels for a given project. [Project ID]'
+      example 'client.projects.labels.list(16)'
+
+      result <<~DOC
+        => [#<ProjectLabel 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 Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.labels
+      DOC
+    end
+
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/labels", ProjectLabel, query)
+    end
+  end
+end

data/lib/labclient/projects/labels/project_label.rb

@@ -0,0 +1,56 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectLabel < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectLabel id: #{id}, name: #{name}>"
+    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.labels.update(project_id, id, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.labels.delete(project_id, id)
+    end
+
+    def promote
+      project_id = collect_project_id
+
+      client.projects.labels.promote(project_id, id)
+    end
+
+    def subscribe
+      project_id = collect_project_id
+
+      client.projects.labels.subscribe(project_id, id)
+    end
+
+    def unsubscribe
+      project_id = collect_project_id
+
+      client.projects.labels.unsubscribe(project_id, id)
+    end
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectLabel'
+      option 'project', 'Show Project'
+      option 'update', 'Update this label [Hash]'
+      option 'delete', 'Delete this label'
+      option 'promote', 'Promote this label'
+      option 'subscribe', 'Subscribe to label notifications'
+      option 'unsubscribe', 'Unsubscribe to label notifications'
+    end
+  end
+end

data/lib/labclient/projects/labels/promote.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectLabels < Common
+    doc 'Promote' do
+      desc 'Promotes a project label to a group label. [Project ID, Label ID]'
+      example 'client.projects.labels.promote(16, 7)'
+
+      result '=> #<ProjectLabel id: 7, name: switchy>'
+    end
+
+    doc 'Promote' do
+      desc 'Via Project [Label ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        label = project.label_promote(7)
+      DOC
+    end
+
+    doc 'Promote' do
+      desc 'Via ProjectLabel'
+      example <<~DOC
+        label = client.projects.labels.show(16, 7)
+        label.promote
+      DOC
+    end
+
+    def promote(project_id, label_id)
+      project_id = format_id(project_id)
+      label_id = format_id(label_id)
+
+      client.request(:put, "projects/#{project_id}/labels/#{label_id}/promote", ProjectLabel)
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectLabels < Common
+    doc 'Show' do
+      desc 'Get a single label for a given project. [Project ID, Label ID]'
+      example 'client.projects.labels.show(16, 7)'
+
+      result '=>  #<ProjectLabel 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 Project [Label ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        label = project.label(7)
+      DOC
+    end
+
+    def show(project_id, label_id, query = {})
+      project_id = format_id(project_id)
+      label_id = format_id(label_id)
+
+      client.request(:get, "projects/#{project_id}/labels/#{label_id}", ProjectLabel, query)
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectLabels < 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. [Project ID, Label ID, Hash]'
+      example 'client.projects.labels.update(16, 7, new_name: "planet bob")'
+
+      result '=> #<ProjectLabel 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 Project [Label ID, Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        label = project.label_update(7, new_name: "another")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectLabel [Hash]'
+      example <<~DOC
+        label = client.projects.labels.show(16, 7)
+        label.update(new_name: "switchy")
+      DOC
+    end
+
+    def update(project_id, label_id, query)
+      project_id = format_id(project_id)
+      label_id = format_id(label_id)
+
+      client.request(:put, "projects/#{project_id}/labels/#{label_id}", ProjectLabel, query)
+    end
+  end
+end

data/lib/labclient/projects/languages.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Show' do
+      title 'Languages'
+      desc 'Get languages used in a project with percentage value.'
+      example 'client.projects.languages(299)'
+      result <<~DOC
+        => {:Ruby=>73.41, :CSS=>15.59, :HTML=>10.72, :JavaScript=>0.28}
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.languages
+      DOC
+    end
+
+    def languages(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/languages")
+    end
+  end
+end

data/lib/labclient/projects/list.rb

@@ -0,0 +1,90 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'List' do
+      desc 'Get a list of all visible projects across GitLab for the authenticated user. '
+      example 'client.projects.list'
+      result <<~DOC
+        => [
+         #<Project id: 318, "root/middleman">,
+         #<Project id: 317, "skyrim/dwarvencenturion">,
+         #<Project id: 303, "pawnshopplanet/pibbles">,
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        | Attribute | Type | Description |
+        | --------- | ---- | ----------- |
+        | archived                    | boolean  | Limit by archived status |
+        | visibility                  | string   | Limit by visibility public, internal, or private |
+        | order_by                    | string   | Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at |
+        | sort                        | string   | Return projects sorted in asc or desc order. Default is desc |
+        | search                      | string   | Return list of projects matching the search criteria |
+        | simple                      | boolean  | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
+        | owned                       | boolean  | Limit by projects explicitly owned by the current user |
+        | membership                  | boolean  | Limit by projects that the current user is a member of |
+        | starred                     | boolean  | Limit by projects starred by the current user |
+        | statistics                  | boolean  | Include project statistics |
+        | with_custom_attributes      | boolean  | Include [custom attributes](custom_attributes.md) in response (admins only) |
+        | with_issues_enabled         | boolean  | Limit by enabled issues feature |
+        | with_merge_requests_enabled | boolean  | Limit by enabled merge requests feature |
+        | with_programming_language   | string   | Limit by projects which use the given programming language |
+        | wiki_checksum_failed        | boolean  | **(PREMIUM)** Limit projects where the wiki checksum calculation has failed |
+        | repository_checksum_failed  | boolean  | **(PREMIUM)** Limit projects where the repository checksum calculation has failed|
+        | min_access_level            | integer  | Limit by current user minimal [access level](members.md) |
+        | id_after                    | integer  | Limit results to projects with IDs greater than the specified ID |
+        | id_before                   | integer  | Limit results to projects with IDs less than the specified ID |
+      DOC
+    end
+
+    doc 'List' do
+      title 'Examples'
+      desc 'Visibility'
+      example 'client.projects.list(visibility: :public)'
+      result <<~DOC
+        => [#<Project id: 318, "root/middleman">]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Search'
+      example 'client.projects.list(search: "heal")'
+      result <<~DOC
+        => [#<Project id: 308, "badlands/heal">]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Access Level (by name)'
+      example 'client.projects.list(min_access_level: :developer)'
+      result <<~DOC
+        => [
+          #<Project id: 315 skyrim/bandit>,
+          #<Project id: 305 pawnshopplanet/molecularmanipulation>,
+          #<Project id: 302 bandlecity/thunderlordsdecree>
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Access Level (by value)'
+      example 'client.projects.list(min_access_level: 30)'
+      result <<~DOC
+        => [
+          #<Project id: 315 skyrim/bandit>,
+          #<Project id: 305 pawnshopplanet/molecularmanipulation>,
+          #<Project id: 302 bandlecity/thunderlordsdecree>
+        ]
+      DOC
+    end
+
+    # List/Search users
+    def list(query = {})
+      query_access_level(query, :min_access_level)
+      client.request(:get, 'projects', Project, query)
+    end
+  end
+end