labclient 0.1.0

data/lib/labclient/groups/show.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'Show' do
+      subtitle 'Details'
+      desc 'Get all details of a group [Hash]'
+
+      example 'client.groups.show(68)'
+
+      result '=> [#<Project id: 77 fensofserech/flameatronach>, #<Project id: 76 fensofserech/sizechanging>, ... ]'
+
+      markdown <<~DOC
+        See [Docs](https://docs.gitlab.com/ee/api/groups.html#details-of-a-group) on extra attributes
+
+        | Attribute                | Type           | Required | Description |
+        | ------------------------ | -------------- | -------- | ----------- |
+        | with_custom_attributes | boolean        | no       | Include custom attributes in response (admins only). |
+        | with_projects          | boolean        | no       | Include details from projects that belong to the specified group (defaults to true). |
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.list.last
+        group.details
+      DOC
+    end
+
+    def show(group_id, query = {})
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}", Group, query)
+    end
+  end
+end

data/lib/labclient/groups/subgroups.rb

@@ -0,0 +1,47 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'List' do
+      title 'Subgroups'
+      desc 'Get a list of visible direct subgroups in this group'
+
+      example 'client.groups.subgroups(68)'
+
+      result '=> [#<Group id: 110, fensofserech/subgroup>]'
+
+      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
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.list.last
+        group.subgroups
+      DOC
+    end
+
+    def subgroups(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}/subgroups", Group, query)
+    end
+  end
+end

data/lib/labclient/groups/transfer.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'Update' do
+      title 'Transfer'
+      desc 'Transfer a project to the Group namespace [Group ID , Project ID]'
+      example 'client.groups.transfer(3,25)'
+      result '=> #<Project id: 25 badlands/chaurushunter>'
+    end
+
+    doc 'Update' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.group.show(3)
+        group.transfer(25)
+      DOC
+    end
+
+    def transfer(group_id, project_id)
+      group_id = format_id(group_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "groups/#{group_id}/projects/#{project_id}", Project)
+    end
+  end
+end

data/lib/labclient/groups/update.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Groups < Common
+    doc 'Update' do
+      example 'client.groups.update(3, name: "Sweet Name")'
+      result '=> #<Group id: 68, fensofserech>'
+
+      markdown <<~DOC
+        Updates the project group [Group ID , Hash]. See [Docs](https://docs.gitlab.com/ee/api/groups.html#update-group) for available options.
+
+        | Attribute                            | Type    | Required | Description |
+        | ------------------------------------ | ------- | -------- | ----------- |
+        | name                               | string  | no       | The name of the group. |
+        | path                               | string  | no       | The path of the group. |
+        | description                        | string  | no       | The description of the group. |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.group.show(3)
+        group.update(name: 'rawr')
+      DOC
+    end
+
+    def update(group_id, query = {})
+      group_id = format_id(group_id)
+
+      client.request(:put, "groups/#{group_id}", Group, query)
+    end
+  end
+end

data/lib/labclient/http.rb

@@ -0,0 +1,87 @@
+# Typheous Wrapper
+module LabClient
+  # Request Helper
+  class HTTP
+    attr_accessor :settings
+    def initialize(settings)
+      self.settings = settings
+    end
+
+    # Pagination Helper, Raw/Full HTTP Requests
+    def url(path)
+      if path.include? 'http'
+        path
+      else
+        "#{settings[:url]}/api/v4/#{path}"
+      end
+    end
+
+    def request(method, path, body = {}, dump_json = true)
+      options = { method: method, headers: headers(dump_json) }
+
+      if body && !body.empty?
+        case method
+        when :get
+          options[:params] = body
+        else
+          # File Upload shouldn't be jsonfied
+          options[:body] = dump_json ? Oj.dump(body, mode: :compat) : body
+        end
+      end
+
+      options.merge!(disable_ssl) unless settings[:ssl_verify]
+
+      Typhoeus::Request.new(url(path), options).run
+    end
+
+    def disable_ssl
+      { ssl_verifyhost: 0, ssl_verifypeer: false }
+    end
+
+    def headers(dump_json)
+      default_headers = {
+
+        'Private-Token' => settings[:token],
+
+        'Accept' => 'application/json',
+        'User-Agent' => "LabClient #{LabClient::VERSION}"
+      }
+
+      default_headers['Content-Type'] = 'application/json' if dump_json
+      default_headers
+    end
+  end
+end
+
+# Typheous Shim
+module Typhoeus
+  # Add Data :  OJ Parsing
+  class Response
+    def inspect
+      "#<TyphoeusResponse code: #{code}>"
+    end
+
+    attr_reader :path
+
+    def data
+      return @data if @data
+
+      @data = process_body
+    end
+
+    def process_body
+      if body.empty?
+        nil
+      elsif headers['content-type'] == 'text/plain'
+        body
+      else
+        Oj.load(body, mode: :compat, object_class: OpenStruct)
+      end
+    end
+
+    def friendly_error
+      message = data[:message] || data[:error] || data
+      "#{code} - #{message}"
+    end
+  end
+end

data/lib/labclient/impersonation_tokens/create.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ImpersonationTokens < Common
+    doc 'Create' do
+      desc 'It creates a new impersonation token.  You are only able to create impersonation tokens to impersonate the user and perform both API calls and Git reads and writes. [User ID, Hash]'
+      example 'client.impersonation_tokens.create(5, name: "Special", scopes: [:api])'
+      result '#<ImpersonationToken id: 8, name: Special, active: true>'
+
+      markdown <<~DOC
+
+
+        | Attribute    | Type    | Required | Description |
+        | ------------ | ------- | -------- | ----------- |
+        | name       | string  | yes      | The name of the impersonation token |
+        | expires_at | date    | no       | The expiration date of the impersonation token in ISO format (YYYY-MM-DD)|
+        | scopes     | array   | yes      | The array of scopes of the impersonation token (api, read_user) |
+
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(5)
+        user.impersonation_tokens_create(name: 'User!', scopes: [:read_user], expires_at: 1.month.from_now)
+      DOC
+    end
+
+    def create(user_id, query)
+      user_id = format_id(user_id)
+      query_format_time(query, :expires_at)
+
+      client.request(:post, "users/#{user_id}/impersonation_tokens", ImpersonationToken, query)
+    end
+  end
+end

data/lib/labclient/impersonation_tokens/impersonation_token.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ImpersonationToken < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<ImpersonationToken id: #{id}, name: #{name}, active: #{active}>"
+    end
+
+    def revoke
+      user_id = collect_user_id
+      client.impersonation_tokens.revoke(user_id, id)
+    end
+
+    date_time_attrs %i[created_at expires_at]
+  end
+end

data/lib/labclient/impersonation_tokens/list.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ImpersonationTokens < Common
+    @group_name = 'Impersonation'
+    doc 'List' do
+      desc 'It retrieves every impersonation token of the user. [User ID, Filter State]'
+      example 'client.impersonation_tokens.list(5)'
+      result '[#<ImpersonationToken id: 8, name: Special, active: true>, ...]'
+
+      markdown <<~DOC
+        Filter tokens based on state: all, active, or inactive
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(5, :active)
+        user.impersonation_tokens
+      DOC
+    end
+
+    def list(user_id, filter = :all)
+      user_id = format_id(user_id)
+      client.request(:get, "users/#{user_id}/impersonation_tokens", ImpersonationToken, { filter: filter })
+    end
+  end
+end

data/lib/labclient/impersonation_tokens/revoke.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ImpersonationTokens < Common
+    doc 'Revoke' do
+      desc 'Revoke an impersonation token. [User ID, Token ID]'
+      example 'client.impersonation_tokens.revoke(5,7)'
+    end
+
+    doc 'Revoke' do
+      desc 'Via User [Token ID]'
+      example <<~DOC
+        user = client.users.show(5)
+        user.impersonation_tokens_revoke(2)
+      DOC
+    end
+
+    doc 'Revoke' do
+      desc 'Via ImpersonationToken [Token ID]'
+      example <<~DOC
+        token = client.impersonation_tokens.show(3)
+        token.revoke
+      DOC
+    end
+
+    def revoke(user_id, token_id)
+      token_id = format_id(token_id)
+      user_id = format_id(user_id)
+      client.request(:delete, "users/#{user_id}/impersonation_tokens/#{token_id}")
+    end
+  end
+end

data/lib/labclient/impersonation_tokens/show.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ImpersonationTokens < Common
+    doc 'Show' do
+      desc 'Show a user impersonation token. [User ID, Token ID]'
+      example 'client.impersonation_tokens.show(5,7)'
+      result '#<ImpersonationToken id: 7, name: User!, active: false>'
+    end
+
+    def show(user_id, token_id)
+      token_id = format_id(token_id)
+      user_id = format_id(user_id)
+
+      client.request(:get, "users/#{user_id}/impersonation_tokens/#{token_id}", ImpersonationToken)
+    end
+  end
+end

data/lib/labclient/issues/agent_detail.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      title 'Agent Detail'
+      desc 'Get user agent details [project id, issue iid]'
+      example 'client.issues.agent_detail(30, 1)'
+      result <<~DOC
+        => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'From Issue Object'
+      example 'issue.agent_detail'
+      result <<~DOC
+        issue = client.issues.show(30,1)
+        => #<Issue id: 1, title: Robust incremental superstructure, state: opened>
+        issue.agent_detail
+        => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}
+      DOC
+    end
+
+    # Show Specific
+    def agent_detail(project_id, issue_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/user_agent_detail")
+    end
+  end
+end

data/lib/labclient/issues/closed_by.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Show' do
+      subtitle 'Closed By'
+      desc 'Get all the merge requests that will close issue when merged. [project id, issue iid]'
+      example 'client.issues.closed_by(5, 1)'
+      result <<~DOC
+        => [#<MergeRequest id: 5, title: Update README.md, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.related_merge_requests
+      DOC
+    end
+
+    def closed_by(project_id, issue_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_id}/closed_by", MergeRequest)
+    end
+  end
+end

data/lib/labclient/issues/create.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Create' do
+      desc 'Creates a new project issue. [project id]'
+      example 'client.issues.create(5, title: "Fancy!")'
+      result <<~DOC
+        => #<Issue id: 1, title: Fancy!, state: opened>
+      DOC
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        See [API docs here](https://docs.gitlab.com/ee/api/issues.html#new-issue) for full list of attributes
+
+        | Attribute                                 | Type           | Required | Description  |
+        |-------------------------------------------|----------------|----------|--------------|
+        | title                                   | string         | yes      | The title of an issue |
+        | description                             | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+      DOC
+    end
+
+    def create(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/issues", Issue, query)
+    end
+  end
+end

data/lib/labclient/issues/delete.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'Delete' do
+      desc 'Updates an existing project issue. This call is also used to mark an issue as closed. [project id, issue iid]'
+      example 'client.issues.delete(5, 1)'
+      result <<~DOC
+        => #<Issue id: 1, title: Moar Fancy!, state: opened>
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.delete
+      DOC
+    end
+
+    def delete(project_id, issue_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/issues/#{issue_id}")
+    end
+  end
+end

data/lib/labclient/issues/group_issues.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Issues < Common
+    doc 'List' do
+      title 'Group'
+      desc 'Get a list of a group’s issues.'
+      example 'client.issues.group_issues(1)'
+      result <<~DOC
+        => [#<Issue id: 1, title: Front-line global approach, state: opened>, ..]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Group'
+      example <<~DOC
+        group = client.groups.show(1)
+        group.issues
+      DOC
+    end
+
+    def group_issues(group_id, query = {})
+      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])
+
+      client.request(:get, "groups/#{group_id}/issues", Issue, query)
+    end
+  end
+end

data/lib/labclient/issues/issue.rb

@@ -0,0 +1,114 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Issue < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Issue id: #{iid}, title: #{title}, state: #{state}>"
+    end
+
+    # DateTime Fields
+    date_time_attrs %i[closed_at created_at updated_at]
+
+    # User Fields
+    user_attrs %i[closed_by author assignee]
+
+    def update(query)
+      client.issues.update(project_id, iid, query)
+    end
+
+    def assignees
+      @table[:assignees].map { |x| User.new(x, response, client) } if has? :assignees
+    end
+
+    def delete
+      client.issues.delete(project_id, iid)
+    end
+
+    def move(target_id)
+      client.issues.move(project_id, iid, target_id)
+    end
+
+    def subscribe
+      client.issues.subscribe(project_id, iid)
+    end
+
+    def unsubscribe
+      client.issues.unsubscribe(project_id, iid)
+    end
+
+    def todo
+      client.issues.todo(project_id, iid)
+    end
+
+    def add_spent_time(duration)
+      client.issues.add_spent_time(project_id, iid, duration)
+    end
+
+    def time_estimate(duration)
+      client.issues.time_estimate(project_id, iid, duration)
+    end
+
+    def reset_time_estimate
+      client.issues.reset_time_estimate(project_id, iid)
+    end
+
+    def reset_spent_time
+      client.issues.reset_spent_time(project_id, iid)
+    end
+
+    def participants
+      client.issues.participants(project_id, iid)
+    end
+
+    def notes
+      client.notes.issues.list(project_id, iid)
+    end
+
+    def agent_detail
+      client.issues.agent_detail(project_id, iid)
+    end
+
+    def related_merge_requests
+      client.issues.related_merge_requests(project_id, iid)
+    end
+
+    def closed_by
+      client.issues.closed_by(project_id, iid)
+    end
+
+    # Resource Labels
+    def resource_labels
+      client.resource_labels.issues.list(project_id, iid)
+    end
+
+    def resource_label(resource_event_id)
+      client.resource_labels.issues.show(project_id, iid, resource_event_id)
+    end
+
+    help do
+      subtitle 'Issue'
+      option 'update', 'Update issue (accepts hash).'
+      option 'move', 'Move this issue to a different project [target project id]'
+      option 'todo', 'Create todo'
+      option 'subscribe', 'Subscribe to notifications'
+      option 'unsubscribe', 'Unsubscribe to notifications'
+      option 'participants', 'List participants in this issue.'
+      option 'notes', 'List notes/comments.'
+      option 'agent_detail', 'Get user agent details.'
+      option 'related_merge_requests', 'Get all related Merge Requests.'
+      option 'closed_by', 'Get all Merge Requests that will close this issue.'
+      option 'time_stats', 'Get time tracking stats.'
+      option 'add_time_spent', 'Adds spent time. Accepts Duration or Human Format. (1.hour or "1h")'
+      option 'time_estimate', 'Sets an estimated time. Accepts Duration or Human Format. (1.hour or "1h")'
+      option 'reset_time_estimate', 'Resets the estimated time'
+      option 'reset_spent_time', 'Resets the spent time'
+      option 'delete', 'Delete this issue.'
+
+      # Resource Labels
+      option 'resource_labels', 'List of all label events'
+      option 'resource_label', 'Show single label event [Resource Event ID]'
+    end
+  end
+end