labclient 0.1.2 → 0.2.1

data/lib/labclient/generator/wizard.rb

@@ -5,10 +5,18 @@ 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}>"
+        "#<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)
@@ -18,17 +26,21 @@ 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
+        self.templates ||= templates_default
       end
 
       def template(name, opts = {})
-        case name
-        when :pages then Pages.new(client, opts)
-        end
-      end
+        template_klass = templates_all.find { |x| x.template_name == name.to_sym }
 
-      def pages(opts = {})
-        Pages.new(client, opts)
+        raise "Invalid Template! Available Templates: #{templates_all.map(&:template_name).join(', ')}" unless template_klass
+
+        template_klass.new(client, opts)
       end
 
       # Random Counters
@@ -42,6 +54,7 @@ module LabClient
       end
 
       def generate_users
+        puts 'Generating Users'
         @users = @user_names.map do |name|
           username = name.downcase.gsub(/[^0-9A-Za-z]/, '')
           email = "#{username}@#{domain}"
@@ -51,12 +64,14 @@ module LabClient
             name: name,
             email: email,
             password: password,
-            username: username
+            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}"
@@ -65,6 +80,7 @@ module LabClient
       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|
@@ -81,6 +97,7 @@ module LabClient
       end
 
       def generate_projects(group)
+        puts 'Generating Projects'
         # Collect Group Members
         members = group.members
 
@@ -115,6 +132,9 @@ module LabClient
           generate_projects(group)
         end
 
+        # Run Templates
+        templates.each { |template_klass| template(template_klass).run! }
+
         nil
       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)

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/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
@@ -92,6 +106,13 @@ module LabClient
       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).'
@@ -100,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.'

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,14 +1,15 @@
 # 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
@@ -30,7 +31,7 @@ module LabClient
             next unless (opt[:name] + opt[:text]).include? help_filter.to_s
           end
 
-          puts '  ' + opt[:name]
+          puts "  #{opt[:name]}"
           puts "    #{opt[:text]}\n"
         end
       end
@@ -96,6 +97,7 @@ module LabClient
       self
     end
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(hash = nil, response = nil, client = nil)
       @client = client
       @response = response
@@ -106,6 +108,7 @@ module LabClient
         @table[k] = v
       end
     end
+    # rubocop:enable Lint/MissingSuper
 
     # Forward response success
     def success?

data/lib/labclient/lab_struct.rb

@@ -0,0 +1,21 @@
+# 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
+
+    def slice(*opts)
+      to_h.slice(*opts)
+    end
+  end
+end

data/lib/labclient/license/list.rb

@@ -32,12 +32,12 @@ module LabClient
                            :expires_at => "2050-11-14",
                            :historical_max => 0,
                            :maximum_user_count => 48,
-                           :licensee => OpenStruct {
+                           :licensee => LabStruct {
                            :Name => "GitLab Henley",
                            :Email => "test_user@gitlab.com",
                            :Company => "GitLab, Inc."
                },
-                           :add_ons => OpenStruct {},
+                           :add_ons => LabStruct {},
                            :expired => false,
                            :overage => 0,
                            :user_limit => 100,

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/merge_requests/accept.rb

@@ -7,10 +7,19 @@ module LabClient
       desc 'Merge changes submitted with MR. [Project ID, merge request iid]'
 
       markdown <<~DOC
-        - <small>if merge request is unable to be accepted (ie: Work in Progress, Closed, Pipeline Pending Completion, or Failed while requiring Success) - you'll get a `405` and the error message 'Method Not Allowed'</small>
-        - <small>If it has some conflicts and can not be merged - you'll get a `406` and the error message 'Branch cannot be merged'</small>
-        - <small>If the `sha` parameter is passed and does not match the HEAD of the source - you'll get a `409` and the error message 'SHA </small>does not match HEAD of source branch'
-        - <small>If you don't have permissions to accept this merge request - you'll get a `401`</small>
+          - <small>if merge request is unable to be accepted (ie: Work in Progress, Closed, Pipeline Pending Completion, or Failed while requiring Success) - you'll get a `405` and the error message 'Method Not Allowed'</small>
+          - <small>If it has some conflicts and can not be merged - you'll get a `406` and the error message 'Branch cannot be merged'</small>
+          - <small>If the `sha` parameter is passed and does not match the HEAD of the source - you'll get a `409` and the error message 'SHA </small>does not match HEAD of source branch'
+          - <small>If you don't have permissions to accept this merge request - you'll get a `401`</small>
+
+        | **Attribute**                | **Attribute**                                                                                     |
+        | ---------------------------- | ------------------------------------------------------------------------------------------------- |
+        | merge_commit_message         | Custom merge commit message                                                                       |
+        | squash_commit_message        | Custom squash commit message                                                                      |
+        | squash                       | if true the commits will be squashed into a single commit on merge                                |
+        | should_remove_source_branch  | if true removes the source branch                                                                 |
+        | merge_when_pipeline_succeeds | if true the MR is merged when the pipeline succeeds                                               |
+        | sha                          | if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail |
       DOC
 
       example 'client.merge_requests.accept(343, 3)'
@@ -29,11 +38,11 @@ module LabClient
     end
 
     # Accept
-    def accept(project_id, merge_request_id)
+    def accept(project_id, merge_request_id, query = {})
       project_id = format_id(project_id)
       merge_request_id = format_id(merge_request_id)
 
-      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/merge", MergeRequest)
+      client.request(:put, "projects/#{project_id}/merge_requests/#{merge_request_id}/merge", MergeRequest, query)
     end
   end
 end

data/lib/labclient/merge_requests/create.rb

@@ -41,6 +41,18 @@ module LabClient
       DOC
     end
 
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.merge_request_create(
+          title: 'New MR!',
+          source_branch: 'sweet-release',
+          target_branch: :master
+        )
+      DOC
+    end
+
     # Create
     def create(project_id, query)
       project_id = format_id(project_id)

data/lib/labclient/merge_requests/merge_request.rb

@@ -51,8 +51,8 @@ module LabClient
       client.merge_requests.delete(project_id, iid)
     end
 
-    def accept
-      client.merge_requests.accept(project_id, iid)
+    def accept(query = {})
+      client.merge_requests.accept(project_id, iid, query)
     end
 
     def merge_ref
@@ -99,6 +99,10 @@ module LabClient
       client.notes.merge_requests.list(project_id, iid)
     end
 
+    def note_create(query)
+      client.notes.merge_requests.create(project_id, iid, query)
+    end
+
     def todo
       client.merge_requests.todo(project_id, iid)
     end
@@ -166,9 +170,42 @@ module LabClient
       client.resource_labels.merge_requests.show(project_id, iid, resource_event_id)
     end
 
+    # Reload
+    def reload
+      update_self client.merge_requests.show(project_id, iid)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_merge_status(total_time = 300, sleep_time = 15)
+      # :unchecked
+      # :cannot_be_merged_recheck
+      # :checking
+      # :cannot_be_merged_rechecking
+      # :can_be_merged
+      # :cannot_be_merged
+
+      # Success
+      # [unchecked, can_be_merged]
+
+      # Fail
+      # [cannot_be_merged cannot_be_merged_recheck]
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts "Waiting for Merge Status: #{merge_status}"
+          break if %w[can_be_merged unchecked].include? merge_status
+          raise "Cannot be merged! #{import_error}" if %w[cannot_be_merged cannot_be_merged_recheck].include? merge_status
+
+          sleep sleep_time
+        end
+      end
+    end
+
+    # rubocop:disable Metrics/BlockLength
     help do
       subtitle 'MergeRequest'
-      option 'accept', 'Merge changes submitted'
+      option 'accept', 'Merge changes submitted [Hash]'
       option 'add_time_spent', 'Adds spent time. Accepts Duration or Human Format. (1.hour or "1h")'
       option 'changes', 'Show merge request changes'
       option 'closes_issues', 'Show issues that this merge request will close'
@@ -176,7 +213,13 @@ module LabClient
       option 'create_pipeline', 'Create new pipeline for this merge request.'
       option 'delete', 'Delete this merge request.'
       option 'merge_ref', 'Show Merge Ref'
-      option 'notes', 'List notes/comments.'
+      option 'reload', 'Reload this merge request object (New API Call)'
+      option 'wait_for_merge_status', 'Looping, wait for merge request status [Timeout, Interval]'
+
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
+
       option 'participants', 'List participants in this merge request.'
       option 'pipelines', 'List pipelines in this merge request.'
       option 'reset_spent_time', 'Resets the spent time'
@@ -206,6 +249,8 @@ module LabClient
       option 'resource_labels', 'List of all label events'
       option 'resource_label', 'Show single label event [Resource Event ID]'
     end
+
+    # rubocop:enable Metrics/BlockLength
   end
   # rubocop:enable Metrics/ClassLength
 end