labclient 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a516961c1eaeef85e9ee1d1de52980e03aae212122fd8d1bc49a05e9d4328ac
-  data.tar.gz: 384c408eb1320f1d31e661fe153edaacad187f02a6971775d7b1afd918eaf88c
+  metadata.gz: 866bed156a753e7148f538c380d453899259cae098cca155fba3ed81517d71c7
+  data.tar.gz: 2f52c954789f226ead00127e029428f2bc32f85757112211082d0a204ecd1c53
 SHA512:
-  metadata.gz: e3b2453fa6d325e570360ca1b956261e5841901c528d8df3af44b28db7bf20081b0bd49c490e58c71055524b1ceff090ba63fb8205d6f379f0547161bfd80aec
-  data.tar.gz: 942ce7e24982e01141d664b0f4038dd4f8207ccb9f849cd74a058125aecf672c51af03e198f9e2ce7dd7f9bd35976f7e9a35fe1fe7b088240a636edd376d6d6c
+  metadata.gz: 13c0c5f1201b8a4a4d77ad09b7496a6ea1c14af360e7d19cce1877467a6b6a70acb018025a36c2746532ffed98e258e6960b03436ebb24bc717d6c895f35af25
+  data.tar.gz: b1b10db7e1ab7a4ed4a428330d5fac26fead66f09c220b4147e236aa380066d40a439cb6beb60ab0afd321f4620ffe654250af6121114481d935756cc671a901

data/lib/labclient/client/meta.rb

@@ -54,6 +54,7 @@ module LabClient
       pipelines: Pipelines,
       project_runners: ProjectRunners,
       projects: Projects,
+      terraform: Terraform,
       protected_branches: ProtectedBranches,
       protected_environments: ProtectedEnvironments,
       protected_tags: ProtectedTags,

data/lib/labclient/client.rb

@@ -84,13 +84,17 @@ module LabClient
       when LabStruct
         klass ? klass.new(resp.data, resp, self) : resp.data
       when Array
-        if @klass.nil?
+        if klass.nil?
           resp.data
         else
-          PaginatedResponse.new(@klass, resp, self)
+          PaginatedResponse.new(klass, resp, self)
         end
+        # Return Response/Status Object if there is no output otherwise
+      when NilClass
+        resp
+      # Default handler / if klass defined store plain response in data
       else
-        resp.data
+        klass ? klass.new({ data: resp.data, response: resp }, resp, self) : resp
       end
     end
   end

data/lib/labclient/files/file.rb

@@ -0,0 +1,11 @@
+# Top namespace
+module LabClient
+  # General File Wrapper
+  class LabFile < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<LabFile size: #{data&.size}>"
+    end
+  end
+end

data/lib/labclient/files/show.rb

@@ -45,7 +45,7 @@ module LabClient
       # Path Name Encoding
       file_path = CGI.escape(file_path)
 
-      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", nil, ref: ref)
+      client.request(:get, "projects/#{project_id}/repository/files/#{file_path}#{kind}", LabFile, ref: ref)
     end
   end
 end

data/lib/labclient/groups/ldap/sync.rb

@@ -18,7 +18,6 @@ module LabClient
     end
 
     def sync(group_id)
-      #   POST /groups/:id/ldap_sync
       group_id = format_id(group_id)
 
       client.request(:post, "groups/#{group_id}/ldap_sync")

data/lib/labclient/http.rb

@@ -82,15 +82,25 @@ module Typhoeus
       self
     end
 
+    # Check if response body can be parsed
+    def json_body?
+      content_type = headers['content-type']
+
+      return false unless content_type
+      return true if content_type.include? 'application/json'
+
+      false
+    end
+
     def process_body
-      if body.empty?
-        nil
-      elsif headers['content-type']&.include? 'text/plain'
-        body
-      else
+      return nil if body.empty?
+
+      if json_body?
         result = Oj.load(body, mode: :compat, symbol_keys: true, object_class: LabClient::LabStruct)
         result.instance_variable_set(:@response, self) if result.instance_of?(LabClient::LabStruct)
         result
+      else
+        body
       end
     end
 

data/lib/labclient/issues/delete.rb

@@ -3,10 +3,10 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Delete' do
-      desc 'Updates an existing project issue. This call is also used to mark an issue as closed. [Project ID, Issue IID]'
+      desc 'Only for administrators and project owners. Deletes an issue. [Project ID, Issue IID]'
       example 'client.issues.delete(5, 1)'
       result <<~DOC
-        => #<Issue id: 1, title: Moar Fancy!, state: opened>
+        => #<TyphoeusResponse code: 204>
       DOC
     end
 

data/lib/labclient/jobs/artifacts.rb

@@ -3,11 +3,15 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Artifacts' do
-      desc 'Get the job’s artifacts zipped archive of a project. [Project ID, Job ID, File Path, Job Token]'
+      desc 'Get the job’s artifacts zipped archive of a project. [Project ID, Job ID, Job Token, File Path]'
       example 'client.jobs.artifacts(264, 1)'
 
       markdown <<~DOC
-        File Output will default to the current directory + job id + file extension. 14.zip
+        ---
+
+        Two methods are available. `download_artifacts` will download and write to the local directory (or file path) and `artifacts`/`show_artifacts` which will return a `LabFile` with the key of `data` for the response result.
+
+        File Output will default to the current directory + job id + file extension. 14.zip (Still returning `LabFile`)
 
         Job Token: To be used with triggers for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`.
       DOC
@@ -16,7 +20,7 @@ module LabClient
     doc 'Artifacts' do
       desc 'Specific output location'
       example <<~DOC
-        client.jobs.artifacts(264, 1, '/tmp/output.zip')
+        client.jobs.download_artifacts(264, 1, '/tmp/output.zip')
       DOC
     end
 
@@ -24,6 +28,7 @@ module LabClient
       desc 'via Project'
       example <<~DOC
         project = client.projects.show(264)
+        project.job_download_artifacts(7)
         project.job_artifacts(7)
       DOC
     end
@@ -32,18 +37,29 @@ module LabClient
       desc 'via Job'
       example <<~DOC
         job = client.jobs.show(264, 7)
-        job.artifacts
+        job.download_artifacts
+        job.show_artifacts
       DOC
     end
 
-    def artifacts(project_id, job_id, file_path = nil, job_token = nil)
+    def artifacts(project_id, job_id, job_token = nil)
       job_id = format_id(job_id)
       project_id = format_id(project_id)
-      file_path ||= "#{Dir.pwd}/#{job_id}.zip"
       query = { job_token: job_token } if job_token
-      output = client.request(:get, "projects/#{project_id}/jobs/#{job_id}/artifacts", nil, query)
 
-      File.write(file_path, output)
+      # Don't try to process output
+      client.request(:get, "projects/#{project_id}/jobs/#{job_id}/artifacts", LabFile, query)
+    end
+
+    # Helper to write immediately to a file
+    def download_artifacts(project_id, job_id, file_path = nil, job_token = nil)
+      file_path ||= "#{Dir.pwd}/#{job_id}.zip"
+      output = artifacts(project_id, job_id, job_token)
+
+      File.write(file_path, output.data) if output.success?
+
+      # Return LabFile
+      output
     end
   end
 end

data/lib/labclient/jobs/job.rb

@@ -17,9 +17,16 @@ module LabClient
       Pipeline.new(@table[:pipeline], response, client)
     end
 
-    def artifacts(file_path = nil, job_token = nil)
+    # File Write Response
+    def download_artifacts(file_path = nil, job_token = nil)
       project_id = collect_project_id
-      client.jobs.artifacts(project_id, id, file_path, job_token)
+      client.jobs.download_artifacts(project_id, id, job_token, file_path)
+    end
+
+    # LabFile Response
+    def show_artifacts(job_token = nil)
+      project_id = collect_project_id
+      client.jobs.artifacts(project_id, id, job_token)
     end
 
     def artifacts_path(artifacts_path, file_path = nil)
@@ -65,7 +72,7 @@ module LabClient
     help do
       @group_name = 'Jobs'
       subtitle 'Job'
-      option 'artifacts', 'Download Job artifacts. [File Path, Job Token]'
+      option 'download_artifacts', 'Download Job artifacts. [File Path, Job Token]'
       option 'artifacts_path', 'Download Job artifacts path. [File Path, Output Path]'
       option 'trace', 'Get Job Output'
       option 'cancel', 'Cancel Job'

data/lib/labclient/projects/methods.rb

@@ -226,8 +226,12 @@ module LabClient
       client.jobs.show(id, job_id)
     end
 
-    def job_artifacts(job_id, file_path = nil, job_token = nil)
-      client.jobs.artifacts(id, job_id, file_path, job_token)
+    def job_download_artifacts(job_id, file_path = nil, job_token = nil)
+      client.jobs.download_artifacts(id, job_id, file_path, job_token)
+    end
+
+    def job_artifacts(job_id, job_token = nil)
+      client.jobs.artifacts(id, job_id,  job_token)
     end
 
     def job_artifacts_latest(branch_name, job_name, file_path = nil, job_token = nil)

data/lib/labclient/registry/repository.rb

@@ -17,6 +17,11 @@ module LabClient
       client.registry.tags(project_id, id)
     end
 
+    def delete
+      project_id = collect_project_id
+      client.registry.delete(project_id, id)
+    end
+
     help do
       @group_name = 'Registry'
       subtitle 'Registry Repository'

data/lib/labclient/terraform/create.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Terraform < Common
+    doc 'Create' do
+      desc 'Creates a new State. [Project ID, StateName, LockID, Hash]'
+      example 'client.terraform.create(5, {})'
+      result '#<TerraformState serial: 4>'
+
+      markdown <<~DOC
+        Attributes for Hash
+
+        ID,Operation,Info,Who,Version,Created,Path
+      DOC
+    end
+
+    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)
+    end
+  end
+end

data/lib/labclient/terraform/delete.rb

@@ -0,0 +1,16 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Terraform < Common
+    doc 'Delete' do
+      desc 'Delete Terraform State. [Project ID, StateName]'
+      example 'client.terraform.delete(5, :state_name)'
+    end
+
+    def delete(project_id, name)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/terraform/state/#{name}")
+    end
+  end
+end

data/lib/labclient/terraform/lock.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Terraform < Common
+    doc 'Lock' do
+      desc 'Locks a new State. [Project ID, Hash]'
+      example 'client.wikis.Lock(5, content: "Lots of Stuff", title: "Title!")'
+      result '#<TerraformState slug: Title!>'
+    end
+
+    def lock(project_id, name, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/terraform/state/#{name}/lock", nil, query)
+    end
+  end
+end

data/lib/labclient/terraform/show.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Terraform < Common
+    doc 'Show' do
+      desc 'Collect Terraform State Information'
+      example 'client.terraform.show(264, "README.md")'
+
+      markdown <<~DOC
+        Ref will default to `main`
+
+        Kind can be left empty or set to either :raw or :blame
+      DOC
+    end
+
+    def show(project_id, name)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/terraform/state/#{name}", TerraformState)
+    end
+  end
+end

data/lib/labclient/terraform/terraform_state.rb

@@ -0,0 +1,11 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class TerraformState < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<TerraformState serial: #{serial}>"
+    end
+  end
+end

data/lib/labclient/terraform/unlock.rb

@@ -0,0 +1,16 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Terraform < Common
+    doc 'Lock' do
+      desc 'Unlock State [Project ID, StateName Lock ID]'
+      example 'client.terraform.lock(5, :state_name, 123)'
+    end
+
+    def unlock(project_id, name, xid)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/terraform/state/#{name}/lock?ID=#{xid}")
+    end
+  end
+end

data/lib/labclient/version.rb

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

data/lib/labclient.rb

@@ -778,12 +778,6 @@ require 'labclient/repository/compare'
 require 'labclient/repository/contributors'
 require 'labclient/repository/merge_base'
 
-# Files
-require 'labclient/files/show'
-require 'labclient/files/create'
-require 'labclient/files/update'
-require 'labclient/files/delete'
-
 # Branches
 require 'labclient/branches/list'
 require 'labclient/branches/show'
@@ -866,6 +860,21 @@ require 'labclient/feature_flags/delete'
 require 'labclient/feature_flags/list'
 require 'labclient/feature_flags/feature_flag'
 
+# Files
+require 'labclient/files/file'
+require 'labclient/files/show'
+require 'labclient/files/create'
+require 'labclient/files/update'
+require 'labclient/files/delete'
+
+# Terraform
+require 'labclient/terraform/create'
+require 'labclient/terraform/lock'
+require 'labclient/terraform/unlock'
+require 'labclient/terraform/delete'
+require 'labclient/terraform/show'
+require 'labclient/terraform/terraform_state'
+
 require 'labclient/resource_labels/resource_label'
 
 # Generators

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -449,6 +449,7 @@ files:
 - lib/labclient/feature_flags/list.rb
 - lib/labclient/files/create.rb
 - lib/labclient/files/delete.rb
+- lib/labclient/files/file.rb
 - lib/labclient/files/show.rb
 - lib/labclient/files/update.rb
 - lib/labclient/generator/generator.rb
@@ -892,6 +893,12 @@ files:
 - lib/labclient/tags/show.rb
 - lib/labclient/tags/tag.rb
 - lib/labclient/tags/update.rb
+- lib/labclient/terraform/create.rb
+- lib/labclient/terraform/delete.rb
+- lib/labclient/terraform/lock.rb
+- lib/labclient/terraform/show.rb
+- lib/labclient/terraform/terraform_state.rb
+- lib/labclient/terraform/unlock.rb
 - lib/labclient/todos/list.rb
 - lib/labclient/todos/mark_all_done.rb
 - lib/labclient/todos/mark_done.rb