labclient 0.1.0

data/lib/labclient/users/list.rb

@@ -0,0 +1,64 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'List' do
+      # title 'List & Search'
+      desc 'List and Search for users'
+
+      markdown <<~DOC
+        | Parameter    | Description |
+        | ------------ | ----------- |
+        | username   | Lookup by username |
+        | search     | Search by name or primary email |
+        | active     | Filter by user state. true or false |
+        | blocked    | Filter by user state. true or false |
+        | order_by   | Return users ordered by id, name, username, created_at, or updated_at fields. Default is id |
+        | sort       | Return users sorted in asc or desc order. Default is desc |
+        | two_factor | Filter users by Two-factor authentication. Filter values are enabled or disabled. By default it returns all users |
+
+      DOC
+    end
+
+    doc 'List' do
+      title 'Examples'
+      example 'client.users.list'
+      result <<~DOC
+        => [
+          #<User id: 56, username: "rakan">,
+          #<User id: 55, username: "peregrintook">,
+          #<User id: 54, username: "khazix">
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Username'
+      example 'client.users.list(username: "rakan")'
+      result <<~DOC
+        => [#<User id: 56, username: "rakan">]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Search'
+      example 'client.users.list(search: "Sid")'
+      result <<~DOC
+        => [#<User id: 56, username: "rakan">]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Active'
+      example 'client.users.list(active: true)'
+      result <<~DOC
+        => [#<User id: 56, username: "peregrintook">]
+      DOC
+    end
+
+    # List/Search users
+    def list(query = {})
+      client.request(:get, 'users', User, query)
+    end
+  end
+end

data/lib/labclient/users/memberships.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Show' do
+      title 'Memberships'
+      desc 'Lists all projects and groups a user is a member of. [User ID, Type]'
+
+      markdown <<~DOC
+        Filter memberships by type. Can be either Project or Namespace
+      DOC
+
+      example 'client.users.memberships(1)'
+      result <<~DOC
+        [
+          {:source_id=>57, :source_name=>"MountTargon", :source_type=>"Namespace", :access_level=>50}, ...
+        ]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(10)
+        user.memberships
+      DOC
+    end
+
+    def memberships(user_id, type = 'Project')
+      user_id = format_id(user_id)
+      client.request(:get, "users/#{user_id}/memberships", nil, { from: type })
+    end
+  end
+end

data/lib/labclient/users/search.rb

@@ -0,0 +1,22 @@
+# Top namespace
+# Uses the '/search?scope=user' endpoint
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Search' do
+      desc 'Search within users scope'
+
+      example "client.users.search 'speed'"
+      result '[#<User id: 57, username: speed>]'
+    end
+
+    # Search users
+    def search(search_string = '')
+      query = {
+        scope: :users,
+        search: search_string
+      }
+      client.request(:get, 'search', User, query)
+    end
+  end
+end

data/lib/labclient/users/show.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Show' do
+      desc 'Display a single user'
+      example 'client.users.show(5)'
+      result <<~DOC
+        user = client.users.show(5)
+        => #<User id: 5, username: "princehumperdinck">
+        user.email
+        => "princehumperdinck@florin"
+      DOC
+    end
+
+    # Display single user
+    def show(user_id)
+      user_id = format_id(user_id)
+      client.request(:get, "users/#{user_id}", User)
+    end
+  end
+end

data/lib/labclient/users/status.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Show' do
+      title 'Status'
+      desc 'Get the status of the current or target user [Optional User ID]'
+      example 'client.users.status'
+      result '{:emoji=>"smiling_imp", :message=>"Making GitLab Magic", :message_html=>"Making GitLab Magic"}'
+    end
+
+    doc 'Show' do
+      desc 'Get specific user status'
+      example 'client.users.status(12)'
+    end
+
+    def status(user_id = nil)
+      if user_id
+        user_id = format_id(user_id)
+        client.request(:get, "users/#{user_id}/status")
+      else
+        client.request(:get, 'user/status')
+      end
+    end
+  end
+end

data/lib/labclient/users/status_set.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Update' do
+      title 'Status'
+      desc 'Set the status of the current user. [Hash]'
+      example 'client.users.status_set(message: "Maaaagic")'
+      result '{:emoji=>"speech_balloon", :message=>"Maaagic", :message_html=>"Maaagic"}'
+
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description |
+        | --------- | ------ | -------- | ----------- |
+        | emoji   | string | no     | The name of the emoji to use as status, if omitted speech_balloon is used. Emoji name can be one of the specified names in the [Gemojione index](https://github.com/bonusly/gemojione/blob/master/config/index.json). |
+        | message | string | no     | The message to set as a status. It can also contain emoji codes. |
+      DOC
+    end
+
+    def status_set(query)
+      client.request(:put, 'user/status', nil, query)
+    end
+  end
+end

data/lib/labclient/users/unblock.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Update' do
+      title 'Unblock'
+      desc 'Unblocks the specified user [User ID]'
+      example 'client.users.unblock(57)'
+    end
+
+    doc 'Update' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(57)
+        user.unblock
+      DOC
+    end
+
+    def unblock(user_id)
+      user_id = format_id(user_id)
+
+      client.request(:post, "users/#{user_id}/unblock")
+    end
+  end
+end

data/lib/labclient/users/update.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Update' do
+      desc 'Modifies an existing user. Only administrators can change attributes of a user. [User ID, Hash]'
+      example 'client.users.update(57, name: "Lorenzo")'
+      result '#<User id: 57, username: speed>'
+
+      markdown <<~DOC
+        See [docs](https://docs.gitlab.com/ee/api/users.html#user-modification) for all available parameters
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(57)
+        user.update(name: 'Lorenzo')
+      DOC
+    end
+
+    def update(user_id, query)
+      user_id = format_id(user_id)
+      client.request(:put, "users/#{user_id}", User, query)
+    end
+  end
+end

data/lib/labclient/users/user.rb

@@ -0,0 +1,138 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class User < Klass
+    include ClassHelpers
+    def inspect
+      "#<User id: #{id}, username: #{username}>"
+    end
+
+    date_time_attrs %i[confirmed_at current_sign_in_at created_at last_activity_on last_sign_in_at]
+
+    def projects(query = {})
+      client.projects.user(id, query)
+    end
+
+    def starred(query = {})
+      client.projects.user(id, query)
+    end
+
+    def update(query = {})
+      update_self client.users.update(id, query)
+    end
+
+    def delete
+      client.users.delete(id)
+    end
+
+    def delete_identity(provider)
+      client.users.delete_identity(id, provider)
+    end
+
+    def status
+      client.users.status(id)
+    end
+
+    def keys
+      client.users.keys.list(id)
+    end
+
+    def key_create(query)
+      client.users.keys.create(query, id)
+    end
+
+    def key_delete(key_id)
+      client.users.keys.delete(key_id, id)
+    end
+
+    def gpg_keys
+      client.users.gpg_keys.list(id)
+    end
+
+    def gpg_key_create(key_data)
+      client.users.gpg_keys.create(key_data, id)
+    end
+
+    def gpg_key_delete(key_id)
+      client.users.gpg_keys.delete(key_id, id)
+    end
+
+    def emails
+      client.users.emails.list(id)
+    end
+
+    def email_create(email_address)
+      client.users.emails.create(email_address, id)
+    end
+
+    def email_delete(email_id)
+      client.users.emails.delete(email_id, id)
+    end
+
+    def block
+      client.users.block(id)
+    end
+
+    def unblock
+      client.users.unblock(id)
+    end
+
+    def activate
+      client.users.activate(id)
+    end
+
+    def deactivate
+      client.users.deactivate(id)
+    end
+
+    def impersonation_tokens(filter = :all)
+      client.impersonation_tokens.list(id, filter)
+    end
+
+    def impersonation_tokens_create(query)
+      client.impersonation_tokens.create(id, query)
+    end
+
+    def impersonation_tokens_revoke(token_id)
+      client.impersonation_tokens.revoke(id, token_id)
+    end
+
+    def impersonation_token(token_id)
+      client.impersonation_tokens.show(id, token_id)
+    end
+
+    def memberships(type = 'Project')
+      client.users.memberships(id, type)
+    end
+
+    help do
+      # @group_name = 'Users'
+      subtitle 'User'
+      option 'projects', 'List user owned projects [Hash]'
+      option 'starred', 'List user starred projects [Hash]'
+      option 'update', 'Update this user [Hash]'
+      option 'block', 'Block this user'
+      option 'unblock', 'Unblock this user'
+      option 'activate', 'Activate this user'
+      option 'deactivate', 'Deactivate this user'
+      option 'delete', 'Delete this user'
+      option 'delete_identity', 'Delete identity from user [Provider]'
+      option 'status', 'Show user status'
+      option 'keys', 'List user keys'
+      option 'key_create', 'Create new key for user [Hash]'
+      option 'key_delete', 'Delete key for user [Key ID]'
+      option 'status', 'Show user status'
+      option 'gpg_keys', 'List user gpg keys'
+      option 'gpg_key_create', 'Create new gpg key for user [Key Data]'
+      option 'gpg_key_delete', 'Delete gpg key for user [Key ID]'
+      option 'emails', 'List user emails'
+      option 'email_create', 'Create email for user [Email Address]'
+      option 'email_delete', 'Delete email for user [Email ID]'
+      option 'impersonation_tokens', 'List impersonation tokesn for user [Filter(Optional)]'
+      option 'impersonation_token_create', 'Create impersonation tokesn [Hash]'
+      option 'impersonation_token_revoke', 'Revoke impersonation tokesn [Token ID]'
+      option 'impersonation_token', 'Show impersonation tokesn [Token ID]'
+      option 'memberships', 'Lists all projects and groups a user is a member of [String/Type]'
+    end
+  end
+end

data/lib/labclient/version/show.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Version < Common
+    doc 'Version' do
+      desc 'Retrieve version information for this GitLab instance. Responds 200 OK for authenticated users.'
+      example 'client.version.show'
+      result <<~DOC
+        => {:version=>"12.6.4-ee", :revision=>"cc6b787e7b0"}
+      DOC
+    end
+
+    # Show
+    def show
+      client.request(:get, 'version')&.to_h
+    end
+  end
+end

data/lib/labclient/version.rb

@@ -0,0 +1,3 @@
+module LabClient
+  VERSION = '0.1.0'.freeze
+end

data/lib/labclient/wikis/create.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    doc 'Create' do
+      desc 'Creates a new wiki page for the given repository with the given title, slug, and content. [Project ID, Hash]'
+      example 'client.wikis.create(5, content: "Lots of Stuff", title: "Title!")'
+      result '#<Wiki slug: Title!>'
+
+      markdown <<~DOC
+        | Attribute        | Type    | Required | Description                  |
+        | ---------------- | ------- | -------- | ---------------------------- |
+        | content          | string  | yes      | The content of the wiki page |
+        | title            | string  | yes      | The title of the wiki page        |
+        | format | string  | no       | The format of the wiki page. Available formats are: markdown (default), rdoc, asciidoc and org |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(5)
+        project.wiki_create(title: "Special", content: "Hello World!")
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/wikis", Wiki, query)
+    end
+  end
+end

data/lib/labclient/wikis/delete.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    doc 'Delete' do
+      desc 'Deletes an existing wiki page. [Project ID, Slug]'
+      example 'client.wikis.delete(5, "Title!")'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(5)
+        project.wiki_delete("Title!")
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via Wiki'
+      example <<~DOC
+        wiki = client.wikis.show(5, "Title!")
+        wiki.delete
+      DOC
+    end
+
+    def delete(project_id, slug)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/wikis/#{slug}")
+    end
+  end
+end

data/lib/labclient/wikis/list.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    @group_name = 'Wiki'
+
+    doc 'List' do
+      desc 'Get all wiki pages for a given project. [Project ID, Include Content(Boolean)]'
+      example 'client.wikis.list(5)'
+      result ' #<Wiki slug: Home>'
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(5)
+        project.wikis.list
+      DOC
+    end
+
+    def list(project_id, with_content = false)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/wikis", Wiki, { with_content: with_content })
+    end
+  end
+end

data/lib/labclient/wikis/show.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    doc 'Show' do
+      desc 'Get a wiki page for a given project. [Project ID, Slug]'
+      example 'client.wikis.show(5,"Home")'
+      result '#<ImpersonationToken id: 7, name: User!, active: false>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(5)
+        project.wiki(:home)
+      DOC
+    end
+
+    def show(project_id, slug)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/wikis/#{slug}", Wiki)
+    end
+  end
+end

data/lib/labclient/wikis/update.rb

@@ -0,0 +1,42 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    doc 'Update' do
+      desc 'Updates an existing wiki page. [Project ID, Slug, Hash]'
+      example 'client.wikis.update(5, "Title!", content: "Updated!")'
+      result '#<Wiki slug: Title!>'
+
+      markdown <<~DOC
+        | Attribute        | Type    | Required | Description                  |
+        | ---------------- | ------- | -------- | ---------------------------- |
+        | content          | string  | yes      | The content of the wiki page |
+        | title            | string  | yes      | The title of the wiki page        |
+        | format | string  | no       | The format of the wiki page. Available formats are: markdown (default), rdoc, asciidoc and org |
+
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(5)
+        project.wiki_update("Title!", content: "Hello World!")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Wiki'
+      example <<~DOC
+        wiki = client.wikis.show(5, "Title!")
+        wiki.update(content: "Better Content!")
+      DOC
+    end
+
+    def update(project_id, slug, query)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/wikis/#{slug}", Wiki, query)
+    end
+  end
+end

data/lib/labclient/wikis/upload.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Wikis < Common
+    doc 'Upload' do
+      desc 'Uploads a file to the attachment folder inside the wiki’s repository. The attachment folder is the uploads folder. [ Project ID, File Path, Branch(Optional)]'
+      example 'client.projects.upload(25, "/tmp/text.txt")'
+      result '{:alt=>"text.txt", :url=>"/uploads/123123/text.txt", :markdown=>"[text.txt](/uploads/123123/text.txt)"}'
+    end
+
+    doc 'Upload' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.wiki_upload("/tmp/text.txt")
+      DOC
+    end
+
+    def upload(project_id, path, branch = nil)
+      project_id = format_id(project_id)
+
+      file = File.open(path, 'r')
+
+      client.request(:post, "projects/#{project_id}/wikis/attachments", nil, { file: file, branch: branch }, false)
+    end
+  end
+end

data/lib/labclient/wikis/wiki.rb

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Wiki < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Wiki slug: #{slug}>"
+    end
+
+    def web_url
+      "#{project.web_url}/-/wikis/#{slug}"
+    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.wikis.update(project_id, slug, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.wikis.delete(project_id, slug)
+    end
+
+    help do
+      @group_name = 'Wiki'
+
+      subtitle 'Wiki'
+      option 'project', 'Get Project Object'
+      option 'web_url', 'Generate Web URL to Wiki Page'
+      option 'update', 'Update this wiki page [Hash]'
+      option 'delete', 'Delete this wiki page'
+    end
+  end
+end