labclient 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab2d7a4a0dcf9e876c42f3d92537ad03f6cc9d00391bf574188de36fa5dde3a6
-  data.tar.gz: 9bba10386c15059b97c79a0e6f0ed322af7614736b78e55fd968f362e767dd8e
+  metadata.gz: a747d261d131d7f0a228cb02753e21798c951393941247d0d4252a9c253c5650
+  data.tar.gz: 228a9181e7345f607e8d4ab6617d729f9b4b44ab7e1fdcd295db4ed3332a257d
 SHA512:
-  metadata.gz: 8998430e5b8d07584da6fe906d465238fd7725fa0773b9bb11a7b47dc755ce5fcb80d0cbb22055b16327665d70cbd034a24a63d310fabd11bd560c0ebd994f95
-  data.tar.gz: 3e61e5c568a93cfad5955198f6524349a89a06d729ead2d8f98c1d05c78e885edfb9fbb069fee2226731b26a1ab8c0404b857883f745d99c7564280e8f855b4d
+  metadata.gz: 2d66d602d12ccd265ae6b1e5aa28c0cdeabbbcc0ee678c5be80a30c42ef342e7b9308acf0a075da04cd4bbb76c744ce32d52122e0f4b87c36c9a9faf09b7834a
+  data.tar.gz: c3eaf2cb6c83effec491f071bf0e5de9f2638f68d0af5656ae146915245eb00b091d7a566ef6c28c88db562a9b71cf8b773798fd7890693b098fbc66bdfd9adb

data/lib/labclient.rb

@@ -1,6 +1,5 @@
 # Public Gems
 require 'oj'
-require 'pry'
 require 'typhoeus'
 require 'active_support/all'
 require 'amazing_print'
@@ -36,7 +35,6 @@ require 'labclient/users/current'
 require 'labclient/users/status'
 require 'labclient/users/counts'
 require 'labclient/users/activity'
-require 'labclient/users/memberships'
 require 'labclient/users/search'
 require 'labclient/users/create'
 require 'labclient/users/update'
@@ -47,6 +45,8 @@ require 'labclient/users/activate'
 require 'labclient/users/deactivate'
 require 'labclient/users/delete'
 require 'labclient/users/delete_identity'
+require 'labclient/users/memberships'
+require 'labclient/users/membership'
 require 'labclient/users/user'
 
 # ===============================================
@@ -149,6 +149,13 @@ require 'labclient/projects/environments/delete'
 require 'labclient/projects/environments/stop'
 require 'labclient/projects/environments/project_environment'
 
+# Protected Environments
+require 'labclient/protected_environments/list'
+require 'labclient/protected_environments/show'
+require 'labclient/protected_environments/protect'
+require 'labclient/protected_environments/unprotect'
+require 'labclient/protected_environments/protected_environment'
+
 # Project Deployments
 require 'labclient/projects/deployments/client'
 require 'labclient/projects/deployments/list'
@@ -352,6 +359,15 @@ require 'labclient/groups/badges/update'
 require 'labclient/groups/badges/delete'
 require 'labclient/groups/badges/group_badge'
 
+# Group Clusters
+require 'labclient/groups/clusters/client'
+require 'labclient/groups/clusters/list'
+require 'labclient/groups/clusters/show'
+require 'labclient/groups/clusters/add'
+require 'labclient/groups/clusters/update'
+require 'labclient/groups/clusters/delete'
+require 'labclient/groups/clusters/group_cluster'
+
 require 'labclient/groups/group'
 
 # Issues
@@ -852,7 +868,7 @@ require 'labclient/generator/generator'
 require 'labclient/generator/wizard'
 
 # Dynamically Require Templates (Simplify new template creation)
-Dir[File.dirname(__FILE__) + '/labclient/generator/templates/*.rb'].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/labclient/generator/templates/*.rb"].sort.each { |file| require file }
 
 # I am Very Last
 require 'labclient/client'

data/lib/labclient/access_levels.rb

@@ -2,46 +2,40 @@
 module LabClient
   # Shared Methods
   module AccessLevel
+    HUMAN_ACCESS_LEVELS = {
+      0 => :none,
+      10 => :guest,
+      20 => :reporter,
+      30 => :developer,
+      40 => :maintainer,
+      50 => :owner,
+      60 => :admin
+    }.freeze
+
+    MACHINE_ACCESS_LEVELS = {
+      none: 0,
+      guest: 10,
+      reporter: 20,
+      developer: 30,
+      maintainer: 40,
+      owner: 50,
+      admin: 60
+    }.freeze
+
     def human_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 10 then :guest
-      when 20 then :reporter
-      when 30 then :developer
-      when 40 then :maintainer
-      when 50 then :owner
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
 
     def machine_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :guest then 10
-      when :reporter then 20
-      when :developer then 30
-      when :maintainer then 40
-      when :owner then 50
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def machine_protected_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :developer then 30
-      when :maintainer then 40
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def human_protected_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 30 then :developer
-      when 40 then :maintainer
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
   end
 end

data/lib/labclient/client.rb

@@ -1,6 +1,7 @@
 # Top Namespace
 module LabClient
   # API Specifics
+  # rubocop:disable Metrics/ClassLength
   class Client
     # include HTTParty
     attr_accessor :settings, :resp, :klass, :link, :http
@@ -55,6 +56,7 @@ module LabClient
       project_runners: ProjectRunners,
       projects: Projects,
       protected_branches: ProtectedBranches,
+      protected_environments: ProtectedEnvironments,
       protected_tags: ProtectedTags,
       registry: Registry,
       repo: Repositories,
@@ -80,9 +82,16 @@ module LabClient
       subclasses.keys.sort
     end
 
-    def help
+    def help(help_filter = nil)
       puts 'Available Methods'
-      puts " - #{subclasses.keys.sort.join(' ')}\n\n"
+
+      shown_subclasses = if help_filter
+                           api_methods.grep(/#{help_filter}/)
+                         else
+                           api_methods
+                         end
+
+      puts " - #{shown_subclasses.join(' ')}\n\n"
       puts "See help for each specific sub-category\n"
       puts "- client.users.help\n"
       puts "- client.users.api_methods\n"
@@ -91,27 +100,64 @@ module LabClient
     end
 
     # Default setup, pull in settings
-    def initialize(settings = nil)
-      @settings = settings
+    def initialize(user_settings = nil)
+      @settings = user_settings
+      setup_profile if user_settings&.key?(:profile) || ENV['LABCLIENT_PROFILE']
       @settings ||= fill_configuration
 
       # Set Unspecified Defaults
       unspecified_defaults
 
-      raise 'LabClient Error - Missing URL!' if @settings[:url].nil?
+      prompt_for_url if @settings[:url].blank?
+
+      # Only prompt if explicitly set to nil
+      prompt_for_token if @settings[:token].nil?
 
       self.http = HTTP.new(@settings)
     end
 
+    def prompt_for_url
+      print 'Enter GitLab URL (e.g. https://gitlab.com): '
+      @settings[:url] = $stdin.gets.chomp
+      raise 'LabClient Error - Missing URL!' if @settings[:url].blank?
+    end
+
+    def prompt_for_token
+      print 'Enter Personal Access Token: '
+      @settings[:token] = $stdin.gets.chomp
+    end
+
     def unspecified_defaults
       @settings[:paginate] = true if @settings[:paginate].nil?
       @settings[:ssl_verify] = true if @settings[:ssl_verify].nil?
+      @settings[:quiet] = false if @settings[:quiet].nil?
     end
 
     def home_file
-      ENV['HOME'] + '/.gitlab-labclient'
+      "#{ENV['HOME']}/.gitlab-labclient"
+    end
+
+    # Easier Profile Name Access
+    def profile
+      if settings&.key? :profile
+        settings[:profile].to_sym
+      else
+        ENV['LABCLIENT_PROFILE'].to_sym
+      end
+    end
+
+    # Support for Named Profiles
+    def setup_profile
+      return false unless File.exist? home_file
+
+      config = Oj.load_file(home_file, { symbol_keys: true })
+      return false unless config.key? profile
+
+      self.settings ||= {}
+      settings.merge! config[profile]
     end
 
+    # Load default profile
     def fill_configuration
       if File.exist? home_file
         Oj.load_file(home_file, { symbol_keys: true })
@@ -135,7 +181,7 @@ module LabClient
 
       process resp
     rescue LabClient::Error => e
-      puts e.message
+      puts e.message unless settings[:quiet]
       resp
     end
 
@@ -155,4 +201,5 @@ module LabClient
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/commits/project_helpers.rb

@@ -6,6 +6,10 @@ module LabClient
       client.commits.list(id, query)
     end
 
+    def commit(commit_id, query = {})
+      client.commits.show(id, commit_id, query)
+    end
+
     def commit_create(query = {})
       client.commits.create(id, query)
     end

data/lib/labclient/commits/show.rb

@@ -16,10 +16,19 @@ module LabClient
       DOC
     end
 
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit("b539e5d3")
+      DOC
+    end
+
     # Show
-    def show(project_id, commit_id)
+    def show(project_id, commit_id, query = {})
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit, query)
     end
   end
 end

data/lib/labclient/common.rb

@@ -12,13 +12,15 @@ module LabClient
     end
 
     def api_methods
-      public_methods(false)
+      public_methods(false).sort
     end
 
-    def help
-      api_methods_help
+    def help(help_filter = nil)
+      api_methods_help(help_filter)
+
+      LabClient::Docs.docs[group_name]&.each do |key, group|
+        next if help_filter && !key.downcase.include?(help_filter.to_s)
 
-      LabClient::Docs.docs[group_name].each do |key, group|
         puts "\n=====[ #{key} ]====="
         group.select { |x| x[:example] }.each { |x| puts "#{x[:example]}\n" }
       end
@@ -26,10 +28,17 @@ module LabClient
       nil
     end
 
-    def api_methods_help
+    def api_methods_help(help_filter = nil)
       puts group_name
       puts '  Available Methods'
-      puts "      #{api_methods.sort.join(' ')}\n"
+
+      shown_subclasses = if help_filter
+                           api_methods.grep(/#{help_filter}/)
+                         else
+                           api_methods
+                         end
+
+      puts "      #{shown_subclasses.join(' ')}\n"
     end
 
     # Helper to get docs

data/lib/labclient/docs.rb

@@ -26,11 +26,11 @@ module LabClient
     # ---------------------------------
 
     # Klass Helper
-    def help
+    def help(&block)
       # require 'active_support/inflector'
       @group_name ||= group_name.pluralize
       doc 'Reference' do
-        yield
+        block.call
       end
     end
 
@@ -50,10 +50,14 @@ module LabClient
     end
 
     def desc(value)
-      # @result[:desc] = simple_format value
       @result[:desc] = value
     end
 
+    def demo(value)
+      @result[:demo_url] = "https://asciinema.org/a/#{value}.js"
+      @result[:demo] = "<script id='asciicast-#{value}' src='#{@result[:demo_url]}' data-autoplay='true' data-loop='true' async></script>"
+    end
+
     def example(value)
       @result[:example] = value
     end
@@ -81,10 +85,10 @@ module LabClient
       subnav = subgroup.gsub(' ', '_')
 
       # Title
-      subnav += '_' + @result[:title].gsub(' ', '_') if @result.key? :title
+      subnav += "_#{@result[:title].gsub(' ', '_')}" if @result.key? :title
 
       @result[:nav] = nav
-      @result[:nav] += '-' + subnav if subnav
+      @result[:nav] += "-#{subnav}" if subnav
     end
 
     def doc(subgroup)

data/lib/labclient/files/update.rb

@@ -33,7 +33,7 @@ module LabClient
       desc 'via Project'
       example <<~DOC
         project = client.projects.show(264)
-        project.file_create('other.md',
+        project.file_update('other.md',
           branch: :master,
           commit_message: "New File!",
           content: "Content!")

data/lib/labclient/generator/generator.rb

@@ -43,13 +43,13 @@ module LabClient
 
       doc 'Wizard' do
         markdown <<~DOC
-          | Setting  | Type    | Description                                            |
-          | -------- | ------- | ------------------------------------------------------ |
-          | random   | Boolean | Run Populate. Setup random Users, Projects, and Groups |
-          | count    | Hash    | Settings for random. User, Project, Group count        |
-          | password | String  | Default password for generated Users                   |
-          | domain   | String  | Defaults to client url. Default email domain for users |
-
+          | Setting           | Type    | Description                                            |
+          | ----------------- | ------- | ------------------------------------------------------ |
+          | random            | Boolean | Run Populate. Setup random Users, Projects, and Groups |
+          | count             | Hash    | Settings for random. User, Project, Group count        |
+          | password          | String  | Default password for generated Users                   |
+          | domain            | String  | Defaults to client url. Default email domain for users |
+          | skip_confirmation | Boolean | Enable/Disable skip_confirmation on new users          |
         DOC
       end
 

data/lib/labclient/generator/template_helper.rb

@@ -74,7 +74,6 @@ module LabClient
 
       def generate_group
         @group = client.groups.create(name: group_name, path: group_path)
-        # puts "#{@group.name} - #{@group.web_url}"
         raise 'Unable to Create Group' unless @group.success?
       end
     end

data/lib/labclient/generator/wizard.rb

@@ -5,7 +5,7 @@ module LabClient
     class Wizard
       include Generator::Names # Name Generator
       attr_reader :client
-      attr_accessor :count, :random, :password, :templates, :domain
+      attr_accessor :count, :random, :password, :templates, :domain, :skip_confirmation
 
       def inspect
         "#<Wizard count=#{count}, random=#{random}, domain=#{domain}> templates=#{templates}"
@@ -26,6 +26,9 @@ module LabClient
         self.random = true # Populate Random or use only Templates
         self.count = default_count
         self.password = SecureRandom.uuid
+        puts "Default Password: #{password}"
+
+        self.skip_confirmation = true
         self.domain = URI.parse(client.settings[:url]).hostname
 
         # Default Templates
@@ -61,7 +64,8 @@ module LabClient
             name: name,
             email: email,
             password: password,
-            username: username
+            username: username,
+            skip_confirmation: skip_confirmation
           )
         end
       end

data/lib/labclient/groups/clusters/add.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class GroupClusters < Common
+    doc 'Add' do
+      desc 'Adds an existing Kubernetes cluster to the group. [Group ID, Hash]'
+      example <<~DOC
+        params = {
+          name: 'cluster-5',
+          platform_kubernetes_attributes: {
+            api_url: 'https://35.111.51.20',
+            token: '12345',
+            ca_cert: "-----BEGIN .....-----END CERTIFICATE-----"
+          }
+        }
+
+          client.groups.clusters.add(310, params)
+      DOC
+
+      result '=>  #<GroupCluster id: 2, name: cluster-5>'
+    end
+
+    doc 'Add' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name      | string | yes | The name of the cluster |
+        | domain      | string | no | The base domain of the cluster |
+        | management_project_id | integer | no | The ID of the management project for the cluster |
+        | enabled      | boolean | no | Determines if cluster is active or not, defaults to true |
+        | managed      | boolean | no | Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to true |
+        | platform_kubernetes_attributes[api_url] | string | yes | The URL to access the Kubernetes API |
+        | platform_kubernetes_attributes[token] | string | yes | The token to authenticate against Kubernetes |
+        | platform_kubernetes_attributes[ca_cert] | string | no | TLS certificate. Required if API is using a self-signed TLS certificate. |
+        | platform_kubernetes_attributes[authorization_type] | string | no | The cluster authorization type: rbac, abac or unknown_authorization. Defaults to rbac. |
+        | environment_scope | string | no | The associated environment to the cluster. Defaults to * **(PREMIUM)** |
+      DOC
+    end
+
+    def add(group_id, query)
+      group_id = format_id(group_id)
+
+      client.request(:post, "groups/#{group_id}/clusters/user", GroupCluster, query)
+    end
+  end
+end