labclient 0.1.1 → 0.2.0

data/lib/labclient/generator/wizard.rb

@@ -0,0 +1,142 @@
+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, :skip_confirmation
+
+      def inspect
+        "#<Wizard count=#{count}, random=#{random}, domain=#{domain}> templates=#{templates}"
+      end
+
+      def templates_default
+        %i[pages pipeline_trigger environments]
+      end
+
+      def templates_all
+        LabClient::Generator::TemplateHelper.descendants
+      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
+        puts "Default Password: #{password}"
+
+        self.skip_confirmation = true
+        self.domain = URI.parse(client.settings[:url]).hostname
+
+        # Default Templates
+        self.templates ||= templates_default
+      end
+
+      def template(name, opts = {})
+        template_klass = templates_all.find { |x| x.template_name == name.to_sym }
+
+        raise "Invalid Template! Available Templates: #{templates_all.map(&:template_name).join(', ')}" unless template_klass
+
+        template_klass.new(client, opts)
+      end
+
+      # Random Counters
+      def default_count
+        {
+          users: 20,
+          projects: 5,
+          groups: 5,
+          issues: 2
+        }
+      end
+
+      def generate_users
+        puts 'Generating 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,
+            skip_confirmation: skip_confirmation
+          )
+        end
+      end
+
+      def generate_groups
+        puts 'Generating 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
+        puts 'Adding Group members'
+        ## 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)
+        puts 'Generating Projects'
+        # 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
+
+        # Run Templates
+        templates.each { |template_klass| template(template_klass).run! }
+
+        nil
+      end
+    end
+  end
+end

data/lib/labclient/groups/group.rb

@@ -42,7 +42,7 @@ module LabClient
 
     def projects(query = {})
       # Details Query Includes Projects
-      if query.empty? && !@table.dig(:projects).blank?
+      if query.empty? && !@table[:projects].blank?
         @table[:projects].map { |project| LabClient::Project.new(project, response, client) }
       else
         client.groups.projects(id, query)
@@ -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/http.rb

@@ -3,6 +3,7 @@ module LabClient
   # Request Helper
   class HTTP
     attr_accessor :settings
+
     def initialize(settings)
       self.settings = settings
     end
@@ -72,10 +73,10 @@ module Typhoeus
     def process_body
       if body.empty?
         nil
-      elsif headers['content-type'] == 'text/plain'
+      elsif headers['content-type']&.include? 'text/plain'
         body
       else
-        Oj.load(body, mode: :compat, object_class: OpenStruct)
+        Oj.load(body, mode: :compat, object_class: LabClient::LabStruct)
       end
     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

@@ -14,6 +14,16 @@ module LabClient
     # User Fields
     user_attrs %i[closed_by author assignee]
 
+    # Via State Events
+    def close
+      client.issues.update(project_id, iid, state_event: :close)
+    end
+
+    # Via State Events
+    def reopen
+      client.issues.update(project_id, iid, state_event: :reopen)
+    end
+
     def update(query)
       client.issues.update(project_id, iid, query)
     end
@@ -66,6 +76,10 @@ module LabClient
       client.notes.issues.list(project_id, iid)
     end
 
+    def note_create(query)
+      client.notes.issues.create(project_id, iid, query)
+    end
+
     def agent_detail
       client.issues.agent_detail(project_id, iid)
     end
@@ -87,6 +101,18 @@ 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
+
+    def project
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.projects.show(project_id)
+    end
+
     help do
       subtitle 'Issue'
       option 'update', 'Update issue (accepts hash).'
@@ -95,7 +121,8 @@ module LabClient
       option 'subscribe', 'Subscribe to notifications'
       option 'unsubscribe', 'Unsubscribe to notifications'
       option 'participants', 'List participants in this issue.'
-      option 'notes', 'List notes/comments.'
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note for issue. [Hash]'
       option 'agent_detail', 'Get user agent details.'
       option 'related_merge_requests', 'Get all related Merge Requests.'
       option 'closed_by', 'Get all Merge Requests that will close this issue.'
@@ -109,6 +136,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/issues/update.rb

@@ -18,19 +18,37 @@ module LabClient
         |-------------------------------------------|----------------|----------|--------------|
         | title                                   | string         | no      | The title of an issue |
         | description                             | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+
+
       DOC
     end
 
     doc 'Update' do
-      desc 'Close Ticket'
+      title 'Close / Reopen'
+      markdown <<~DOC
+        Closing/Reopening of issues is handled via state_events. Either :close, or :reopen. The issue objects themselves also have helpers `reopen` `close`.
+      DOC
+
       example 'client.issues.update(5, 1, state_event: :close)'
     end
 
+    doc 'Update' do
+      example 'client.issues.update(5, 1, state_event: :reopen)'
+    end
+
+    doc 'Update' do
+      desc 'Through Issue Object'
+      example <<~DOC
+        issue = client.issues.show(5,1)
+        issue.close
+      DOC
+    end
+
     doc 'Update' do
       desc 'Through Issue Object'
       example <<~DOC
         issue = client.issues.show(5,1)
-        issue.update(title: "Dew it!")
+        issue.reopen
       DOC
     end
 

data/lib/labclient/jobs/delete.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Delete'
       desc 'Delete artifacts of a job. [Project ID, Job ID]'
       example 'client.jobs.delete(264, 14)'
     end

data/lib/labclient/jobs/keep.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Keep'
       desc 'Prevents artifacts from being deleted when expiration is set. [Project ID, Job ID]'
       example 'client.jobs.keep(264, 14)'
     end

data/lib/labclient/jobs/play.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Jobs < Common
     doc 'Update' do
-      title 'Retry'
+      title 'Play'
       desc 'Triggers a manual action to start a job. [Project ID, Job ID]'
       example 'client.jobs.play(264, 14)'
     end

data/lib/labclient/jobs/trace.rb

@@ -20,14 +20,14 @@ module LabClient
       desc 'via Job'
       example <<~DOC
         job = client.jobs.show(264,1)
-        job.trace
+        job.trace #=> String
       DOC
     end
 
     def trace(project_id, job_id)
       job_id = format_id(job_id)
       project_id = format_id(project_id)
-      puts client.request(:get, "projects/#{project_id}/jobs/#{job_id}/trace")
+      client.request(:get, "projects/#{project_id}/jobs/#{job_id}/trace")
     end
   end
 end

data/lib/labclient/klass.rb

@@ -1,19 +1,21 @@
 # Top Namesapce
 module LabClient
   # Common Configuration for all Class Helpers
-  class Klass < OpenStruct
+  class Klass < LabStruct
     include CurlHelper
 
     attr_reader :client, :response
+
     extend Docs
 
     def verbose
-      ap self
+      ap self, ruby19_syntax: true
     end
 
     # 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,7 +27,11 @@ module LabClient
         next unless doc[:options]
 
         doc[:options].each do |opt|
-          puts '  ' + opt[:name]
+          if help_filter
+            next unless (opt[:name] + opt[:text]).include? help_filter.to_s
+          end
+
+          puts "  #{opt[:name]}"
           puts "    #{opt[:text]}\n"
         end
       end
@@ -33,6 +39,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]
@@ -74,6 +97,7 @@ module LabClient
       self
     end
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(hash = nil, response = nil, client = nil)
       @client = client
       @response = response
@@ -84,6 +108,12 @@ module LabClient
         @table[k] = v
       end
     end
+    # rubocop:enable Lint/MissingSuper
+
+    # Forward response success
+    def success?
+      @response.success?
+    end
 
     # Formatting Time Helper
     def format_time?(time)

data/lib/labclient/lab_struct.rb

@@ -0,0 +1,17 @@
+# Extensions for OpenStruct specific to LabClient
+module LabClient
+  # Unique inherited class to not override top level openstruct
+  class LabStruct < OpenStruct
+    def keys
+      to_h.keys.sort
+    end
+
+    def inspect
+      to_h.inspect
+    end
+
+    def as_json(*args)
+      super.as_json['table']
+    end
+  end
+end