labclient 0.1.0 → 0.1.5

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

@@ -49,10 +49,17 @@ module LabClient
       end
     end
 
+    def project_create(query)
+      query[:namespace_id] = id
+      client.projects.create(query)
+    end
+
     def ldap_list
       client.groups.ldap.list(id)
     end
 
+    alias ldap_links ldap_list
+
     def ldap_sync
       client.groups.ldap.sync(id)
     end
@@ -239,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'
@@ -247,12 +259,14 @@ module LabClient
       option 'audit_events', "List this group's AuditEvents"
       option 'audit_event', 'Show a specific AuditEvents [Audit Event ID]'
       option 'projects', 'List direct Projects [Hash]'
+      option 'project_create', 'Create a project in this Group [Hash]'
       option 'details', 'Get all details [Hash]'
       option 'search', 'Search by scope within group [scope, search_string]'
       option 'delete', 'Delete this Group'
       option 'restore', 'Restore if marked for deletion'
       option 'transfer', 'Transfer project to this group [Project ID]'
       option 'ldap_list', 'Lists LDAP group links'
+      option 'ldap_links', 'Alias for ldap_list'
       option 'ldap_sync', 'Syncs the group with its linked LDAP group'
       option 'ldap_create', 'Adds an LDAP group link. [Hash]'
       option 'ldap_delete', 'Deletes an LDAP group link. [CN, Provider(optional)]'
@@ -310,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/groups/stub.rb

@@ -0,0 +1,8 @@
+# Top namespace
+module LabClient
+  # Ugly Hack, but Makes Docs Easy
+  class Groups < Common
+    doc '' do
+    end
+  end
+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,15 +73,19 @@ 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
 
     def friendly_error
-      message = data[:message] || data[:error] || data
+      message = if data
+                  data[:message] || data[:error] || data
+                else
+                  return_message
+                end
       "#{code} - #{message}"
     end
   end

data/lib/labclient/issues/agent_detail.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Show' do
       title 'Agent Detail'
-      desc 'Get user agent details [project id, issue iid]'
+      desc 'Get user agent details [Project ID, Issue IID]'
       example 'client.issues.agent_detail(30, 1)'
       result <<~DOC
         => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}

data/lib/labclient/issues/closed_by.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Show' do
       subtitle 'Closed By'
-      desc 'Get all the merge requests that will close issue when merged. [project id, issue iid]'
+      desc 'Get all the merge requests that will close issue when merged. [Project ID, Issue IID]'
       example 'client.issues.closed_by(5, 1)'
       result <<~DOC
         => [#<MergeRequest id: 5, title: Update README.md, state: opened>]

data/lib/labclient/issues/create.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Create' do
-      desc 'Creates a new project issue. [project id]'
+      desc 'Creates a new project issue. [Project ID]'
       example 'client.issues.create(5, title: "Fancy!")'
       result <<~DOC
         => #<Issue id: 1, title: Fancy!, state: opened>
@@ -14,15 +14,27 @@ module LabClient
       markdown <<~DOC
         See [API docs here](https://docs.gitlab.com/ee/api/issues.html#new-issue) for full list of attributes
 
-        | Attribute                                 | Type           | Required | Description  |
-        |-------------------------------------------|----------------|----------|--------------|
-        | title                                   | string         | yes      | The title of an issue |
-        | description                             | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+        | Attribute   | Type           | Required | Description  |
+        |-------------|----------------|----------|--------------|
+        | title       | string         | yes      | The title of an issue |
+        | description | string         | no       | The description of an issue. Limited to 1,048,576 characters. |
+
+        &nbsp;
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project [Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.issue_create(title: "Fancy!")
       DOC
     end
 
     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/delete.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Delete' do
-      desc 'Updates an existing project issue. This call is also used to mark an issue as closed. [project id, issue iid]'
+      desc 'Updates an existing project issue. This call is also used to mark an issue as closed. [Project ID, Issue IID]'
       example 'client.issues.delete(5, 1)'
       result <<~DOC
         => #<Issue id: 1, title: Moar Fancy!, state: opened>

data/lib/labclient/issues/issue.rb

@@ -66,6 +66,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 +91,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 +111,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 +126,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/move.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Move' do
-      desc 'Moves an issue to a different project. [project id, issue iid, target project id]'
+      desc 'Moves an issue to a different project. [Project ID, issue iid, target project id]'
       example 'client.issues.move(5, 1, 6)'
       result <<~DOC
         => #<Issue id: 1, title: Moar Fancy!, state: opened>

data/lib/labclient/issues/participants.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Show' do
       title 'Participants'
-      desc 'Get a list of issue participants. [project id, issue iid]'
+      desc 'Get a list of issue participants. [Project ID, Issue IID]'
       example 'client.issues.participants(30,1)'
       result <<~DOC
         => [#<User id: 1, username: braum>, #<User id: 52, username: anivia>]

data/lib/labclient/issues/related_merge_requests.rb

@@ -5,7 +5,7 @@ module LabClient
     doc 'Show' do
       title 'Merge Requests'
       subtitle 'Related'
-      desc 'Get all the merge requests that are related to the issue. [project id, issue iid]'
+      desc 'Get all the merge requests that are related to the issue. [Project ID, Issue IID]'
       example 'client.issues.related_merge_requests(5, 1)'
       result <<~DOC
         => [#<MergeRequest id: 5, title: Update README.md, state: opened>]

data/lib/labclient/issues/show.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Show' do
-      desc 'Get a single project issue. [project, issue iid]'
+      desc 'Get a single project issue. [project, Issue IID]'
       example 'client.issues.show(343, 1)'
       result <<~DOC
         => #<Issue id: 1, title: Front-line global approach, state: opened>

data/lib/labclient/issues/subscribe.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Update' do
       title 'Subscribe'
-      desc 'Subscribes the authenticated user to an issue to receive notifications. [project id, issue iid]'
+      desc 'Subscribes the authenticated user to an issue to receive notifications. [Project ID, Issue IID]'
 
       example 'client.issues.subscribe(343, 7)'
 

data/lib/labclient/issues/time_stats.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Time Stats' do
       title 'Show'
-      desc 'Get time tracking stats. [project id, issue iid]'
+      desc 'Get time tracking stats. [Project ID, Issue IID]'
       example 'client.issues.time_stats(30, 1)'
       result <<~DOC
         => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
@@ -28,7 +28,7 @@ module LabClient
 
     doc 'Time Stats' do
       title 'Add'
-      desc 'Adds spent time for this merge request. [project id, issue iid, duration]'
+      desc 'Adds spent time for this merge request. [Project ID, issue iid, duration]'
       markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
     end
 
@@ -67,7 +67,7 @@ module LabClient
 
     doc 'Time Stats' do
       title 'Estimate'
-      desc 'Sets an estimated time of work for this merge request. [project id, issue iid, duration]'
+      desc 'Sets an estimated time of work for this merge request. [Project ID, issue iid, duration]'
       markdown 'Duration accepts Human Format, or ActiveSupport::Duration (e.g. 1.hour)'
     end
 
@@ -108,7 +108,7 @@ module LabClient
     doc 'Time Stats' do
       title 'Reset'
       subtitle 'Estimate'
-      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, issue iid]'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [Project ID, Issue IID]'
       example 'client.issues.reset_time_estimate(30, 1)'
       result <<~DOC
         => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}
@@ -132,7 +132,7 @@ module LabClient
 
     doc 'Time Stats' do
       subtitle 'Time Spent'
-      desc 'Resets the estimated time for this merge request to 0 seconds. [project id, issue iid]'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [Project ID, Issue IID]'
       example 'client.issues.reset_spent_time(30, 1)'
       result <<~DOC
         => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}