labclient 0.1.0

data/lib/labclient/epics/update.rb

@@ -0,0 +1,52 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Epics < Common
+    doc 'Update' do
+      desc 'Updates an epic. [Group ID, Epic IID, Params]'
+      example 'client.epics.update(59, 1, title: "Full Release")'
+
+      result '=> #<Epic id: 4, title: Full Release>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute           | Type             | Required   | Description                                                                            |
+        | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------|
+        | epic_iid          | integer/string   | yes        | The internal ID of the epic  |
+        | title             | string           | no         | The title of an epic |
+        | description       | string           | no         | The description of an 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. |
+        | labels            | string           | no         | The comma separated list of labels |
+        | 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) |
+        | state_event       | string           | no         | State event for an epic. Set close to close the epic and reopen to reopen it (since 11.4) |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Group [Epic IID, Params]'
+      example <<~DOC
+        group = client.groups.show(16)
+        epic = group.epic_update(1, title: "To Isengard!")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Epic [Params]'
+      example <<~DOC
+        epic = client.epics.show(16, 1)
+        epic.update(title: "Do all things")
+      DOC
+    end
+
+    def update(group_id, epic_id, query)
+      group_id = format_id(group_id)
+      epic_id = format_id(epic_id)
+
+      client.request(:put, "groups/#{group_id}/epics/#{epic_id}", Epic, query)
+    end
+  end
+end

data/lib/labclient/error.rb

@@ -0,0 +1,11 @@
+# Error helper that includes the HTTParty Response
+module LabClient
+  # Class Shim
+  class Error < StandardError
+    attr_reader :resp
+    def initialize(resp)
+      super
+      @resp = resp
+    end
+  end
+end

data/lib/labclient/events/event.rb

@@ -0,0 +1,13 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Event < Klass
+    include ClassHelpers
+    def inspect
+      "#<Event type: #{action_name}>"
+    end
+
+    date_time_attrs %i[created_at]
+    user_attrs %i[author]
+  end
+end

data/lib/labclient/events/list.rb

@@ -0,0 +1,67 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Events < Common
+    doc 'List' do
+      desc 'Get a list of events for the authenticated user'
+      example 'client.events.list'
+      result <<~DOC
+        => [#<Event type: imported>, #<Event type: created>, #<Event type: pushed to>, ...]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action | string | no | Include only events of a particular action type |
+        | target_type | string | no | Include only events of a particular target type] |
+        | before | date | no |  Include only events created before a particular date. |
+        | after | date | no |  Include only events created after a particular date. |
+        | scope | string | no | Include all events across a user's projects. |
+        | sort | string | no | Sort events in asc or desc order by created_at. Default is desc |
+
+
+
+        **Available parameters for the `target_type` and `action`**:
+
+        | Type        | Parameters |
+        | ----------- | ---------- |
+        | action      | issue, merge_request, milestone, note, project, snippet, user |
+        | target_type | closed, commented, created, destroyed, expired, joined, left, merged, pushed, reopened, updated |
+
+
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by Action'
+      example 'client.events.list(action: :created)'
+    end
+
+    doc 'List' do
+      desc 'Filter by Target Type'
+      example 'client.events.list(target_type: :issue)'
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both :after and :before can be used with Date or Time objects. (responds_to: to_time)
+      DOC
+
+      example <<~DOC
+        client.events.list(after: 2.day.ago)
+      DOC
+    end
+
+    # List
+    def list(query = {})
+      query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
+      query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
+
+      client.request(:get, 'events', Event, query)
+    end
+  end
+end

data/lib/labclient/events/project.rb

@@ -0,0 +1,67 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Events < Common
+    doc 'Project' do
+      desc 'Get a list of visible events for a particular project. [ project id ]'
+      example 'client.events.project(1)'
+      result <<~DOC
+        => [#<Event type: imported>, #<Event type: created>, #<Event type: pushed to>, ...]
+      DOC
+    end
+
+    doc 'Project' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action | string | no | Include only events of a particular action type |
+        | target_type | string | no | Include only events of a particular target type] |
+        | before | date | no |  Include only events created before a particular date. |
+        | after | date | no |  Include only events created after a particular date. |
+        | scope | string | no | Include all events across a user's projects. |
+        | sort | string | no | Sort events in asc or desc order by created_at. Default is desc |
+
+
+
+        **Available parameters for the `target_type` and `action`**:
+
+        | Type        | Parameters |
+        | ----------- | ---------- |
+        | action      | issue, merge_request, milestone, note, project, snippet, user |
+        | target_type | closed, commented, created, destroyed, expired, joined, left, merged, pushed, reopened, updated |
+
+
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'Filter by Action'
+      example 'client.events.project(1, action: :created)'
+    end
+
+    doc 'Project' do
+      desc 'Filter by Target Type'
+      example 'client.events.project(1, target_type: :issue)'
+    end
+
+    doc 'Project' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both :after and :before can be used with Date or Time objects. (responds_to: to_time)
+      DOC
+
+      example <<~DOC
+        client.events.project(1, after: 2.day.ago)
+      DOC
+    end
+
+    def project(project_id, query = {})
+      project_id = format_id(project_id)
+      query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
+      query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
+
+      client.request(:get, "projects/#{project_id}/events", Event, query)
+    end
+  end
+end

data/lib/labclient/events/user.rb

@@ -0,0 +1,66 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Events < Common
+    doc 'User' do
+      desc 'Get the contribution events for the specified user, sorted from newest to oldest [ user id ]'
+      example 'client.events.user(1)'
+      result <<~DOC
+        => [#<Event type: imported>, #<Event type: created>, #<Event type: pushed to>, ...]
+      DOC
+    end
+
+    doc 'User' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action | string | no | Include only events of a particular action type |
+        | target_type | string | no | Include only events of a particular target type] |
+        | before | date | no |  Include only events created before a particular date. |
+        | after | date | no |  Include only events created after a particular date. |
+        | scope | string | no | Include all events across a user's projects. |
+        | sort | string | no | Sort events in asc or desc order by created_at. Default is desc |
+
+
+
+        **Available parameters for the `target_type` and `action`**:
+
+        | Type        | Parameters |
+        | ----------- | ---------- |
+        | action      | issue, merge_request, milestone, note, project, snippet, user |
+        | target_type | closed, commented, created, destroyed, expired, joined, left, merged, pushed, reopened, updated |
+
+
+      DOC
+    end
+
+    doc 'User' do
+      desc 'Filter by Action'
+      example 'client.events.user(1, action: :created)'
+    end
+
+    doc 'User' do
+      desc 'Filter by Target Type'
+      example 'client.events.user(1, target_type: :issue)'
+    end
+
+    doc 'User' do
+      markdown <<~DOC
+        ##### DateTime Helpers
+
+        Both :after and :before can be used with Date or Time objects. (responds_to: to_time)
+      DOC
+
+      example <<~DOC
+        client.events.user(1, after: 2.day.ago)
+      DOC
+    end
+
+    def user(user_id, query = {})
+      query[:before] = query[:before].to_time.iso8601 if format_time?(query[:before])
+      query[:after] = query[:after].to_time.iso8601 if format_time?(query[:after])
+
+      client.request(:get, "users/#{user_id}/events", Event, query)
+    end
+  end
+end

data/lib/labclient/files/create.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Files < Common
+    doc 'Create' do
+      desc 'This allows you to create a single file [Project ID, File Path, Hash]'
+      example <<~DOC
+        client.files.create(
+          264, "new.md",
+          branch: :master,
+          commit_message: "New File!",
+          content: "Content!"
+        )
+      DOC
+
+      result '{:file_path=>"new.md", :branch=>"master"}'
+
+      markdown <<~DOC
+        **Parameters**:
+
+        * branch (required) - Name of the branch
+        * start_branch (optional) - Name of the branch to start the new commit from
+        * encoding (optional) - Change encoding to ‘base64’. Default is text.
+        * author_email (optional) - Specify the commit author’s email address
+        * author_name (optional) - Specify the commit author’s name
+        * content (required) - File content
+        * commit_message (required) - Commit message
+
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.file_create('other.md',
+          branch: :master,
+          commit_message: "New File!",
+          content: "Content!")
+      DOC
+    end
+
+    def create(project_id, file_path, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
+    end
+  end
+end

data/lib/labclient/files/delete.rb

@@ -0,0 +1,43 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Files < Common
+    doc 'Delete' do
+      desc 'This allows you to update a single file [Project ID, File Path, Hash]'
+      example <<~DOC
+        client.files.delete(
+          264, "new.md",
+          branch: :master,
+          commit_message: "Delete File!",
+        )
+      DOC
+
+      markdown <<~DOC
+        **Parameters**:
+
+        * branch (required) - Name of the branch
+        * start_branch (optional) - Name of the branch to start the new commit from
+        * author_email (optional) - Specify the commit author’s email address
+        * author_name (optional) - Specify the commit author’s name
+        * commit_message (required) - Commit message
+        * last_commit_id (optional) - Last known file commit id
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.file_delete('other.md',
+          branch: :master,
+          commit_message: "Remove File!",)
+      DOC
+    end
+
+    def delete(project_id, file_path, query)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
+    end
+  end
+end

data/lib/labclient/files/show.rb

@@ -0,0 +1,48 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Files < Common
+    doc 'Show' do
+      desc 'Allows you to receive information about file in repository like name, size, content [Project ID, File Path, Ref (master default), kind]'
+      example 'client.files.show(264, "README.md")'
+
+      markdown <<~DOC
+        Ref will default to `master`
+
+        Kind can be left empty or set to either :raw or :blame
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Raw Content'
+      example 'client.files.show(264, "README.md", :master, :raw)'
+    end
+
+    doc 'Show' do
+      desc 'Blame'
+      example 'client.files.show(264, "README.md", :master, :blame)'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.file('a3c86df3f')
+      DOC
+    end
+
+    def show(project_id, file_path, ref = :master, kind = nil)
+      kind = case kind
+             when :raw
+               '/raw'
+             when :blame
+               '/blame'
+             end
+      # GET /projects/:id/repository/files/:file_path
+
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", nil, ref: ref)
+    end
+  end
+end

data/lib/labclient/files/update.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Files < Common
+    doc 'Update' do
+      desc 'This allows you to update a single file [Project ID, File Path, Hash]'
+      example <<~DOC
+        client.files.update(
+          264, "new.md",
+          branch: :master,
+          commit_message: "New File!",
+          content: "Content!"
+        )
+      DOC
+
+      result '{:file_path=>"new.md", :branch=>"master"}'
+
+      markdown <<~DOC
+        **Parameters**:
+
+        * branch (required) - Name of the branch
+        * start_branch (optional) - Name of the branch to start the new commit from
+        * encoding (optional) - Change encoding to ‘base64’. Default is text.
+        * author_email (optional) - Specify the commit author’s email address
+        * author_name (optional) - Specify the commit author’s name
+        * content (required) - New file content
+        * commit_message (required) - Commit message
+        * last_commit_id (optional) - Last known file commit id
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.file_create('other.md',
+          branch: :master,
+          commit_message: "New File!",
+          content: "Content!")
+      DOC
+    end
+
+    def update(project_id, file_path, query)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
+    end
+  end
+end

data/lib/labclient/groups/access_requests/access_request.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class GroupAccessRequest < Klass
+    include ClassHelpers
+    def inspect
+      "#<GroupAccessRequest id: #{id}, name: #{name}, state: #{state}>"
+    end
+
+    def user
+      client.users.show(id)
+    end
+
+    def approve(access_level = :developer)
+      group_id = collect_group_id
+      client.groups.access_requests.approve(group_id, id, access_level)
+    end
+
+    def deny
+      group_id = collect_group_id
+      client.groups.access_requests.deny(group_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      @group_name = 'Groups'
+      subtitle 'GroupAccessRequest'
+      option 'user', 'Show user for access request'
+      option 'approve', 'Accept access request [Access Level]'
+      option 'deny', 'Deny request'
+    end
+  end
+end

data/lib/labclient/groups/access_requests/approve.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupAccessRequests < Common
+    doc 'Approve' do
+      desc 'Approves an access request for the given user. [Group ID, User ID, Access Level]'
+      example 'client.groups.access_requests.approve(310, 3)'
+
+      result '=>  #<GroupAccessRequest id: 3, name: planet bob>'
+    end
+
+    doc 'Approve' do
+      markdown <<~DOC
+        | Attribute    | Type    | Description                                                 |
+        | ----------             | ---------                                                   |
+        | access_level | integer | A valid access level (defaults: 30, developer access level) |
+      DOC
+    end
+
+    doc 'Approve' do
+      desc 'Via GroupAccessRequest [Access Level]'
+      example <<~DOC
+        request = client.groups.access_requests(16).first
+        request.approve(:developer)
+      DOC
+    end
+
+    def approve(group_id, user_id, access_level = :developer)
+      group_id = format_id(group_id)
+      user_id = format_id(user_id)
+
+      query = { access_level: access_level }
+      query_access_level(query, :access_level)
+
+      client.request(:put, "groups/#{group_id}/access_requests/#{user_id}/approve", GroupAccessRequest, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupAccessRequests < Common
+    doc 'Create' do
+      desc 'Requests access for the authenticated user to a group.'
+      example <<~DOC
+        client.groups.access_requests.create(310)
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(100)
+        group.request_access
+      DOC
+    end
+
+    def create(group_id)
+      group_id = format_id(group_id)
+      client.request(:post, "groups/#{group_id}/access_requests", GroupAccessRequest)
+    end
+  end
+end

data/lib/labclient/groups/access_requests/deny.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupAccessRequests < Common
+    doc 'Deny' do
+      desc 'Deny an access request for the given user. [Group ID, User ID]'
+      example 'client.groups.access_requests.deny(310, 3)'
+    end
+
+    doc 'Deny' do
+      desc 'Via GroupAccessRequest [Access Level]'
+      example <<~DOC
+        request = client.groups.access_requests(16).first
+        request.deny
+      DOC
+    end
+
+    def deny(group_id, user_id)
+      group_id = format_id(group_id)
+      user_id = format_id(user_id)
+
+      client.request(:delete, "groups/#{group_id}/access_requests/#{user_id}/deny")
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupAccessRequests < Common
+    doc 'List' do
+      desc 'Gets a list of access requests viewable by the authenticated user. [Group ID]'
+      example 'client.groups.access_requests.list(16)'
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(16)
+        group.access_requests
+      DOC
+    end
+
+    def list(group_id)
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/access_requests", GroupAccessRequest)
+    end
+  end
+end

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

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