labclient 0.6.0 → 0.8.0

data/lib/labclient/runners/create.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Runners < Common
+    doc 'Create' do
+      desc 'Create a runner linked to a user [Hash]'
+      example 'client.runners.create(:instance_type, description: :rawr)'
+      result '#<Runner id: 3, status: online>'
+      markdown <<~DOC
+        Note: This is the new [Runner Registration Workflow](https://docs.gitlab.com/ci/runners/new_creation_workflow/), GitLab 16.0+#{'  '}
+
+
+        | Attribute          | Type         | Required | Description |
+        |-------------------|-------------|---------|------------|
+        | `runner_type`      | string       | yes      | Specifies the scope of the runner; `instance_type`, `group_type`, or `project_type`. |
+        | `group_id`         | integer      | no       | The ID of the group that the runner is created in. Required if `runner_type` is `group_type`. |
+        | `project_id`       | integer      | no       | The ID of the project that the runner is created in. Required if `runner_type` is `project_type`. |
+        | `description`      | string       | no       | Description of the runner. |
+        | `paused`           | boolean      | no       | Specifies if the runner should ignore new jobs. |
+        | `locked`           | boolean      | no       | Specifies if the runner should be locked for the current project. |
+        | `run_untagged`     | boolean      | no       | Specifies if the runner should handle untagged jobs. |
+        | `tag_list`         | string array | no       | A list of runner tags. |
+        | `access_level`     | string       | no       | The access level of the runner; `not_protected` or `ref_protected`. |
+        | `maximum_timeout`  | integer      | no       | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs. |
+        | `maintenance_note` | string       | no       | Free-form maintenance notes for the runner (1024 characters). |
+      DOC
+    end
+
+    def create(query)
+      client.request(:post, 'user/runners', klass: Runner, body: query)
+    end
+  end
+end

data/lib/labclient/runners/delete.rb

@@ -8,7 +8,7 @@ module LabClient
     end
 
     def delete(token)
-      client.request(:delete, 'runners', nil, token: token)
+      client.request(:delete, 'runners', body: { token: token })
     end
   end
 end

data/lib/labclient/runners/jobs.rb

@@ -19,7 +19,7 @@ module LabClient
 
     def jobs(runner_id, query = {})
       runner_id = format_id(runner_id)
-      client.request(:get, "runners/#{runner_id}/jobs", Job, query)
+      client.request(:get, "runners/#{runner_id}/jobs", klass: Job, body: query)
     end
   end
 end

data/lib/labclient/runners/list.rb

@@ -18,7 +18,7 @@ module LabClient
     end
 
     def list(query = {})
-      client.request(:get, 'runners', Runner, query)
+      client.request(:get, 'runners', klass: Runner, body: query)
     end
   end
 end

data/lib/labclient/runners/register.rb

@@ -24,7 +24,7 @@ module LabClient
     end
 
     def register(query)
-      client.request(:post, 'runners', nil, query)
+      client.request(:post, 'runners', body: query)
     end
   end
 end

data/lib/labclient/runners/runner.rb

@@ -17,11 +17,11 @@ module LabClient
     end
 
     def jobs(query = {})
-      client.runners.jobs(id, query)
+      client.runners.jobs(id, body: query)
     end
 
     def update(query)
-      update_self client.runners.update(id, query)
+      update_self client.runners.update(id, body: query)
     end
 
     def verify

data/lib/labclient/runners/show.rb

@@ -10,7 +10,7 @@ module LabClient
 
     def show(runner_id)
       runner_id = format_id(runner_id)
-      client.request(:get, "runners/#{runner_id}", Runner)
+      client.request(:get, "runners/#{runner_id}", klass: Runner)
     end
   end
 end

data/lib/labclient/runners/update.rb

@@ -39,7 +39,7 @@ module LabClient
     def update(runner_id, query)
       runner_id = format_id(runner_id)
 
-      client.request(:put, "runners/#{runner_id}", Runner, query)
+      client.request(:put, "runners/#{runner_id}", klass: Runner, body: query)
     end
   end
 end

data/lib/labclient/runners/verify.rb

@@ -16,7 +16,7 @@ module LabClient
     end
 
     def verify(token)
-      client.request(:post, 'runners/verify', nil, token: token)
+      client.request(:post, 'runners/verify', body: { token: token })
     end
   end
 end

data/lib/labclient/search/search.rb

@@ -9,9 +9,9 @@ module LabClient
       desc 'Lots! Search Scopes are on each of the individual scope endpoints'
 
       markdown <<~DOC
-        - <a target="_blank" href="/labclient/#Users-Search">Users</a>
-        - <a target="_blank" href="/labclient/#Projects-Search">Projects</a>
-        - <a target="_blank" href="/labclient/#Groups-Search">Groups</a>
+        - [Users](Users#search)
+        - [Projects](Projects#search)
+        - [Groups](Groups#search)
       DOC
     end
   end

data/lib/labclient/snippets/create.rb

@@ -11,7 +11,7 @@ module LabClient
         | file_name    | string | yes      | Name of a snippet file.                            |
         | content      | string | yes      | Content of a snippet.                              |
         | description  | string | no       | Description of a snippet.                          |
-        | visibility   | string | no       | Snippet's [visibility](#snippet-visibility-level). |
+        | visibility   | string | no       | Snippet's [visibility](https://docs.gitlab.com/api/snippets/#snippet-visibility-level). |
       DOC
     end
 
@@ -32,7 +32,7 @@ module LabClient
 
     # Create
     def create(query = {})
-      client.request(:post, 'snippets', Snippet, query)
+      client.request(:post, 'snippets', klass: Snippet, body: query)
     end
   end
 end

data/lib/labclient/snippets/list.rb

@@ -12,7 +12,7 @@ module LabClient
 
     # List
     def list
-      client.request(:get, 'snippets', Snippet)
+      client.request(:get, 'snippets', klass: Snippet)
     end
   end
 end

data/lib/labclient/snippets/public.rb

@@ -20,7 +20,7 @@ module LabClient
     end
 
     def public(query = {})
-      client.request(:get, 'snippets/public', Snippet, query)
+      client.request(:get, 'snippets/public', klass: Snippet, body: query)
     end
   end
 end

data/lib/labclient/snippets/show.rb

@@ -12,7 +12,7 @@ module LabClient
 
     # Show Specific
     def show(snippet_id = nil)
-      client.request(:get, "snippets/#{snippet_id}", Snippet)
+      client.request(:get, "snippets/#{snippet_id}", klass: Snippet)
     end
   end
 end

data/lib/labclient/snippets/update.rb

@@ -11,7 +11,7 @@ module LabClient
         | file_name    | string | no       | Name of a snippet file.                            |
         | content      | string | no       | Content of a snippet.                              |
         | description  | string | no       | Description of a snippet.                          |
-        | visibility   | string | no       | Snippet's [visibility](#snippet-visibility-level). |
+        | visibility   | string | no       | Snippet's [visibility](https://docs.gitlab.com/api/snippets/#snippet-visibility-level). |
       DOC
     end
 
@@ -40,7 +40,7 @@ module LabClient
 
     # Update
     def update(snippet_id = nil, query = {})
-      client.request(:put, "snippets/#{snippet_id}", Snippet, query)
+      client.request(:put, "snippets/#{snippet_id}", klass: Snippet, body: query)
     end
   end
 end

data/lib/labclient/system_hooks/add.rb

@@ -27,7 +27,7 @@ module LabClient
 
     # Add
     def add(query = {})
-      client.request(:post, 'hooks', SystemHook, query)
+      client.request(:post, 'hooks', klass: SystemHook, body: query)
     end
   end
 end

data/lib/labclient/system_hooks/list.rb

@@ -11,7 +11,7 @@ module LabClient
     end
 
     def list
-      client.request(:get, 'hooks', SystemHook)
+      client.request(:get, 'hooks', klass: SystemHook)
     end
   end
 end

data/lib/labclient/system_hooks/system_hook.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class SystemHook < Klass
     include ClassHelpers
+
     def inspect
       "#<SystemHook id: #{id}, url: #{url}>"
     end

data/lib/labclient/tags/create.rb

@@ -28,7 +28,7 @@ module LabClient
     def create(project_id, query)
       project_id = format_id(project_id)
 
-      client.request(:post, "projects/#{project_id}/repository/tags", Tag, query)
+      client.request(:post, "projects/#{project_id}/repository/tags", klass: Tag, body: query)
     end
   end
 end

data/lib/labclient/tags/delete.rb

@@ -19,7 +19,7 @@ module LabClient
       project_id = format_id(project_id)
       tag_id = format_id(tag_id)
 
-      client.request(:delete, "projects/#{project_id}/repository/tags/#{tag_id}", Tag)
+      client.request(:delete, "projects/#{project_id}/repository/tags/#{tag_id}", klass: Tag)
     end
   end
 end

data/lib/labclient/tags/list.rb

@@ -28,7 +28,7 @@ module LabClient
     def list(project_id, query = {})
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/repository/tags", Tag, query)
+      client.request(:get, "projects/#{project_id}/repository/tags", klass: Tag, body: query)
     end
   end
 end

data/lib/labclient/tags/release.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       tag_id = format_id(tag_id)
 
-      client.request(:post, "projects/#{project_id}/repository/tags/#{tag_id}/release", nil, description: description)
+      client.request(:post, "projects/#{project_id}/repository/tags/#{tag_id}/release", body: { description: description })
     end
   end
 end

data/lib/labclient/tags/show.rb

@@ -20,7 +20,7 @@ module LabClient
       project_id = format_id(project_id)
       tag_id = format_id(tag_id)
 
-      client.request(:get, "projects/#{project_id}/repository/tags/#{tag_id}", Tag)
+      client.request(:get, "projects/#{project_id}/repository/tags/#{tag_id}", klass: Tag)
     end
   end
 end

data/lib/labclient/tags/tag.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class Tag < Klass
     include ClassHelpers
+
     date_time_attrs %i[authored_date committed_date created_at]
 
     def inspect

data/lib/labclient/tags/update.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       tag_id = format_id(tag_id)
 
-      client.request(:put, "projects/#{project_id}/repository/tags/#{tag_id}/release", nil, description: description)
+      client.request(:put, "projects/#{project_id}/repository/tags/#{tag_id}/release", body: { description: description })
     end
   end
 end

data/lib/labclient/terraform/create.rb

@@ -17,7 +17,7 @@ module LabClient
     def create(project_id, name, xid, body)
       project_id = format_id(project_id)
 
-      client.request(:post, "projects/#{project_id}/terraform/state/#{name}?ID=#{xid}", nil, body)
+      client.request(:post, "projects/#{project_id}/terraform/state/#{name}?ID=#{xid}", body: body)
     end
   end
 end

data/lib/labclient/terraform/lock.rb

@@ -11,7 +11,7 @@ module LabClient
     def lock(project_id, name, query)
       project_id = format_id(project_id)
 
-      client.request(:post, "projects/#{project_id}/terraform/state/#{name}/lock", nil, query)
+      client.request(:post, "projects/#{project_id}/terraform/state/#{name}/lock", body: query)
     end
   end
 end

data/lib/labclient/terraform/show.rb

@@ -16,7 +16,7 @@ module LabClient
     def show(project_id, name)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/terraform/state/#{name}", TerraformState)
+      client.request(:get, "projects/#{project_id}/terraform/state/#{name}", klass: TerraformState)
     end
   end
 end

data/lib/labclient/todos/list.rb

@@ -30,7 +30,7 @@ module LabClient
 
     # List
     def list(query = {})
-      client.request(:get, 'todos', Todo, query)
+      client.request(:get, 'todos', klass: Todo, body: query)
     end
   end
 end

data/lib/labclient/todos/mark_done.rb

@@ -23,7 +23,7 @@ module LabClient
 
     # Mark as Done
     def mark_as_done(todo_id)
-      client.request(:post, "todos/#{todo_id}/mark_as_done", Todo)
+      client.request(:post, "todos/#{todo_id}/mark_as_done", klass: Todo)
     end
   end
 end

data/lib/labclient/users/activity.rb

@@ -17,7 +17,7 @@ module LabClient
     def activity(from_date)
       query = { from: from_date }
       query_format_time(query, :from)
-      client.request(:get, 'user/activities', nil, query)
+      client.request(:get, 'user/activities', body: query)
     end
   end
 end

data/lib/labclient/users/create.rb

@@ -19,7 +19,7 @@ module LabClient
     end
 
     def create(query)
-      client.request(:post, 'users', User, query)
+      client.request(:post, 'users', klass: User, body: query)
     end
   end
 end

data/lib/labclient/users/current.rb

@@ -19,9 +19,9 @@ module LabClient
     def current(sudo_id = nil)
       if sudo_id
         sudo_id = format_id(sudo_id)
-        client.request(:get, 'user', User, sudo: sudo_id)
+        client.request(:get, 'user', klass: User, body: { sudo: sudo_id })
       else
-        client.request(:get, 'user', User)
+        client.request(:get, 'user', klass: User)
       end
     end
   end

data/lib/labclient/users/email/create.rb

@@ -28,9 +28,9 @@ module LabClient
 
       if user_id
         user_id = format_id(user_id)
-        client.request(:post, "users/#{user_id}/emails", Email, query)
+        client.request(:post, "users/#{user_id}/emails", klass: Email, body: query)
       else
-        client.request(:post, 'user/emails', Email, query)
+        client.request(:post, 'user/emails', klass: Email, body: query)
       end
     end
   end

data/lib/labclient/users/email/list.rb

@@ -24,9 +24,9 @@ module LabClient
     def list(user_id = nil)
       if user_id
         user_id = format_id(user_id)
-        client.request(:get, "users/#{user_id}/emails", Email)
+        client.request(:get, "users/#{user_id}/emails", klass: Email)
       else
-        client.request(:get, 'user/emails', Email)
+        client.request(:get, 'user/emails', klass: Email)
       end
     end
   end

data/lib/labclient/users/email/show.rb

@@ -11,7 +11,7 @@ module LabClient
     def show(email_id)
       email_id = format_id(email_id)
 
-      client.request(:get, "user/emails/#{email_id}", Email)
+      client.request(:get, "user/emails/#{email_id}", klass: Email)
     end
   end
 end

data/lib/labclient/users/gpg/create.rb

@@ -28,9 +28,9 @@ module LabClient
 
       if user_id
         user_id = format_id(user_id)
-        client.request(:post, "users/#{user_id}/gpg_keys", GpgKey, query)
+        client.request(:post, "users/#{user_id}/gpg_keys", klass: GpgKey, body: query)
       else
-        client.request(:post, 'user/gpg_keys', GpgKey, query)
+        client.request(:post, 'user/gpg_keys', klass: GpgKey, body: query)
       end
     end
   end

data/lib/labclient/users/gpg/list.rb

@@ -24,9 +24,9 @@ module LabClient
     def list(user_id = nil)
       if user_id
         user_id = format_id(user_id)
-        client.request(:get, "users/#{user_id}/gpg_keys", GpgKey)
+        client.request(:get, "users/#{user_id}/gpg_keys", klass: GpgKey)
       else
-        client.request(:get, 'user/gpg_keys', GpgKey)
+        client.request(:get, 'user/gpg_keys', klass: GpgKey)
       end
     end
   end

data/lib/labclient/users/gpg/show.rb

@@ -11,7 +11,7 @@ module LabClient
     def show(key_id)
       key_id = format_id(key_id)
 
-      client.request(:get, "user/gpg_keys/#{key_id}", GpgKey)
+      client.request(:get, "user/gpg_keys/#{key_id}", klass: GpgKey)
     end
   end
 end

data/lib/labclient/users/keys/create.rb

@@ -33,9 +33,9 @@ module LabClient
     def create(query, user_id = nil)
       if user_id
         user_id = format_id(user_id)
-        client.request(:post, "users/#{user_id}/keys", Key, query)
+        client.request(:post, "users/#{user_id}/keys", klass: Key, body: query)
       else
-        client.request(:post, 'user/keys', Key, query)
+        client.request(:post, 'user/keys', klass: Key, body: query)
       end
     end
   end

data/lib/labclient/users/keys/list.rb

@@ -24,9 +24,9 @@ module LabClient
     def list(user_id = nil)
       if user_id
         user_id = format_id(user_id)
-        client.request(:get, "users/#{user_id}/keys", Key)
+        client.request(:get, "users/#{user_id}/keys", klass: Key)
       else
-        client.request(:get, 'user/keys', Key)
+        client.request(:get, 'user/keys', klass: Key)
       end
     end
   end

data/lib/labclient/users/keys/show.rb

@@ -11,7 +11,7 @@ module LabClient
     def show(key_id)
       key_id = format_id(key_id)
 
-      client.request(:get, "user/keys/#{key_id}", Key)
+      client.request(:get, "user/keys/#{key_id}", klass: Key)
     end
   end
 end

data/lib/labclient/users/list.rb

@@ -58,7 +58,7 @@ module LabClient
 
     # List/Search users
     def list(query = {})
-      client.request(:get, 'users', User, query)
+      client.request(:get, 'users', klass: User, body: query)
     end
   end
 end

data/lib/labclient/users/memberships.rb

@@ -33,7 +33,7 @@ module LabClient
 
       query = nil
       query = { type: type } if type
-      client.request(:get, "users/#{user_id}/memberships", Membership, query)
+      client.request(:get, "users/#{user_id}/memberships", klass: Membership, body: query)
     end
   end
 end

data/lib/labclient/users/search.rb

@@ -16,7 +16,7 @@ module LabClient
         scope: :users,
         search: search_string
       }
-      client.request(:get, 'search', User, query)
+      client.request(:get, 'search', klass: User, body: query)
     end
   end
 end

data/lib/labclient/users/show.rb

@@ -16,7 +16,7 @@ module LabClient
     # Display single user
     def show(user_id)
       user_id = format_id(user_id)
-      client.request(:get, "users/#{user_id}", User)
+      client.request(:get, "users/#{user_id}", klass: User)
     end
   end
 end

data/lib/labclient/users/status_set.rb

@@ -17,7 +17,7 @@ module LabClient
     end
 
     def status_set(query)
-      client.request(:put, 'user/status', nil, query)
+      client.request(:put, 'user/status', body: query)
     end
   end
 end

data/lib/labclient/users/update.rb

@@ -22,7 +22,7 @@ module LabClient
 
     def update(user_id, query)
       user_id = format_id(user_id)
-      client.request(:put, "users/#{user_id}", User, query)
+      client.request(:put, "users/#{user_id}", klass: User, body: query)
     end
   end
 end

data/lib/labclient/users/user.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class User < Klass
     include ClassHelpers
+
     def inspect
       "#<User id: #{id}, username: #{username}>"
     end
@@ -10,15 +11,15 @@ module LabClient
     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)
+      client.projects.user(id, body: query)
     end
 
     def starred(query = {})
-      client.projects.user(id, query)
+      client.projects.user(id, body: query)
     end
 
     def update(query = {})
-      update_self client.users.update(id, query)
+      update_self client.users.update(id, body: query)
     end
 
     def delete
@@ -98,7 +99,7 @@ module LabClient
     end
 
     def impersonation_tokens_create(query)
-      client.impersonation_tokens.create(id, query)
+      client.impersonation_tokens.create(id, body: query)
     end
 
     def impersonation_tokens_revoke(token_id)
@@ -115,7 +116,7 @@ module LabClient
 
     # Events
     def events(query = {})
-      client.events.user(id, query)
+      client.events.user(id, body: query)
     end
 
     # Reload Helper
@@ -124,7 +125,6 @@ module LabClient
     end
 
     help do
-      # @group_name = 'Users'
       subtitle 'User'
       option 'projects', 'List user owned projects [Hash]'
       option 'starred', 'List user starred projects [Hash]'

data/lib/labclient/version.rb

@@ -1,6 +1,6 @@
 # Overall version
 module LabClient
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.8.0'.freeze
 
   # Make it easy to print version
   def self.version

data/lib/labclient/wikis/create.rb

@@ -27,7 +27,7 @@ module LabClient
     def create(project_id, query)
       project_id = format_id(project_id)
 
-      client.request(:post, "projects/#{project_id}/wikis", Wiki, query)
+      client.request(:post, "projects/#{project_id}/wikis", klass: Wiki, body: query)
     end
   end
 end

data/lib/labclient/wikis/list.rb

@@ -20,7 +20,7 @@ module LabClient
 
     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 })
+      client.request(:get, "projects/#{project_id}/wikis", klass: Wiki, body: { with_content: with_content })
     end
   end
 end