labclient 0.1.0

data/lib/labclient/klass.rb

@@ -0,0 +1,107 @@
+# Top Namesapce
+module LabClient
+  # Common Configuration for all Class Helpers
+  class Klass < OpenStruct
+    include CurlHelper
+
+    attr_reader :client, :response
+    extend Docs
+
+    def verbose
+      ap self
+    end
+
+    # API Methods here have to be explicitly documented / custom helpers
+    # Assume no methods by default
+    def help
+      docs = LabClient::Docs.docs.dig(group_name, 'Reference')
+      unless docs
+        puts 'No Available Help'
+        return false
+      end
+
+      puts klass
+      docs.each do |doc|
+        next unless doc[:options]
+
+        doc[:options].each do |opt|
+          puts '  ' + opt[:name]
+          puts "    #{opt[:text]}\n"
+        end
+      end
+
+      # Ignore Output
+      nil
+    end
+
+    # TODO: Combine all of these?
+    def collect_project_id(position = 1)
+      response.path.split('/')[position]
+    end
+
+    alias collect_group_id collect_project_id
+    alias collect_user_id collect_project_id
+
+    def collect_release_id(position = 3)
+      response.path.split('/')[position]
+    end
+
+    def collect_repository_id(position = 4)
+      response.path.split('/')[position]
+    end
+
+    # Category and Primary Key for docs
+    def group_name
+      self.class.instance_variable_get('@group_name') || klass.pluralize
+    end
+
+    # Prevent stack level errors, but turning into has first
+    def to_json(*_args)
+      to_h.to_json
+    end
+
+    # Helper to get docs
+    def klass
+      self.class.name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+    end
+
+    def update_self(obj)
+      @table = obj.table
+      self
+    end
+
+    def initialize(hash = nil, response = nil, client = nil)
+      @client = client
+      @response = response
+
+      @table = {}
+      hash&.each_pair do |k, v|
+        k = k.to_sym
+        @table[k] = v
+      end
+    end
+
+    # Formatting Time Helper
+    def format_time?(time)
+      time.respond_to?(:to_time)
+    end
+
+    # Define a list of DateTime Attributes
+    def self.date_time_attrs(list)
+      list.each do |kind|
+        define_method(kind) do
+          DateTime.parse @table[kind] if has? kind
+        end
+      end
+    end
+
+    # Define a list of LabClient::User Attributes
+    def self.user_attrs(list)
+      list.each do |kind|
+        define_method(kind) do
+          User.new(@table[kind], response, client) if has? kind
+        end
+      end
+    end
+  end
+end

data/lib/labclient/license/add.rb

@@ -0,0 +1,21 @@
+module LabClient
+  # Specifics
+  class Licenses < Common
+    doc 'Add' do
+      title 'Add a new license'
+      example 'client.license.add("eyJkYXRhIjoiMHM5Q...S01Udz09XG4ifQ==")'
+      result <<~DOC
+        =>  #<License - id: 6, plan: premium, expires at: 2200-11-04>
+      DOC
+    end
+
+    doc 'Add' do
+      desc 'A 400 and error message will be returned if the license could not be added'
+    end
+
+    # Get current license
+    def add(obj)
+      client.request(:post, 'license', License, license: obj)
+    end
+  end
+end

data/lib/labclient/license/delete.rb

@@ -0,0 +1,17 @@
+module LabClient
+  # Specifics
+  class Licenses < Common
+    doc 'Delete' do
+      title 'Delete a license'
+      example 'client.license.delete(:id)'
+      result <<~DOC
+        =>  nil
+      DOC
+    end
+
+    # Remove current license
+    def delete(license_id)
+      client.request(:delete, "license/#{license_id}")
+    end
+  end
+end

data/lib/labclient/license/license.rb

@@ -0,0 +1,12 @@
+module LabClient
+  # Inspect Helper
+  class License < Klass
+    include ClassHelpers
+
+    date_time_attrs %i[expires_at created_at starts_at]
+
+    def inspect
+      "#<License - id: #{id}, plan: #{plan}, created at: #{created_at}, expires at: #{expires_at}>"
+    end
+  end
+end

data/lib/labclient/license/list.rb

@@ -0,0 +1,71 @@
+module LabClient
+  # Specifics
+  class Licenses < Common
+    doc 'List' do
+      title 'Current license'
+      desc 'Retrieve information about the current license.'
+      example 'client.license.current'
+      result <<~DOC
+        =>  #<License - id: 5, plan: premium, expires at: 2200-11-04>
+      DOC
+    end
+
+    doc 'List' do
+      title 'All Licenses'
+      desc 'Retrieve information about all licenses'
+      example 'client.license.list'
+      result <<~DOC
+        => [#<License - id: 5, plan: premium, expires at: 2200-11-04>, #<License - id: 1, plan: ultimate, expires at: 2050-11-14>]
+      DOC
+    end
+
+    doc 'List' do
+      title 'View current license detail'
+      desc 'Retrieve detailed information of current license'
+      example 'client.license.current.verbose'
+      result <<~DOC
+        LabClient::License {
+                           :id => 1,
+                           :plan => "ultimate",
+                           :created_at => "2019-11-18T11:27:24.597-06:00",
+                           :starts_at => "2019-11-14",
+                           :expires_at => "2050-11-14",
+                           :historical_max => 0,
+                           :maximum_user_count => 48,
+                           :licensee => OpenStruct {
+                           :Name => "GitLab Henley",
+                           :Email => "test_user@gitlab.com",
+                           :Company => "GitLab, Inc."
+               },
+                           :add_ons => OpenStruct {},
+                           :expired => false,
+                           :overage => 0,
+                           :user_limit => 100,
+                           :active_users => 52
+               }
+        => nil
+      DOC
+    end
+
+    doc 'List' do
+      title 'View all licenses detail'
+      desc 'Retrieve detailed information of all licenses'
+      example 'client.license.list.each(&:verbose)'
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        Please see [here for a explanation of license detail values](https://docs.gitlab.com/ee/api/license.html#retrieve-information-about-all-licenses)
+      DOC
+    end
+
+    # Get current license
+    def current
+      client.request(:get, 'license', License)
+    end
+
+    def list
+      client.request(:get, 'licenses', License)
+    end
+  end
+end

data/lib/labclient/markdown/markdown.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Markdown < Common
+    doc 'Render' do
+      desc 'Render an arbitrary Markdown document.'
+      example 'client.markdown.render(text: "# Oh Hi!")'
+      result <<~DOC
+        =>  { :html=>"<h1 data-sourcepos=\"1:1-1:8\">Oh Hi!</h1>"}
+      DOC
+    end
+
+    doc 'Render' do
+      markdown <<~DOC
+        | Attribute | Type    | Required      | Description                                |
+        | --------- | ------- | ------------- | ------------------------------------------ |
+        | text    | string  | yes           | The Markdown text to render                |
+        | gfm     | boolean | no (optional) | Render text using GitLab Flavored Markdown. Default is false |
+        | project | string  | no (optional) | Use project as a context when creating references using GitLab Flavored Markdown. Authentication is required if a project is not public.  |
+
+      DOC
+    end
+
+    def render(query)
+      client.request(:post, 'markdown', nil, query)
+    end
+  end
+end

data/lib/labclient/members/groups/add.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMembers < Common
+    doc 'Group' do
+      title 'Add'
+      desc 'Gets a list of group or group members viewable by the authenticated user. [Group ID, User ID, Hash]'
+      example 'client.members.groups.add(264, 14, access_level: :developer)'
+      result '=> #<Member name: Tristana, access: developer>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | access_level | integer | yes | A valid access level |
+        | expires_at | string | no | A date string in the format YEAR-MONTH-DAY |
+      DOC
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.member_add(14, access_level: :reporter)
+      DOC
+    end
+
+    def add(group_id, user_id, query)
+      query_format_time(query, :expires_at)
+      query_access_level(query, :access_level)
+      group_id = format_id(group_id)
+      user_id = format_id(user_id)
+      query[:user_id] = user_id
+
+      client.request(:post, "groups/#{group_id}/members", Member, query)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMembers < Common
+    doc 'Group' do
+      title 'Delete'
+      desc 'Gets a list of group or group members viewable by the authenticated user. [Group ID, User ID]'
+      example 'client.members.groups.delete(264, 14)'
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.member_delete(14)
+      DOC
+    end
+
+    def delete(group_id, user_id)
+      client.request(:delete, "groups/#{group_id}/members/#{user_id}")
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMembers < Common
+    @group_name = 'Members'
+
+    doc 'Group' do
+      title 'List'
+      desc 'Gets a list of group or group members viewable by the authenticated user. [Group ID, Hash]'
+      example 'client.members.groups.list(264)'
+      result '[#<Member name: Administrator, access: owner>, #<Member name: Shyvanna, access: maintainer>, ... ]'
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264,1)
+        group.members
+      DOC
+    end
+
+    doc 'Group' do
+      subtitle 'List All'
+      desc 'List including inherited members. [Group ID, Hash]'
+      example 'client.members.groups.list_all(264)'
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264,1)
+        group.members_all
+      DOC
+    end
+
+    doc 'Examples' do
+      subtitle 'Groups'
+      desc 'Only Developers'
+      example 'client.members.groups.list_all(264).select(&:developer?)'
+    end
+
+    doc 'Examples' do
+      desc 'Except Owners'
+      example 'client.members.groups.list_all(264).reject(&:owner?)'
+    end
+
+    doc 'Examples' do
+      desc 'Higher Permission than Guest'
+      example 'client.members.groups.list_all(264).select {|x| x.greater_than :guest }'
+    end
+
+    # Default to False
+    def list(group_id, query = nil, all = nil)
+      all = '/all' if all # Reset and Use
+
+      format_query_ids(:user_ids, query) if query
+
+      group_id = format_id(group_id)
+      client.request(:get, "groups/#{group_id}/members#{all}", Member, query)
+    end
+
+    # Default to True
+    def list_all(group_id, query = nil)
+      list(group_id, query, true)
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMembers < Common
+    doc 'Group' do
+      title 'Show'
+      desc 'Gets a member of a group or group [Group ID, User ID]'
+      example 'client.members.groups.show(264, 14)'
+      result '#<Member name: Annie, access: developer>'
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.member(14)
+      DOC
+    end
+
+    doc 'Group' do
+      subtitle 'Show All'
+      desc 'Gets a member of a group or group, including members inherited through ancestor groups [Group ID, User ID]'
+      example 'client.members.group.show(264, 14)'
+      result '#<Member name: Annie, access: developer>'
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.member_all(14)
+      DOC
+    end
+
+    # Default to False
+    def show(group_id, user_id, all = nil)
+      all = '/all' if all # Reset and Use
+
+      user_id = format_id(user_id)
+      group_id = format_id(group_id)
+      client.request(:get, "groups/#{group_id}/members#{all}/#{user_id}", Member)
+    end
+
+    # Default to True
+    def show_all(group_id, user_id)
+      show(group_id, user_id, true)
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupMembers < Common
+    doc 'Group' do
+      title 'Update'
+      desc 'Updates a member of a group or group. [Group ID, User ID, Hash]'
+      example 'client.members.groups.update(264, 14, access_level: :reporter)'
+      result '=> #<Member name: Tristana, access: reporter>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | access_level | integer | yes | A valid access level |
+        | expires_at | string | no | A date string in the format YEAR-MONTH-DAY |
+      DOC
+    end
+
+    doc 'Group' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(264)
+        group.member_update(14, access_level: :developer)
+      DOC
+    end
+
+    def update(group_id, user_id, query)
+      query_format_time(query, :expires_at)
+      query_access_level(query, :access_level)
+      group_id = format_id(group_id)
+      user_id = format_id(user_id)
+
+      client.request(:put, "groups/#{group_id}/members/#{user_id}", Member, query)
+    end
+  end
+end

data/lib/labclient/members/member.rb

@@ -0,0 +1,56 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Member < Klass
+    include ClassHelpers
+    include AccessLevel
+
+    def inspect
+      "#<Member name: #{name}, access: #{level}>"
+    end
+
+    def level
+      human_access_level(access_level)
+    end
+
+    def user
+      client.users.show(id)
+    end
+
+    def guest?
+      level == :guest
+    end
+
+    def reporter?
+      level == :reporter
+    end
+
+    def developer?
+      level == :developer
+    end
+
+    def maintainer?
+      level == :maintainer
+    end
+
+    def owner?
+      level == :owner
+    end
+
+    def greater_than(leveler)
+      case leveler
+      when Symbol
+        access_level > machine_access_level(leveler)
+      when Integer
+        access_level > leveler
+      end
+    end
+
+    help do
+      subtitle 'Member'
+      option 'level', 'Humanized symbol of access level. e.g. :developer'
+      option 'user', 'Collect user object.'
+      option '<permission>?', 'True/False evaluation each guest?, developer? etc'
+    end
+  end
+end

data/lib/labclient/members/members.rb

@@ -0,0 +1,15 @@
+# Top namespace
+module LabClient
+  # Container
+  class Members < Common
+    include ClassHelpers
+
+    def groups
+      GroupMembers.new(client)
+    end
+
+    def projects
+      ProjectMembers.new(client)
+    end
+  end
+end

data/lib/labclient/members/projects/add.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMembers < Common
+    doc 'Project' do
+      title 'Add'
+      desc 'Gets a list of group or project members viewable by the authenticated user. [Project ID, User ID, Hash]'
+      example 'client.members.projects.add(264, 14, access_level: :developer)'
+      result '=> #<Member name: Tristana, access: developer>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | access_level | integer | yes | A valid access level |
+        | expires_at | string | no | A date string in the format YEAR-MONTH-DAY |
+      DOC
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.member_add(14, access_level: :reporter)
+      DOC
+    end
+
+    def add(project_id, user_id, query)
+      query_format_time(query, :expires_at)
+      query_access_level(query, :access_level)
+      project_id = format_id(project_id)
+      user_id = format_id(user_id)
+      query[:user_id] = user_id
+
+      client.request(:post, "projects/#{project_id}/members", Member, query)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMembers < Common
+    doc 'Project' do
+      title 'Delete'
+      desc 'Gets a list of group or project members viewable by the authenticated user. [Project ID, User ID]'
+      example 'client.members.projects.delete(264, 14)'
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.member_delete(14)
+      DOC
+    end
+
+    def delete(project_id, user_id)
+      client.request(:delete, "projects/#{project_id}/members/#{user_id}")
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectMembers < Common
+    @group_name = 'Members'
+    doc 'Project' do
+      title 'List'
+      desc 'Gets a list of group or project members viewable by the authenticated user. [Project ID, Hash]'
+      example 'client.members.projects.list(264)'
+      result '[#<Member name: Administrator, access: owner>, #<Member name: Shyvanna, access: maintainer>, ... ]'
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.members
+      DOC
+    end
+
+    doc 'Project' do
+      subtitle 'List All'
+      desc 'List including inherited members. [Project ID, Hash]'
+      example 'client.members.projects.list_all(264)'
+    end
+
+    doc 'Project' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.members_all
+      DOC
+    end
+
+    doc 'Examples' do
+      title 'Filter'
+      desc 'Only Developers'
+      example 'client.members.projects.list_all(264).select(&:developer?)'
+    end
+
+    doc 'Examples' do
+      desc 'Except Owners'
+      example 'client.members.projects.list_all(264).reject(&:owner?)'
+    end
+
+    doc 'Examples' do
+      desc 'Higher Permission than Guest'
+      example 'client.members.projects.list_all(264).select {|x| x.greater_than :guest }'
+    end
+
+    # Default to False
+    def list(project_id, query = nil, all = nil)
+      all = '/all' if all # Reset and Use
+
+      format_query_ids(:user_ids, query) if query
+
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/members#{all}", Member, query)
+    end
+
+    # Default to True
+    def list_all(project_id, query = nil)
+      list(project_id, query, true)
+    end
+  end
+end