labclient 0.1.0

data/lib/labclient/discussions/snippets/create.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SnippetDiscussions < Common
+    doc 'Snippets' do
+      title 'Create'
+      desc 'Creates a new discussion for a single merge request [Project, Snippet ID]'
+      example 'client.discussions.snippets.create(16, 2, body: "Hello!")'
+      result <<~DOC
+        => #<Discussions id: 2dc2a8d>
+      DOC
+    end
+
+    doc 'Snippets' do
+      markdown <<~DOC
+        | Attribute  | Type   | Required | Description |
+        | ---------  | ----   | -------- | ----------- |
+        | body       | string | yes | Name for Badge |
+        | created_at | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z |
+      DOC
+    end
+
+    def create(project_id, snippet_id, query = {})
+      project_id = format_id(project_id)
+      snippet_id = format_id(snippet_id)
+
+      query[:created_at] = query[:created_at].to_time.iso8601 if format_time?(query[:created_at])
+
+      client.request(:post, "projects/#{project_id}/snippets/#{snippet_id}/discussions", Discussion, query)
+    end
+  end
+end

data/lib/labclient/discussions/snippets/delete.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SnippetDiscussions < Common
+    doc 'Snippets' do
+      title 'Delete'
+      desc 'Get a single project snippet. [Project ID, Snippet ID, Discussion ID]'
+      example 'client.discussions.snippets.delete(16, 2, "7ae79")'
+    end
+
+    # Delete
+    def delete(project_id, snippet_id, discussion_id)
+      project_id = format_id(project_id)
+      snippet_id = format_id(snippet_id)
+      discussion_id = format_id(discussion_id)
+
+      client.request(:delete, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}")
+    end
+  end
+end

data/lib/labclient/discussions/snippets/list.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SnippetDiscussions < Common
+    @group_name = 'Discussions'
+    doc 'Snippets' do
+      title 'List'
+      desc 'Gets a list of all discussion items for a single snippet. [Project ID, Snippet ID]'
+      example 'client.discussions.snippets.list(16, 1)'
+      result <<~DOC
+        => [#<Discussions id: 2dc2a8d>, .. ]
+      DOC
+    end
+
+    def list(project_id, snippet_id)
+      project_id = format_id(project_id)
+      snippet_id = format_id(snippet_id)
+
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions", Discussion)
+    end
+  end
+end

data/lib/labclient/discussions/snippets/show.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SnippetDiscussions < Common
+    doc 'Snippets' do
+      title 'Show'
+      desc 'Returns a single discussion for a given merge request. [Project ID, Snippet ID, Discussion ID]'
+      example 'client.discussions.snippets.show(16, 1, "7ae79")'
+      result <<~DOC
+        => #<Discussions id: 7ae79>
+      DOC
+    end
+
+    def show(project_id, snippet_id, discussion_id)
+      project_id = format_id(project_id)
+      snippet_id = format_id(snippet_id)
+      discussion_id = format_id(discussion_id)
+
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", Discussion)
+    end
+  end
+end

data/lib/labclient/discussions/snippets/update.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SnippetDiscussions < Common
+    doc 'Snippets' do
+      title 'Update'
+      desc 'Get a single project snippet. [Project ID, Snippet ID, Discussion ID]'
+      example 'client.discussions.snippets.update(16, 1, "2dc2a8d", "Updaaate")'
+      result <<~DOC
+        => #<Discussions id: 2dc2a8d>
+      DOC
+    end
+
+    doc 'Snippets' do
+      markdown <<~DOC
+        | Attribute  | Type   | Required | Description |
+        | ---------  | ----   | -------- | ----------- |
+        | body       | string | yes | Name for Badge |
+      DOC
+    end
+
+    # Show
+    def update(project_id, snippet_id, discussion_id, body)
+      project_id = format_id(project_id)
+      snippet_id = format_id(snippet_id)
+      discussion_id = format_id(discussion_id)
+      query = { body: body }
+
+      client.request(:put, "projects/#{project_id}/snippets/#{snippet_id}/discussions/#{discussion_id}", Discussion, query)
+    end
+  end
+end

data/lib/labclient/docs.rb

@@ -0,0 +1,107 @@
+# Top Namesapce
+module LabClient
+  # Shared Methods
+  module Docs
+    # include ActionView::Helpers
+
+    @docs = {}
+
+    def self.json
+      @docs.to_json
+    end
+
+    def self.docs
+      @docs
+    end
+
+    # -------------------------------------------------------------
+    # Include Rails Sanitizer
+    # def safe_list_sanitizer
+    #   Rails::Html::SafeListSanitizer.new
+    # end
+
+    # def sanitize(html, options = {})
+    #   safe_list_sanitizer.sanitize(html, options)&.html_safe
+    # end
+    # ---------------------------------
+
+    # Klass Helper
+    def help
+      # require 'active_support/inflector'
+      @group_name ||= group_name.pluralize
+      doc 'Reference' do
+        yield
+      end
+    end
+
+    # -------------------------------------------------------------
+    # DSL Helpers
+    def title(value)
+      @result[:title] = value
+    end
+
+    def subtitle(value)
+      @result[:subtitle] = value
+    end
+
+    def markdown(value)
+      require 'kramdown' unless defined? Kramdown
+      @result[:markdown] = Kramdown::Document.new(value).to_html
+    end
+
+    def desc(value)
+      # @result[:desc] = simple_format value
+      @result[:desc] = value
+    end
+
+    def example(value)
+      @result[:example] = value
+    end
+
+    def result(value)
+      @result[:result] = value
+    end
+
+    def option(name, text)
+      @result[:options] ||= []
+      @result[:options].push(name: name, text: text)
+    end
+
+    # Allow for Custom Group Name Overrides
+    def group_name
+      @group_name || name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+    end
+
+    # Helper to Make navigation rendered out once rather than evaluated on Ember
+    def navigation(subgroup)
+      # Group
+      nav = @group.gsub(' ', '_')
+
+      # Subgroup
+      subnav = subgroup.gsub(' ', '_')
+
+      # Title
+      subnav += '_' + @result[:title].gsub(' ', '_') if @result.key? :title
+
+      @result[:nav] = nav
+      @result[:nav] += '-' + subnav if subnav
+    end
+
+    def doc(subgroup)
+      @result = {}
+      yield
+
+      # Turn Class name into friendly name. Split multiple words
+      @group = group_name
+
+      # Docs Navigation Helper
+      navigation(subgroup)
+
+      # @result[:name] = name
+      Docs.docs[@group] ||= {}
+      Docs.docs[@group][subgroup] ||= []
+      Docs.docs[@group][subgroup].push @result
+    end
+    # -------------------------------------------------------------
+  end
+end

data/lib/labclient/epics/create.rb

@@ -0,0 +1,42 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Create' do
+      desc 'Creates a new epic. [Group ID, Hash]'
+      example 'client.epics.create(59, title: "Initial Release")'
+
+      result '=>  #<Epic iid: 4, title: Initial Release>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute           | Type             | Required   | Description                                                                            |
+        | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
+        | title             | string           | yes        | The title of the epic |
+        | labels            | string           | no         | The comma separated list of labels |
+        | description       | string           | no         | The description of the epic. Limited to 1,048,576 characters.  |
+        | confidential      | boolean          | no         | Whether the epic should be confidential. Will be ignored if confidential_epics feature flag is disabled. |
+        | start_date_is_fixed | boolean        | no         | Whether start date should be sourced from start_date_fixed or from milestones (since 11.3) |
+        | start_date_fixed  | string           | no         | The fixed start date of an epic (since 11.3) |
+        | due_date_is_fixed | boolean          | no         | Whether due date should be sourced from due_date_fixed or from milestones (since 11.3) |
+        | due_date_fixed    | string           | no         | The fixed due date of an epic (since 11.3) |
+        | parent_id         | integer/string   | no         | The id of a parent epic (since 11.11) |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Group [Hash]'
+      example <<~DOC
+        group = client.groups.show(16)
+        epic = group.epic_create(url: "https://dothething")
+      DOC
+    end
+
+    def create(group_id, query)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/epics", Epic, query)
+    end
+  end
+end

data/lib/labclient/epics/delete.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Delete' do
+      desc 'Deletes an epic [Group ID, Epic IID]'
+      example 'client.epics.delete(59, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Group [Epic ID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.epic_delete(1)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(16, 1)
+        epic.delete
+      DOC
+    end
+
+    def delete(group_id, epic_id)
+      # DELETE /groups/:id/epics/:epic_iid
+
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:delete, "groups/#{group_id}/epics/#{epic_id}")
+    end
+  end
+end

data/lib/labclient/epics/epic.rb

@@ -0,0 +1,72 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Epic < Klass
+    include ClassHelpers
+    def inspect
+      "#<Epic iid: #{iid}, title: #{title}>"
+    end
+
+    # User Fields
+    user_attrs %i[author]
+
+    def group
+      client.groups.show group_id
+    end
+
+    def update(query)
+      update_self client.epics.update(group_id, iid, query)
+    end
+
+    def delete
+      client.epics.delete(group_id, iid)
+    end
+
+    def todo
+      client.epics.todo(group_id, iid)
+    end
+
+    def issues
+      client.epics.issues(group_id, iid)
+    end
+
+    def issue_add(issue_id)
+      client.epics.issue_add(group_id, iid, issue_id)
+    end
+
+    def issue_remove(issue_id)
+      client.epics.issue_remove(group_id, iid, issue_id)
+    end
+
+    def issue_update(issue_id, _query)
+      client.epics.issue_update(group_id, iid, issue_id, query)
+    end
+
+    # Resource Labels
+    def resource_labels
+      client.resource_labels.epics.list(group_id, id)
+    end
+
+    def resource_label(resource_event_id)
+      client.resource_labels.epics.show(group_id, id, resource_event_id)
+    end
+
+    date_time_attrs %i[created_at closed_at updated_at]
+
+    help do
+      subtitle 'Epic'
+      option 'group', 'Show Group'
+      option 'update', 'Update this epic [Hash]'
+      option 'delete', 'Delete this epic'
+      option 'todo', 'Add todo this epic'
+      option 'issues', 'List issues in epic'
+      option 'issue_add', 'Add issue to Epic [Issue ID]'
+      option 'issue_remove', 'Remove issue from Epic [Epic Issue ID]'
+      option 'issue_update', 'Update issue association [Epic Issue ID, Hash]'
+
+      # Resource Labels
+      option 'resource_labels', 'List of all label events'
+      option 'resource_label', 'Show single label event [Resource Event ID]'
+    end
+  end
+end

data/lib/labclient/epics/issues/add.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Issues' do
+      title 'Add'
+      desc 'Creates an epic - issue association [Group ID, Epic IID, Issue ID]'
+      example 'client.epics.issue_add(59, 3, 6459)'
+    end
+
+    doc 'Issues' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.group.show(59)
+        group.epic_issue_add(3,6459)
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(4)
+        epic.issue_add(6459)
+      DOC
+    end
+
+    def issue_add(group_id, epic_id, issue_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+      issue_id = format_id(issue_id)
+
+      client.request(:post, "groups/#{group_id}/epics/#{epic_id}/issues/#{issue_id}")
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Issues' do
+      title 'List'
+      desc 'Gets all issues that are assigned to an epic. [Group ID, Epic IID]'
+      example 'client.epics.issues(59, 3)'
+
+      result <<~DOC
+        => [#<Issue id: 32, title: De-engineered even-keeled application, state: opened>, ...]
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.group.show(59)
+        group.epic_issues(3)
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(3)
+        epic.issues
+      DOC
+    end
+
+    def issues(group_id, epic_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/issues", Issue)
+    end
+  end
+end

data/lib/labclient/epics/issues/remove.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Issues' do
+      title 'Remove'
+      desc 'Remove issue from Epic. [Group ID, Epic IID, Epic Issue ID]'
+      example 'client.epics.issue_remove(59, 3, 4)'
+    end
+
+    doc 'Issues' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.group.show(59)
+        group.epic_issue_remove(3,4)
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(3)
+        epic.issue_remove(4)
+      DOC
+    end
+
+    def issue_remove(group_id, epic_id, epic_issue_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+
+      client.request(:delete, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}")
+    end
+  end
+end

data/lib/labclient/epics/issues/update.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Issues' do
+      title 'UPdate'
+      desc 'Update Epic issue association. [Group ID, Epic IID, Epic Issue ID, Hash]'
+      example 'client.epics.issue_update(59, 3, 4, move_before: 3)'
+
+      markdown <<~DOC
+              | Attribute           | Type             | Required   | Description                                                                           |
+        | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------|
+        | move_before_id    | integer/string   | no         | The ID of the issue - epic association that should be placed before the link in the question. |
+        | move_after_id     | integer/string   | no         | The ID of the issue - epic association that should be placed after the link in the question.  |
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.group.show(59)
+        group.epic_issue_update(3,4, move_before: 3)
+      DOC
+    end
+
+    doc 'Issues' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(3)
+        epic.issue_update(4, move_before: 3)
+      DOC
+    end
+
+    def issue_update(group_id, epic_id, epic_issue_id, query)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
+      epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.class == Issue
+
+      client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", nil, query)
+    end
+  end
+end

data/lib/labclient/epics/list.rb

@@ -0,0 +1,54 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'List' do
+      desc 'Gets all epics of the requested group and its subgroups. [Group ID]'
+      example 'client.epics.list(59)'
+
+      result <<~DOC
+        => [#<Epic iid: 3, title: Initial Release>, ...]
+      DOC
+
+      markdown <<~DOC
+        | Attribute           | Type             | Required   | Description                                                                                                                 |
+        | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- |
+        | author_id         | integer          | no         | Return epics created by the given user id                                                                                 |
+        | labels            | string           | no         | Return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used |
+        | with_labels_details | boolean        | no         | If true, response will return more details for each label in labels field: :name, :color, :description, :description_html, :text_color. Default is false. |
+        | order_by          | string           | no         | Return epics ordered by created_at or updated_at fields. Default is created_at                                        |
+        | sort              | string           | no         | Return epics sorted in asc or desc order. Default is desc                                                             |
+        | search            | string           | no         | Search epics against their title and description                                                                        |
+        | state             | string           | no         | Search epics against their state, possible filters: opened, closed and all, default: all                          |
+        | created_after     | datetime         | no         | Return epics created on or after the given time                                                                             |
+        | created_before    | datetime         | no         | Return epics created on or before the given time                                                                            |
+        | updated_after     | datetime         | no         | Return epics updated on or after the given time                                                                             |
+        | updated_before    | datetime         | no         | Return epics updated on or before the given time                                                                            |
+        | include_ancestor_groups | boolean    | no         | Include epics from the requested group's ancestors. Default is false                                                      |
+        | include_descendant_groups | boolean  | no         | Include epics from the requested group's descendants. Default is true                                                     |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.epics
+      DOC
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def list(group_id, query = {})
+      group_id = format_id(group_id)
+
+      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])
+
+      query[:updated_after] = query[:updated_after].to_time.iso8601 if format_time?(query[:updated_after])
+      query[:updated_before] = query[:updated_before].to_time.iso8601 if format_time?(query[:updated_before])
+
+      client.request(:get, "groups/#{group_id}/epics", Epic, query)
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/labclient/epics/show.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Show' do
+      desc 'Gets a single epic. [Group ID, Epic IID]'
+      example 'client.epics.show(59, 1)'
+
+      result '=>  #<Epic iid: 4, title: Initial Release>'
+    end
+
+    doc 'Show' do
+      desc 'Via Group [Epic IID]'
+      example <<~DOC
+        group = client.groups.show(16)
+        epic = group.epic_show(1)
+      DOC
+    end
+
+    def show(group_id, epic_id)
+      # GET /groups/:id/epics/:epic_iid
+
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}", Epic)
+    end
+  end
+end

data/lib/labclient/epics/todo.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Create' do
+      desc 'Manually creates a todo for the current user on an epic [Group ID]'
+      example 'client.epics.create(5, url: "http://labclient.com")'
+
+      result '=>  #<Epic id: 2, url: http://labclient.com>'
+    end
+
+    doc 'Create' do
+      desc 'Via Epic'
+      example <<~DOC
+        epic = client.epics.show(5, 1)
+        epic.todo
+      DOC
+    end
+
+    def todo(group_id, epic_id)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:post, "groups/#{group_id}/epics/#{epic_id}/todo", Todo)
+    end
+  end
+end