labclient 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cfc44546096a710f5e2a8ed0b500b202825150b03a029738d8b870cf4258e94
-  data.tar.gz: c965712946b26eef38ae7546a483688eae0ae20cc82480dad59262aa050ba18c
+  metadata.gz: 4ea1ef7fca86883f565358293520dd1b39484ca9c190e543408d91eba2d2e0e5
+  data.tar.gz: 4d963d0f5b7740d9e514ab3e5bc170576a628e7f8642d59cf6777463cd0c3141
 SHA512:
-  metadata.gz: 77a79ac90bfa375a488633c9aa530581a8235c3b5c0d00fd24644ccb962fd39152facc298e77a016cffb200f65b301e6d2c7a1ed883f2dfd2ea0dc6d96ea185d
-  data.tar.gz: cc4cb427458a49007775e063fc065df0623c76f4abe05f0b93279e3ca1638b9b0c024074cb8ac57e7ab732543c39da7cb9f436f2ca85263995c72bbf083d1df9
+  metadata.gz: b46b5af89a9b7beafd0b7287e7c6047200e748cfedcd72021231823d75885b1551158d4d80227b1a6ba6c09b6024c27a02f63cb0aaefa8ea399c13a669fcaa94
+  data.tar.gz: 5bf022a157f8f3cccdd0776a5e851bfe6a30ad189efcee4da7c3c43bc27cc5eb8ca185d857d165024f83edb17ec992657b4f33cc3a9065a19f2ab15655d9fc67

data/lib/labclient.rb

@@ -842,5 +842,14 @@ require 'labclient/resource_labels/merge_requests/show'
 
 require 'labclient/resource_labels/resource_label'
 
+# Generators
+require 'labclient/generator/names'
+require 'labclient/generator/templates/template' # Helper
+require 'labclient/generator/templates/pages'
+
+# Wizard
+require 'labclient/generator/generator'
+require 'labclient/generator/wizard'
+
 # I am Very Last
 require 'labclient/client'

data/lib/labclient/client.rb

@@ -37,6 +37,7 @@ module LabClient
       epics: Epics,
       events: Events,
       files: Files,
+      wizard: Generator::Wizard,
       groups: Groups,
       impersonation_tokens: ImpersonationTokens,
       issues: Issues,

data/lib/labclient/generator/generator.rb

@@ -0,0 +1,82 @@
+# The glorious gitlab labclient of labs
+module LabClient
+  # Generator Namespace
+  module Generator
+    # Docs for the wizard
+    class GeneratorDocs
+      @group_name = 'Wizard'
+      extend Docs
+
+      doc 'Wizard' do
+        markdown <<~DOC
+          <h6 style="color:red"><b>Experimental</b></h6>
+
+          This is experimental and will be likely changing frequently and dramatically. This will create (*potentially many*) and manipulate objects within GitLab. **This is not recommended for use in production environments**
+        DOC
+      end
+
+      doc 'Wizard' do
+        title 'About'
+        markdown <<~DOC
+          The Wizard is designed to help setup test instances, and provide easy mechanisms for populating and testing GitLab features.
+
+          Requires 'faker' to function, which will need to be manually/added installed, as it is not a depdenency of the gem.
+        DOC
+
+        example 'gem install faker'
+      end
+
+      doc 'Wizard' do
+        title 'Client'
+        desc <<-DOC
+          The wizard client will self-populate with defaults and parameters from the main client object. But each can be manually configured.
+        DOC
+
+        example <<~DOC
+          wizard = client.wizard
+          => #<Wizard count={:users=>20, :projects=>5, :groups=>5, :issues=>2}, random=true, domain=labclient>
+
+          # Disable Random
+          wizard.random = false
+        DOC
+      end
+
+      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 |
+
+        DOC
+      end
+
+      doc 'Wizard' do
+        title 'Templates'
+        desc <<-DOC
+          Outside of the wizard at large, you can also select and manually run specific templates.
+        DOC
+
+        example <<~DOC
+          pages =  client.wizard.pages
+          => #<LabClient::Template Pages>
+          pages.run! # Run pages template
+        DOC
+      end
+
+      doc 'Pages' do
+        markdown <<~DOC
+          Create GitLab Pages group and test projects. Projects imported from Gitlab's [demo pages projects](https://gitlab.com/pages)
+
+          | Setting    | Default   | Type    | Description                            |
+          | ---------- | --------- | ------- | -------------------------------------- |
+          | group_name | Generated | String  | Parent Group name for pages projects   |
+          | group_path | Generated | String  | Parent Group path                      |
+          | count      | 5         | Integer | Number of projects to import (max: 28) |
+        DOC
+      end
+    end
+  end
+end

data/lib/labclient/generator/names.rb

@@ -0,0 +1,54 @@
+# Name Generator
+module LabClient
+  # Helper to Generate Data / Populate GitLab
+  module Generator
+    # Name Helper
+    module Names
+      def gen_groups
+        [
+          Faker::Games::LeagueOfLegends.location,
+          Faker::Movies::LordOfTheRings.location,
+          Faker::TvShows::RickAndMorty.location,
+          Faker::TvShows::StarTrek.location,
+          Faker::Games::ElderScrolls.region
+        ].map { |x| x.gsub(/[^0-9A-Za-z]/, '') }
+      end
+
+      def gen_projects
+        [
+          Faker::Games::ElderScrolls.creature,
+          Faker::Games::LeagueOfLegends.summoner_spell,
+          Faker::Games::LeagueOfLegends.masteries,
+          Faker::Superhero.power
+        ].map { |x| x.gsub(/[^0-9A-Za-z]/, '') }
+      end
+
+      def gen_people
+        [
+          Faker::Movies::LordOfTheRings.character,
+          Faker::Games::WorldOfWarcraft.hero,
+          Faker::TvShows::StarTrek.character,
+          Faker::Games::LeagueOfLegends.champion,
+          Faker::Movies::PrincessBride.character
+        ]
+      end
+
+      def gen_description
+        [
+          Faker::Hacker.say_something_smart,
+          Faker::Games::LeagueOfLegends.quote,
+          Faker::Company.bs,
+          Faker::Movies::PrincessBride.quote
+        ].sample
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def generate_names
+        @user_names = Array.new(count[:users]) { gen_people }.flatten.uniq.sample(count[:users])
+        @group_names = Array.new(count[:groups]) { gen_groups }.flatten.uniq
+        @project_names = Array.new(rand(count[:projects])) { gen_projects.sample }.uniq
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/labclient/generator/templates/pages.rb

@@ -0,0 +1,73 @@
+module LabClient
+  module Generator
+    # Page Import Creation
+    class Pages < TemplateHelper
+      include Names
+      attr_accessor :group_name, :group_path, :count
+
+      # All Available Pages Projects
+      def list
+        %w[
+          brunch doxygen emacs-reveal frozen-flask gatsby
+          gitbook hakyll harp hexo hugo hyde ikiwiki
+          jekyll jigsaw lektor metalsmith
+          middleman mkdocs nanoc nikola nuxt octopress
+          org-mode pelican plain-html sphinx vuepress zim
+        ]
+      end
+
+      def setup
+        self.group_name = opts[:group_name] || "#{gen_groups.sample} Pages"
+        self.group_path = opts[:group_path] || group_name.downcase.gsub(' ', '-')
+        self.count = opts[:count] || 5
+      end
+
+      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
+
+      def generate_projects
+        @projects = list.sample(count).map do |name|
+          generate_project(name)
+        end
+      end
+
+      def generate_project(name)
+        @group.project_create(
+          name: name,
+          description: "#{name} Pages",
+          import_url: "https://gitlab.com/pages/#{name}.git"
+        )
+      end
+
+      def generate_pipelines
+        @projects.each do |project|
+          project.pipeline_create(ref: :master)
+        end
+      end
+
+      def wait_for_import
+        @projects.each(&:wait_for_import)
+      end
+
+      # Execute Template
+      def run!
+        generate_group
+        generate_projects
+        wait_for_import
+        generate_pipelines
+
+        @projects.each do |project|
+          puts "#{project.name} - #{project.web_url}"
+        end
+
+        {
+          group: @group,
+          projects: @projects
+        }
+      end
+    end
+  end
+end

data/lib/labclient/generator/templates/template.rb

@@ -0,0 +1,23 @@
+module LabClient
+  module Generator
+    # Common Helper Class
+    class TemplateHelper
+      attr_reader :client
+      attr_accessor :opts
+
+      def inspect
+        "#<LabClient::Template #{self.class.to_s.demodulize}>"
+      end
+
+      def initialize(client, opts = {})
+        @client = client
+        self.opts = opts
+        setup
+      end
+
+      def setup
+        # Blank Place Holder
+      end
+    end
+  end
+end

data/lib/labclient/generator/wizard.rb

@@ -0,0 +1,122 @@
+module LabClient
+  # Generator Namespace
+  module Generator
+    # Helper to Generate Data / Populate GitLab
+    class Wizard
+      include Generator::Names # Name Generator
+      attr_reader :client
+      attr_accessor :count, :random, :password, :templates, :domain
+
+      def inspect
+        "#<Wizard count=#{count}, random=#{random}, domain=#{domain}>"
+      end
+
+      def initialize(client)
+        require 'faker' # Ensure Faker is Available
+
+        @client = client
+        self.random = true # Populate Random or use only Templates
+        self.count = default_count
+        self.password = SecureRandom.uuid
+        self.domain = URI.parse(client.settings[:url]).hostname
+      end
+
+      def template(name, opts = {})
+        case name
+        when :pages then Pages.new(client, opts)
+        end
+      end
+
+      def pages(opts = {})
+        Pages.new(client, opts)
+      end
+
+      # Random Counters
+      def default_count
+        {
+          users: 20,
+          projects: 5,
+          groups: 5,
+          issues: 2
+        }
+      end
+
+      def generate_users
+        @users = @user_names.map do |name|
+          username = name.downcase.gsub(/[^0-9A-Za-z]/, '')
+          email = "#{username}@#{domain}"
+          puts "User -- Name: #{name}, UserName: #{username}, Email: #{email}"
+
+          client.users.create(
+            name: name,
+            email: email,
+            password: password,
+            username: username
+          )
+        end
+      end
+
+      def generate_groups
+        @groups = @group_names.map do |name|
+          path = name.downcase.gsub(/[^0-9A-Za-z]/, '')
+          puts "Group -- #{name}/#{path}"
+          client.groups.create(name: name, path: path)
+        end
+      end
+
+      def generate_group_membership
+        ## Group Access Level
+        @groups.each do |group|
+          @users.sample(rand(1..@users.count)).each do |user|
+            level = group.valid_group_project_levels.sample
+            puts "Group Add: #{group.name}: #{user.name} - #{level}"
+            group.member_add(user, access_level: level)
+            # :nocov:
+          rescue StandardError => e
+            puts e.message
+            next
+            # :nocov:
+          end
+        end
+      end
+
+      def generate_projects(group)
+        # Collect Group Members
+        members = group.members
+
+        # Loop through project names, create project add issues
+        @project_names.uniq.map do |project_name|
+          puts "Project: #{project_name}"
+          project = group.project_create(name: project_name, description: gen_description)
+
+          rand(count[:issues]).times do
+            project.issue_create(generate_issue_data(members.sample))
+          end
+        end
+      end
+
+      def generate_issue_data(member)
+        {
+          assignee_id: member.id,
+          description: Faker::Hacker.say_something_smart,
+          title: Faker::Company.catch_phrase
+        }
+      end
+
+      # Execute Generation
+      def run!
+        # Collect Names
+        generate_names
+        generate_users
+        generate_groups
+        generate_group_membership
+
+        @groups.map do |group|
+          generate_projects(group)
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/labclient/groups/group.rb

@@ -246,6 +246,11 @@ module LabClient
       client.groups.milestones.list(id, query)
     end
 
+    # Reload Helper
+    def reload
+      update_self client.groups.show(id)
+    end
+
     # rubocop:disable Metrics/BlockLength
     help do
       subtitle 'Group'
@@ -319,6 +324,9 @@ module LabClient
 
       # Registry
       option 'registry_repositories', 'Get a list of registry repositories [Hash]'
+
+      # Reload Helper
+      option 'reload', 'Reload this object (New API Call)'
     end
     # rubocop:enable Metrics/BlockLength
   end

data/lib/labclient/issues/create.rb

@@ -33,6 +33,8 @@ module LabClient
 
     def create(project_id, query = {})
       project_id = format_id(project_id)
+      format_query_id(:assignee_id, query)
+
       client.request(:post, "projects/#{project_id}/issues", Issue, query)
     end
   end

data/lib/labclient/issues/issue.rb

@@ -87,6 +87,11 @@ module LabClient
       client.resource_labels.issues.show(project_id, iid, resource_event_id)
     end
 
+    # Reload Helper
+    def reload
+      update_self client.issues.show(project_id, iid)
+    end
+
     help do
       subtitle 'Issue'
       option 'update', 'Update issue (accepts hash).'
@@ -109,6 +114,9 @@ module LabClient
       # Resource Labels
       option 'resource_labels', 'List of all label events'
       option 'resource_label', 'Show single label event [Resource Event ID]'
+
+      # Reload Helper
+      option 'reload', 'Reload this object (New API Call)'
     end
   end
 end

data/lib/labclient/klass.rb

@@ -13,7 +13,8 @@ module LabClient
 
     # API Methods here have to be explicitly documented / custom helpers
     # Assume no methods by default
-    def help
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def help(help_filter = nil)
       docs = LabClient::Docs.docs.dig(group_name, 'Reference')
       unless docs
         puts 'No Available Help'
@@ -25,6 +26,10 @@ module LabClient
         next unless doc[:options]
 
         doc[:options].each do |opt|
+          if help_filter
+            next unless (opt[:name] + opt[:text]).include? help_filter.to_s
+          end
+
           puts '  ' + opt[:name]
           puts "    #{opt[:text]}\n"
         end
@@ -33,6 +38,23 @@ module LabClient
       # Ignore Output
       nil
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    # Documented API Methods
+    def api_methods
+      docs = LabClient::Docs.docs.dig(group_name, 'Reference')
+
+      unless docs
+        puts 'No Available Help'
+        return false
+      end
+
+      LabClient::Docs.docs.dig(group_name, 'Reference').map do |doc|
+        doc[:options].map do |opt|
+          opt[:name]
+        end
+      end.flatten.sort
+    end
 
     def valid_group_project_levels
       %i[guest reporter developer maintainer owner]
@@ -85,6 +107,11 @@ module LabClient
       end
     end
 
+    # Forward response success
+    def success?
+      @response.success?
+    end
+
     # Formatting Time Helper
     def format_time?(time)
       time.respond_to?(:to_time)

data/lib/labclient/overview.rb

@@ -143,6 +143,27 @@ module LabClient
       DOC
     end
 
+    doc 'Response' do
+      title 'Status'
+      desc 'Each object/call will return a "response" object or the instantiated class object. On each of these you can use "success?" to verify the response of a call.'
+
+      result <<~DOC
+        project = client.projects.show 123123
+        # => #<TyphoeusResponse code: 404>
+        project.success?
+        # => false
+
+        user = client.users.show 1
+        => #<User id: 1, username: root>
+        user.success?
+        => true
+      DOC
+
+      result <<~DOC
+        curl -k -H "Private-Token: super_secret_token" -H "Accept: application/json" "https://labclient/api/v4/users?"
+      DOC
+    end
+
     doc 'Other' do
       title 'Common Helpers'
       markdown <<~DOC
@@ -191,6 +212,20 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      desc 'Object Help'
+
+      result <<~DOC
+        project = client.projects.show(5)
+
+        # List Possible Methods
+        project.help
+
+        # Array result of methods
+        project.api_methods
+      DOC
+    end
+
     doc 'Other' do
       title 'Object IDs'
 

data/lib/labclient/paginated_response.rb

@@ -111,5 +111,10 @@ module LabClient
         process_entry(entry, @response)
       end
     end
+
+    # Forward response success
+    def success?
+      @response.success?
+    end
   end
 end

data/lib/labclient/projects/methods.rb

@@ -681,6 +681,30 @@ module LabClient
     def clusters
       client.projects.clusters.list(id)
     end
+
+    # Reload
+    def reload
+      update_self client.projects.show(id)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_import(total_time = 300, sleep_time = 15)
+      # none
+      # scheduled
+      # failed
+      # started
+      # finished
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          break if %w[none finished].include? import_status
+          raise "Import Failed: #{import_error}" if import_status == 'failed'
+
+          sleep sleep_time
+        end
+      end
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/labclient/projects/reference.rb

@@ -8,6 +8,9 @@ module LabClient
       option 'archive', 'Archive this project'
       option 'delete', 'Schedule/Delete this project'
       option 'events', "List this project's events"
+      option 'reload', 'Reload this project object (New API Call)'
+      option 'wait_for_import', 'Looping, wait for project import [Timeout, Interval]'
+
       option 'fork_existing', 'Create Fork Relationship [Target/Source Project]'
       option 'fork_remove', 'Remove Fork Relationshgip'
       option 'fork', 'Fork this project, accepts hash, [namespace, path, name]'

data/lib/labclient/users/user.rb

@@ -105,6 +105,11 @@ module LabClient
       client.users.memberships(id, type)
     end
 
+    # Reload Helper
+    def reload
+      update_self client.users.show(id)
+    end
+
     help do
       # @group_name = 'Users'
       subtitle 'User'
@@ -133,6 +138,7 @@ module LabClient
       option 'impersonation_token_revoke', 'Revoke impersonation tokesn [Token ID]'
       option 'impersonation_token', 'Show impersonation tokesn [Token ID]'
       option 'memberships', 'Lists all projects and groups a user is a member of [String/Type]'
+      option 'reload', 'Reload this object (New API Call)'
     end
   end
 end

data/lib/labclient/version.rb

@@ -1,3 +1,3 @@
 module LabClient
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labclient
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Davin Walker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +401,11 @@ files:
 - lib/labclient/files/delete.rb
 - lib/labclient/files/show.rb
 - lib/labclient/files/update.rb
+- lib/labclient/generator/generator.rb
+- lib/labclient/generator/names.rb
+- lib/labclient/generator/templates/pages.rb
+- lib/labclient/generator/templates/template.rb
+- lib/labclient/generator/wizard.rb
 - lib/labclient/groups/access_requests/access_request.rb
 - lib/labclient/groups/access_requests/approve.rb
 - lib/labclient/groups/access_requests/client.rb
@@ -859,7 +878,7 @@ homepage: https://gitlab.com/labclient/labclient
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -875,7 +894,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gitlab API Client
 test_files: []