labclient 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866bed156a753e7148f538c380d453899259cae098cca155fba3ed81517d71c7
-  data.tar.gz: 2f52c954789f226ead00127e029428f2bc32f85757112211082d0a204ecd1c53
+  metadata.gz: d74d5b878f7c98298959ec6c47bb4b81a6dcb336391eb4fae8df4f38a180d920
+  data.tar.gz: b31895a60a9f209d39f30b33b6975e173e0ce0bc557b3cab30afb6aceb65642e
 SHA512:
-  metadata.gz: 13c0c5f1201b8a4a4d77ad09b7496a6ea1c14af360e7d19cce1877467a6b6a70acb018025a36c2746532ffed98e258e6960b03436ebb24bc717d6c895f35af25
-  data.tar.gz: b1b10db7e1ab7a4ed4a428330d5fac26fead66f09c220b4147e236aa380066d40a439cb6beb60ab0afd321f4620ffe654250af6121114481d935756cc671a901
+  metadata.gz: 5548da86087095cf0093be6635ef81da29a2cec523a13834a793056898da03561039cccce12fa757b726945752362498c5673b15f5f33590c6edaf7ff14aff2c
+  data.tar.gz: 0d145b1acb0dee2c10ef8ced865a1e073791fcb1616123db9e39ffaabeb1279cff646d1ab0afd6e4a83d87771e4980c7e0ee2bea1a0162c4cc9c42cb584b1f56

data/lib/labclient/client.rb

@@ -85,7 +85,7 @@ module LabClient
         klass ? klass.new(resp.data, resp, self) : resp.data
       when Array
         if klass.nil?
-          resp.data
+          PaginatedResponse.new(Klass, resp, self)
         else
           PaginatedResponse.new(klass, resp, self)
         end

data/lib/labclient/common.rb

@@ -83,7 +83,7 @@ module LabClient
       # Valid Integer in String
       return obj_id if /\A\d+\z/.match(obj_id)
 
-      CGI.escape obj_id.to_s
+      ERB::Util.url_encode obj_id.to_s
     end
 
     def format_query_id(key, query)

data/lib/labclient/files/create.rb

@@ -47,7 +47,7 @@ module LabClient
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
       client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end

data/lib/labclient/files/delete.rb

@@ -38,7 +38,7 @@ module LabClient
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
       client.request(:delete, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end

data/lib/labclient/files/show.rb

@@ -27,25 +27,27 @@ module LabClient
       desc 'via Project'
       example <<~DOC
         project = client.projects.show(264)
-        project.file('a3c86df3f')
+        project.file('README.md')
       DOC
     end
 
     def show(project_id, file_path, ref = :main, kind = nil)
+      # LabStruct vs LabFile
+      return_kind = kind == :raw ? LabFile : nil
+
       kind = case kind
              when :raw
                '/raw'
              when :blame
                '/blame'
              end
-      # GET /projects/:id/repository/files/:file_path
 
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
-      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", LabFile, ref: ref)
+      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", return_kind, ref: ref)
     end
   end
 end

data/lib/labclient/files/update.rb

@@ -44,7 +44,7 @@ module LabClient
       project_id = format_id(project_id)
 
       # Path Name Encoding
-      file_path = CGI.escape(file_path)
+      file_path = ERB::Util.url_encode(file_path)
 
       client.request(:put, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end

data/lib/labclient/projects/methods.rb

@@ -721,6 +721,15 @@ module LabClient
       client.projects.clusters.show(id, cluster_id)
     end
 
+    # Templates
+    def templates(template_type)
+      client.projects.templates.list(id, template_type)
+    end
+
+    def template_show(template_type, template_name, query = {})
+      client.projects.templates.show(id, template_type, template_name, query)
+    end
+
     # Reload
     def reload
       update_self client.projects.show(id)

data/lib/labclient/projects/reference.rb

@@ -264,6 +264,10 @@ module LabClient
       # Clusters
       option 'clusters', 'Returns a list of project clusters.'
 
+      # Clusters
+      option 'templates', 'List Templates of Type [String/Symbol]'
+      option 'template_show', 'Get one template of a particular type [Type: String/Symbol, Name: String/Symbol, Params: Hash]'
+
       option 'events', 'List project events [Hash]'
       option 'parent', 'Show (API Call) Project Parent, returns either Group or User'
     end

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

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectTemplates < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def templates
+      ProjectTemplates.new(client)
+    end
+  end
+end

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}", nil, query)
+    end
+  end
+end

data/lib/labclient/version.rb

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

data/lib/labclient.rb

@@ -7,6 +7,9 @@ require 'gitlab_chronic_duration'
 require 'ostruct'
 require 'ougai'
 
+# Escaping Paths - https://stackoverflow.com/questions/2824126/whats-the-difference-between-uri-escape-and-cgi-escape/13059657#13059657
+require 'erb'
+
 require 'labclient/version'
 require 'labclient/logger'
 require 'labclient/docs'
@@ -266,6 +269,11 @@ require 'labclient/projects/access_requests/approve'
 require 'labclient/projects/access_requests/deny'
 require 'labclient/projects/access_requests/access_request'
 
+# Project Templates
+require 'labclient/projects/templates/client'
+require 'labclient/projects/templates/show'
+require 'labclient/projects/templates/list'
+
 # ===========================================================
 # Final Projects
 # ===========================================================

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -799,6 +799,9 @@ files:
 - lib/labclient/projects/stars/starred_projects.rb
 - lib/labclient/projects/stars/starrers.rb
 - lib/labclient/projects/submodule.rb
+- lib/labclient/projects/templates/client.rb
+- lib/labclient/projects/templates/list.rb
+- lib/labclient/projects/templates/show.rb
 - lib/labclient/projects/transfer.rb
 - lib/labclient/projects/triggers/client.rb
 - lib/labclient/projects/triggers/create.rb