labclient 0.6.0 → 0.8.0

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

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTemplates < Common
+    doc 'List' do
+      desc 'Get all templates of a particular type. [Project ID, String/Symbol]'
+      example 'client.projects.templates.list(15, :issues)'
+      result '[{:key=>"Code Contributions", :name=>"Code Contributions"}, ...]'
+
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description                                                                                                                          |
+        | --------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+        | type      | string | yes      | The type of the template. Accepted values are: `dockerfiles`, `gitignores`, `gitlab_ci_ymls`, `licenses`, `issues`, `merge_requests` |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project [String/Symbol]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.templates(:issues)
+      DOC
+    end
+
+    def list(project_id, template_type)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/templates/#{template_type}")
+    end
+  end
+end

data/lib/labclient/projects/templates/show.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTemplates < Common
+    doc 'Show' do
+      desc 'Get one template of a particular type. [Project ID, Type: String/Symbol, Name: String/Symbol, Hash]'
+      example 'client.projects.templates.show(15,:issues,:elasticsearch)'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+        | Attribute                 | Type     | Required | Description                                                                                                                                                                                                                                                                        |
+        | ------------------------ | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+        | type                     | string   | yes      | The type of the template. One of: `dockerfiles`, `gitignores`, `gitlab_ci_ymls`, `licenses`, `issues`, or `merge_requests`.                                                                                                                                                        |
+        | name                     | string   | yes      | The key of the template, as obtained from the collection endpoint.                                                                                                                                                                                                                 |
+        | source_template_project_id | integer | no       | The project ID where a given template is being stored. This is useful when multiple templates from different projects have the same name. If multiple templates have the same name, the match from `closest ancestor` is returned if `source_template_project_id` is not specified. |
+        | project                  | string   | no       | The project name to use when expanding placeholders in the template. Only affects licenses.                                                                                                                                                                                        |
+        | fullname                 | string   | no       | The full name of the copyright holder to use when expanding placeholders in the template. Only affects licenses.                                                                                                                                                                   |
+
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project [String/Symbol]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.template_show(:issues, 'Elasticsearch')
+      DOC
+    end
+
+    def show(project_id, template_type, template_name, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/templates/#{template_type}/#{template_name}", body: query)
+    end
+  end
+end

data/lib/labclient/projects/transfer.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       namespace_id = format_id(namespace_id)
 
-      client.request(:put, "projects/#{project_id}/transfer", Project, { namespace: namespace_id })
+      client.request(:put, "projects/#{project_id}/transfer", klass: Project, body: { namespace: namespace_id })
     end
   end
 end

data/lib/labclient/projects/triggers/create.rb

@@ -31,7 +31,7 @@ module LabClient
       project_id = format_id(project_id)
       query = { description: description }
 
-      client.request(:post, "projects/#{project_id}/triggers", ProjectTrigger, query)
+      client.request(:post, "projects/#{project_id}/triggers", klass: ProjectTrigger, body: query)
     end
   end
 end

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

@@ -22,7 +22,7 @@ module LabClient
     def list(project_id)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/triggers", ProjectTrigger)
+      client.request(:get, "projects/#{project_id}/triggers", klass: ProjectTrigger)
     end
   end
 end

data/lib/labclient/projects/triggers/project_trigger.rb

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

data/lib/labclient/projects/triggers/show.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       trigger_id = format_id(trigger_id)
 
-      client.request(:get, "projects/#{project_id}/triggers/#{trigger_id}", ProjectTrigger)
+      client.request(:get, "projects/#{project_id}/triggers/#{trigger_id}", klass: ProjectTrigger)
     end
   end
 end

data/lib/labclient/projects/unarchive.rb

@@ -19,7 +19,7 @@ module LabClient
     def unarchive(project_id)
       project_id = format_id(project_id)
 
-      client.request(:post, "projects/#{project_id}/unarchive", Project)
+      client.request(:post, "projects/#{project_id}/unarchive", klass: Project)
     end
   end
 end

data/lib/labclient/projects/unshare.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       group_id = format_id(group_id)
 
-      client.request(:delete, "projects/#{project_id}/share/#{group_id}", nil)
+      client.request(:delete, "projects/#{project_id}/share/#{group_id}")
     end
   end
 end

data/lib/labclient/projects/update.rb

@@ -31,7 +31,7 @@ module LabClient
     def update(project_id, query = {})
       project_id = format_id(project_id)
 
-      client.request(:put, "projects/#{project_id}", Project, query)
+      client.request(:put, "projects/#{project_id}", klass: Project, body: query)
     end
   end
 end

data/lib/labclient/projects/upload.rb

@@ -4,7 +4,7 @@ module LabClient
   class Projects < Common
     doc 'Update' do
       title 'Upload'
-      desc 'Uploads a file to the specified project to be used in an issue or merge request description, or a comment. [ Project ID, File Path'
+      desc 'Uploads a file to the specified project to be used in an issue or merge request description, or a comment. [ Project ID, File Path ]'
       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
@@ -22,7 +22,7 @@ module LabClient
 
       file = File.open(path, 'r')
 
-      client.request(:post, "projects/#{project_id}/uploads", nil, { file: file }, false)
+      client.request(:post, "projects/#{project_id}/uploads", body: { file: file }, dump_json: false)
     end
   end
 end

data/lib/labclient/projects/user.rb

@@ -29,11 +29,11 @@ module LabClient
         | membership | boolean | no | Limit by projects that the current user is a member of |
         | starred | boolean | no | Limit by projects starred by the current user |
         | statistics | boolean | no | Include project statistics |
-        | with_custom_attributes | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
+        | with_custom_attributes | boolean | no | Include [custom attributes](https://docs.gitlab.com/api/custom_attributes/) in response (admins only) |
         | with_issues_enabled | boolean | no | Limit by enabled issues feature |
         | with_merge_requests_enabled | boolean | no | Limit by enabled merge requests feature |
         | with_programming_language | string | no | Limit by projects which use the given programming language |
-        | min_access_level | integer | no | Limit by current user minimal [access level](members.md) |
+        | min_access_level | integer | no | Limit by current user minimal [access level](Members) |
         | id_after                    | integer | no | Limit results to projects with IDs greater than the specified ID |
         | id_before                   | integer | no | Limit results to projects with IDs less than the specified ID |
 
@@ -46,7 +46,7 @@ module LabClient
 
       query_access_level(query, :min_access_level)
 
-      client.request(:get, "users/#{user_id}/projects", Project, query)
+      client.request(:get, "users/#{user_id}/projects", klass: Project, body: query)
     end
   end
 end

data/lib/labclient/projects/users.rb

@@ -33,7 +33,7 @@ module LabClient
     def users(project_id, query = {})
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/users", User, query)
+      client.request(:get, "projects/#{project_id}/users", klass: User, body: query)
     end
   end
 end

data/lib/labclient/projects/variables/create.rb

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

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

@@ -22,7 +22,7 @@ module LabClient
     def list(project_id)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/variables", ProjectVariable)
+      client.request(:get, "projects/#{project_id}/variables", klass: ProjectVariable)
     end
   end
 end

data/lib/labclient/projects/variables/project_variable.rb

@@ -3,6 +3,7 @@ module LabClient
   # Inspect Helper
   class ProjectVariable < Klass
     include ClassHelpers
+
     def inspect
       "#<ProjectVariable key: #{key}>"
     end
@@ -15,7 +16,7 @@ module LabClient
     def update(query)
       project_id = collect_project_id
 
-      update_self client.projects.variables.update(project_id, key, query)
+      update_self client.projects.variables.update(project_id, key, body: query)
     end
 
     def delete

data/lib/labclient/projects/variables/show.rb

@@ -21,7 +21,7 @@ module LabClient
       project_id = format_id(project_id)
       variable_id = format_id(variable_id)
 
-      client.request(:get, "projects/#{project_id}/variables/#{variable_id}", ProjectVariable)
+      client.request(:get, "projects/#{project_id}/variables/#{variable_id}", klass: ProjectVariable)
     end
   end
 end

data/lib/labclient/projects/variables/update.rb

@@ -41,7 +41,7 @@ module LabClient
       project_id = format_id(project_id)
       variable_id = format_id(variable_id)
 
-      client.request(:put, "projects/#{project_id}/variables/#{variable_id}", ProjectVariable, query)
+      client.request(:put, "projects/#{project_id}/variables/#{variable_id}", klass: ProjectVariable, body: query)
     end
   end
 end

data/lib/labclient/protected_branches/code_owner_approval.rb

@@ -20,7 +20,7 @@ module LabClient
       query = { code_owner_approval_required: approv_id }
 
       project_id = format_id(project_id)
-      client.request(:patch, "projects/#{project_id}/protected_branches/#{branch_id}", Branch, query)
+      client.request(:patch, "projects/#{project_id}/protected_branches/#{branch_id}", klass: Branch, body: query)
     end
   end
 end

data/lib/labclient/protected_branches/list.rb

@@ -29,7 +29,7 @@ module LabClient
 
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/protected_branches", Branch, query)
+      client.request(:get, "projects/#{project_id}/protected_branches", klass: Branch, body: query)
     end
   end
 end

data/lib/labclient/protected_branches/protect.rb

@@ -44,7 +44,7 @@ module LabClient
       # POST /projects/:id/protected_branches
 
       project_id = format_id(project_id)
-      client.request(:post, "projects/#{project_id}/protected_branches", Branch, query)
+      client.request(:post, "projects/#{project_id}/protected_branches", klass: Branch, body: query)
     end
   end
 end

data/lib/labclient/protected_branches/show.rb

@@ -18,7 +18,7 @@ module LabClient
 
     def show(project_id, branch_id)
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/protected_branches/#{branch_id}", Branch)
+      client.request(:get, "projects/#{project_id}/protected_branches/#{branch_id}", klass: Branch)
     end
   end
 end

data/lib/labclient/protected_branches/unprotect.rb

@@ -18,7 +18,7 @@ module LabClient
 
     def unprotect(project_id, branch_id)
       project_id = format_id(project_id)
-      client.request(:delete, "projects/#{project_id}/protected_branches/#{branch_id}", Branch)
+      client.request(:delete, "projects/#{project_id}/protected_branches/#{branch_id}", klass: Branch)
     end
   end
 end

data/lib/labclient/protected_environments/list.rb

@@ -23,7 +23,7 @@ module LabClient
     def list(project_id)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/protected_environments", ProtectedEnvironment)
+      client.request(:get, "projects/#{project_id}/protected_environments", klass: ProtectedEnvironment)
     end
   end
 end

data/lib/labclient/protected_environments/protect.rb

@@ -20,7 +20,7 @@ module LabClient
         | name                 | string         | yes      | The name of the environment.                                                                                     |
         | deploy_access_levels | array          | yes      | Array of access levels allowed to deploy, with each described by a hash.                                         |
 
-        Elements in the deploy_access_levels array should take the form {user_id: integer}, {group_id: integer} or {access_level: integer}. Each user must have access to the project and each group must have this project shared.
+        Elements in the deploy_access_levels array should take the form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must have this project shared.
 
         **Valid access levels**
 
@@ -47,7 +47,7 @@ module LabClient
       end
 
       project_id = format_id(project_id)
-      client.request(:post, "projects/#{project_id}/protected_environments", ProtectedEnvironment, query)
+      client.request(:post, "projects/#{project_id}/protected_environments", klass: ProtectedEnvironment, body: query)
     end
   end
 end

data/lib/labclient/protected_environments/protected_environment.rb

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

data/lib/labclient/protected_environments/show.rb

@@ -18,7 +18,7 @@ module LabClient
 
     def show(project_id, environment_id)
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", ProtectedEnvironment)
+      client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", klass: ProtectedEnvironment)
     end
   end
 end

data/lib/labclient/protected_tags/list.rb

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

data/lib/labclient/protected_tags/protect.rb

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

data/lib/labclient/protected_tags/show.rb

@@ -18,7 +18,7 @@ module LabClient
 
     def show(project_id, tag_id)
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/protected_tags/#{tag_id}", Tag)
+      client.request(:get, "projects/#{project_id}/protected_tags/#{tag_id}", klass: Tag)
     end
   end
 end

data/lib/labclient/protected_tags/unprotect.rb

@@ -18,7 +18,7 @@ module LabClient
 
     def unprotect(project_id, tag_id)
       project_id = format_id(project_id)
-      client.request(:delete, "projects/#{project_id}/protected_tags/#{tag_id}", Tag)
+      client.request(:delete, "projects/#{project_id}/protected_tags/#{tag_id}", klass: Tag)
     end
   end
 end

data/lib/labclient/registry/group.rb

@@ -27,7 +27,7 @@ module LabClient
     def group(group_id, query = {})
       group_id = format_id(group_id)
 
-      client.request(:get, "groups/#{group_id}/registry/repositories", RegistryRepository, query)
+      client.request(:get, "groups/#{group_id}/registry/repositories", klass: RegistryRepository, body: query)
     end
   end
 end

data/lib/labclient/registry/list.rb

@@ -25,7 +25,7 @@ module LabClient
     end
 
     def list(project_id, query = {})
-      client.request(:get, "projects/#{project_id}/registry/repositories", RegistryRepository, query)
+      client.request(:get, "projects/#{project_id}/registry/repositories", klass: RegistryRepository, body: query)
     end
   end
 end

data/lib/labclient/registry/tags/bulk.rb

@@ -24,7 +24,7 @@ module LabClient
       repository_id = format_id(repository_id)
       project_id = format_id(project_id)
 
-      client.request(:delete, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", nil, query)
+      client.request(:delete, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", body: query)
     end
   end
 end

data/lib/labclient/registry/tags/details.rb

@@ -14,7 +14,7 @@ module LabClient
       repository_id = format_id(repository_id)
       tag_name = format_id(tag_name)
 
-      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags/#{tag_name}", RegistryTag)
+      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags/#{tag_name}", klass: RegistryTag)
     end
   end
 end

data/lib/labclient/registry/tags/list.rb

@@ -21,7 +21,7 @@ module LabClient
       repository_id = format_id(repository_id)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", RegistryTag)
+      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", klass: RegistryTag)
     end
   end
 end

data/lib/labclient/repository/archive.rb

@@ -8,7 +8,7 @@ module LabClient
       example 'client.repository.archive(264)'
 
       markdown <<~DOC
-        File Path defaults to local directory '\#{project_id}\#{format}'
+        File Path defaults to local directory '`\#{project_id}\#{format}`'
 
         format is an optional suffix for the archive format. Default is tar.gz. Options are tar.gz, tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip. For example, specifying archive.zip would send an archive in ZIP format.
       DOC
@@ -26,7 +26,7 @@ module LabClient
       project_id = format_id(project_id)
       file_path ||= "#{Dir.pwd}/#{project_id}#{format}"
 
-      output = client.request(:get, "projects/#{project_id}/repository/archive#{format}", nil)
+      output = client.request(:get, "projects/#{project_id}/repository/archive#{format}")
 
       File.write(file_path, output)
     end

data/lib/labclient/repository/blob.rb

@@ -26,7 +26,7 @@ module LabClient
       project_id = format_id(project_id)
 
       raw = '/raw' if raw
-      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}#{raw}", nil)
+      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}#{raw}")
     end
   end
 end

data/lib/labclient/repository/compare.rb

@@ -25,7 +25,7 @@ module LabClient
     end
 
     def compare(project_id, query)
-      client.request(:get, "projects/#{project_id}/repository/compare", CommitDiff, query)
+      client.request(:get, "projects/#{project_id}/repository/compare", klass: CommitDiff, body: query)
     end
   end
 end

data/lib/labclient/repository/contributors.rb

@@ -39,7 +39,7 @@ module LabClient
     end
 
     def contributors(project_id, query = {})
-      client.request(:get, "projects/#{project_id}/repository/contributors", nil, query)
+      client.request(:get, "projects/#{project_id}/repository/contributors", body: query)
     end
   end
 end

data/lib/labclient/repository/merge_base.rb

@@ -32,7 +32,7 @@ module LabClient
     end
 
     def merge_base(project_id, refs)
-      client.request(:get, "projects/#{project_id}/repository/merge_base", nil, refs: refs)
+      client.request(:get, "projects/#{project_id}/repository/merge_base", body: { refs: refs })
     end
   end
 end

data/lib/labclient/repository/raw_blob.rb

@@ -21,7 +21,7 @@ module LabClient
     def blob(project_id, sha)
       project_id = format_id(project_id)
 
-      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}", nil)
+      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}")
     end
   end
 end

data/lib/labclient/repository/tree.rb

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

data/lib/labclient/resource_labels/epics/list.rb

@@ -24,7 +24,7 @@ module LabClient
       group_id = format_id(group_id)
       epic_id = format_id(epic_id)
 
-      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events", ResourceLabel)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/resource_labels/epics/show.rb

@@ -25,7 +25,7 @@ module LabClient
       epic_id = format_id(epic_id)
       resource_event_id = format_id(resource_event_id)
 
-      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events/#{resource_event_id}", ResourceLabel)
+      client.request(:get, "groups/#{group_id}/epics/#{epic_id}/resource_label_events/#{resource_event_id}", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/resource_labels/issues/list.rb

@@ -24,7 +24,7 @@ module LabClient
       project_id = format_id(project_id)
       issue_iid = format_id(issue_iid)
 
-      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events", ResourceLabel)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/resource_labels/issues/show.rb

@@ -25,7 +25,7 @@ module LabClient
       issue_iid = format_id(issue_iid)
       resource_event_id = format_id(resource_event_id)
 
-      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events/#{resource_event_id}", ResourceLabel)
+      client.request(:get, "projects/#{project_id}/issues/#{issue_iid}/resource_label_events/#{resource_event_id}", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/resource_labels/merge_requests/list.rb

@@ -24,7 +24,7 @@ module LabClient
       project_id = format_id(project_id)
       merge_request_iid = format_id(merge_request_iid)
 
-      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_iid}/resource_label_events", ResourceLabel)
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_request_iid}/resource_label_events", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/resource_labels/merge_requests/show.rb

@@ -25,7 +25,7 @@ module LabClient
       merge_requests_iid = format_id(merge_requests_iid)
       resource_event_id = format_id(resource_event_id)
 
-      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_requests_iid}/resource_label_events/#{resource_event_id}", ResourceLabel)
+      client.request(:get, "projects/#{project_id}/merge_requests/#{merge_requests_iid}/resource_label_events/#{resource_event_id}", klass: ResourceLabel)
     end
   end
 end

data/lib/labclient/runners/all.rb

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