labclient 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab2d7a4a0dcf9e876c42f3d92537ad03f6cc9d00391bf574188de36fa5dde3a6
-  data.tar.gz: 9bba10386c15059b97c79a0e6f0ed322af7614736b78e55fd968f362e767dd8e
+  metadata.gz: '09bb30f5014cb0b4a37d7f4aa421549337b6177bf132580974cf1a35199c6242'
+  data.tar.gz: cc354dc398276bba64db00bc9adafd23e9c341eba16c4c2dd315788f3ab72fb1
 SHA512:
-  metadata.gz: 8998430e5b8d07584da6fe906d465238fd7725fa0773b9bb11a7b47dc755ce5fcb80d0cbb22055b16327665d70cbd034a24a63d310fabd11bd560c0ebd994f95
-  data.tar.gz: 3e61e5c568a93cfad5955198f6524349a89a06d729ead2d8f98c1d05c78e885edfb9fbb069fee2226731b26a1ab8c0404b857883f745d99c7564280e8f855b4d
+  metadata.gz: f492cb23a182293f165733d7d54830a2a34b9666c487cf63b5bd2dded2dbd58a7713f513eeba0813e382f1efe0d2c50cb8204f485678448b76f109bf289b8887
+  data.tar.gz: 0d558d85cea6f58bddf600dd36962b9a3fe1bc0c91e9b398ff6d2c35103fd61d88e4b6d47d24aa06bff15a5c2c195561847f495400ddef1eabaf78cfd7c65498

data/lib/labclient.rb

@@ -36,7 +36,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 +46,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 +150,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'

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,
@@ -91,18 +93,33 @@ 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?
@@ -112,6 +129,27 @@ module 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 })
@@ -155,4 +193,5 @@ module LabClient
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

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/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/members/member.rb

@@ -51,6 +51,7 @@ module LabClient
       option 'level', 'Humanized symbol of access level. e.g. :developer'
       option 'user', 'Collect user object.'
       option '<permission>?', 'True/False evaluation each guest?, developer? etc'
+      option 'greater_than', 'True/False if user has greater than [Permission Name]'
     end
   end
 end

data/lib/labclient/overview.rb

@@ -44,6 +44,41 @@ module LabClient
       DOC
     end
 
+    doc 'Authentication' do
+      title 'Named Profiles'
+      markdown 'Within the `~/.gitlab-labclient` you can also specify profile names'
+      example <<~DOC
+        {
+          "prod": {
+            "url": "https://labclient-prod",
+            "token": "super_secure",
+            "paginate": false
+          },
+          "dev": {
+            "url": "https://labclient-dev",
+            "token": "super_secure",
+            "ssl_verify": false,
+            "paginate": true
+          }
+        }
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Manually select a named profile'
+      example <<~DOC
+        client = LabClient::Client.new(profile: 'prod')
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Automatically select via ENV Variables'
+      example <<~DOC
+        ENV['LABCLIENT_PROFILE'] = 'dev'
+        client = LabClient::Client.new
+      DOC
+    end
+
     doc 'Authentication' do
       title 'Environment Variables'
       desc 'If not provided, and credentials file does not exist will attempt to use ENV variables'
@@ -252,21 +287,6 @@ module LabClient
       DOC
     end
 
-    doc 'Other' do
-      title 'Docker'
-      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
-
-      example 'docker run -it registry.gitlab.com/labclient/labclient'
-
-      result <<~DOC
-        # Run Container
-        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="token" registry.gitlab.com/labclient/labclient
-
-        client = LabClient::Client.new
-        client.users.list
-      DOC
-    end
-
     doc 'Other' do
       title 'Curl'
       desc 'Sometimes you just wana have a curl example to test or send someone'
@@ -291,6 +311,30 @@ module LabClient
         - [API Authentication](https://docs.gitlab.com/ee/api/README.html#authentication)
       DOC
     end
+
+    doc 'Docker' do
+      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        # Run Container
+        docker run -it registry.gitlab.com/labclient/labclient
+        # Without settings configured, initial will prompt for credentials
+
+        client.users.list
+      DOC
+    end
+
+    doc 'Docker' do
+      desc 'The docker container configured and execute code snippets'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="secure_token" labclient 'puts client.users.list.count'
+      DOC
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/labclient/projects/methods.rb

@@ -492,6 +492,23 @@ module LabClient
       client.projects.environments.stop(id, environment_id)
     end
 
+    # Protected Environments
+    def protected_environments
+      client.protected_environments.list(id)
+    end
+
+    def protected_environment(environment_id)
+      client.protected_environments.show(id, environment_id)
+    end
+
+    def protect_environment(query)
+      client.protected_environments.protect(id, query)
+    end
+
+    def unprotect_environment(environment_id)
+      client.protected_environments.unprotect(id, environment_id)
+    end
+
     # Project Triggers
     def triggers
       client.projects.triggers.list(id)

data/lib/labclient/projects/reference.rb

@@ -71,6 +71,12 @@ module LabClient
       option 'environment_update', 'Update project environment [Environment ID, Hash]'
       option 'environment_stop', 'Stop project environment [Environment ID]'
 
+      # Protected Environments
+      option 'protected_environments', 'List protected environments [String]'
+      option 'protected_environment', 'Show single protected environment [String]'
+      option 'protect_environment', 'Protect a single environment [Hash]'
+      option 'unprotect_environment', 'Unprotect environment [Environment]'
+
       # Deployments
       option 'deployments', "List this project's deployments"
       option 'deployment_create', 'Create project deployment [Hash]'

data/lib/labclient/protected_branches/protect.rb

@@ -19,11 +19,12 @@ module LabClient
         | allowed_to_unprotect          | array          | no  | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
         | code_owner_approval_required  | boolean        | no  | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the CODEOWNERS file (defaults: false) |
 
-        *Valid access levels*
-        0  => No access, :none
-        30 => Developer access, :developer
-        40 => Maintainer access, :maintainer
-        60 => Admin access, :admin
+        **Valid access levels**
+
+        - 0, :none  => No access
+        - 30, :developer => Developer access
+        - 40, :maintainer => Maintainer access
+        - 60, :admin => Admin access
 
       DOC
     end

data/lib/labclient/protected_environments/list.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'List' do
+      desc 'Gets a list of protected environmentes from a project. [Project ID, String]'
+      example 'client.protected_environments.list(36)'
+      result '[#<ProtectedEnvironment name: prod>]'
+
+      markdown <<~DOC
+        Search: You can use ^term and term$ to find environmentes that begin and end with term respectively.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environments
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/protected_environments", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/protect.rb

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Protect' do
+      desc 'Protects a single environment [Project ID, Hash]'
+      example <<~DOC
+        client.protected_environments.protect(36,
+          name: :prod,
+          deploy_access_levels: [
+            { access_level: :developer }
+          ]
+        )
+      DOC
+      result '#<ProtectedEnvironment name: prod>'
+
+      markdown <<~DOC
+        | Attribute            | Type           | Required | Description                                                                                                      |
+        | -------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
+        | 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.
+
+        **Valid access levels**
+
+        | Access Level | Values          |
+        | ------------ | --------------- |
+        | Developer    | 30, :developer  |
+        | Maintainer   | 40, :maintainer |
+        | Admin        | 60, :admin      |
+
+      DOC
+    end
+
+    doc 'Protect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protect_environment(name: :other, push_access_level: :admin)
+      DOC
+    end
+
+    def protect(project_id, query)
+      query[:deploy_access_levels].each do |access_level|
+        protected_query_access_level(access_level, :access_level)
+      end
+
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/protected_environments", ProtectedEnvironment, query)
+    end
+  end
+end

data/lib/labclient/protected_environments/protected_environment.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProtectedEnvironment < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProtectedEnvironment name: #{name}>"
+    end
+
+    def unprotect
+      project_id = collect_project_id
+
+      client.protected_environments.unprotect(project_id, name)
+    end
+
+    help do
+      subtitle 'ProjectEnvironment'
+      option 'project', 'Show Project'
+      option 'unprotect', 'Remove protected environment'
+    end
+  end
+end

data/lib/labclient/protected_environments/show.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Show' do
+      desc 'Gets a single protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.show(36, :prod)'
+      result '#<ProtectedEnvironment name: prod>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environment(:master)
+      DOC
+    end
+
+    def show(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/unprotect.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Unprotect' do
+      desc 'Unprotects the given protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.unprotect(264, :prod)'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.unprotect_environment(:other)
+      DOC
+    end
+
+    doc 'Unprotect' do
+      desc 'via ProtectedEnvironment'
+      example <<~DOC
+        protected_env = client.protected_environments.show(36, :prod)
+        protected_env.unprotect
+      DOC
+    end
+
+    def unprotect(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/protected_environments/#{environment_id}")
+    end
+  end
+end

data/lib/labclient/users/membership.rb

@@ -0,0 +1,62 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Membership < Klass
+    include ClassHelpers
+    include AccessLevel
+
+    def inspect
+      "#<Membership name: #{source_name}, access: #{level}>"
+    end
+
+    def parent
+      case source_type
+      when 'Project'
+        client.projects.show(source_id)
+      when 'Namespace'
+        client.groups.show(source_id)
+      end
+    end
+
+    def level
+      human_access_level(access_level)
+    end
+
+    def guest?
+      level == :guest
+    end
+
+    def reporter?
+      level == :reporter
+    end
+
+    def developer?
+      level == :developer
+    end
+
+    def maintainer?
+      level == :maintainer
+    end
+
+    def owner?
+      level == :owner
+    end
+
+    def greater_than(leveler)
+      case leveler
+      when Symbol
+        access_level > machine_access_level(leveler)
+      when Integer
+        access_level > leveler
+      end
+    end
+
+    help do
+      subtitle 'Membership'
+      option 'level', 'Humanized symbol of access level. e.g. :developer'
+      option 'parent', 'Collect project/namespace for this membership'
+      option '<permission>?', 'True/False evaluation each guest?, developer? etc'
+      option 'greater_than', 'True/False if user has greater than [Permission Name]'
+    end
+  end
+end

data/lib/labclient/users/memberships.rb

@@ -7,7 +7,9 @@ module LabClient
       desc 'Lists all projects and groups a user is a member of. [User ID, Type]'
 
       markdown <<~DOC
-        Filter memberships by type. Can be either Project or Namespace
+        | Attribute | Type   | Required | Description                                                    |
+        | --------- | ------ | -------- | -------------------------------------------------------------- |
+        | type      | string | no       | Filter memberships by type. Can be either Project or Namespace |
       DOC
 
       example 'client.users.memberships(1)'
@@ -26,9 +28,12 @@ module LabClient
       DOC
     end
 
-    def memberships(user_id, type = 'Project')
+    def memberships(user_id, type = nil)
       user_id = format_id(user_id)
-      client.request(:get, "users/#{user_id}/memberships", nil, { from: type })
+
+      query = nil
+      query = { type: type } if type
+      client.request(:get, "users/#{user_id}/memberships", Membership, query)
     end
   end
 end

data/lib/labclient/users/user.rb

@@ -101,7 +101,7 @@ module LabClient
       client.impersonation_tokens.show(id, token_id)
     end
 
-    def memberships(type = 'Project')
+    def memberships(type = nil)
       client.users.memberships(id, type)
     end
 

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Davin Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -766,6 +766,11 @@ files:
 - lib/labclient/protected_branches/protect.rb
 - lib/labclient/protected_branches/show.rb
 - lib/labclient/protected_branches/unprotect.rb
+- lib/labclient/protected_environments/list.rb
+- lib/labclient/protected_environments/protect.rb
+- lib/labclient/protected_environments/protected_environment.rb
+- lib/labclient/protected_environments/show.rb
+- lib/labclient/protected_environments/unprotect.rb
 - lib/labclient/protected_tags/list.rb
 - lib/labclient/protected_tags/protect.rb
 - lib/labclient/protected_tags/show.rb
@@ -860,6 +865,7 @@ files:
 - lib/labclient/users/keys/list.rb
 - lib/labclient/users/keys/show.rb
 - lib/labclient/users/list.rb
+- lib/labclient/users/membership.rb
 - lib/labclient/users/memberships.rb
 - lib/labclient/users/search.rb
 - lib/labclient/users/show.rb