labclient 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79977702325d9d9a7df2569a8e1e948db351fc35deea828a832a548048efa7b3
-  data.tar.gz: 1febe4b7a2eab857c37fc814b299678a35c86be61c8d346806c5d8092ea154af
+  metadata.gz: 6891782100fb734939767870fa735c9a0f34127582767b4b67c47bdad1f64646
+  data.tar.gz: 503518a6a45eba73b86bf44c8997d969cd78396210943753c59e330fe06b3be4
 SHA512:
-  metadata.gz: 14eabf457805cece5387012fcd28ae9922ce554a6981aa21653d98404b274e6438b49686e0b6a7f8f3dbd14f16520089c58141ff08f2310c5314b52d31facc6c
-  data.tar.gz: 93b298936e970390a1886e03ddb4473d57df7adcfe75be983770fe09d5674cd5544776abd239c02c11a9ab93445aeee10c77fcb7cd2236e884174d844eec4e9b
+  metadata.gz: b8f5c439041953cf54681ead1caddc945e913d397cfb3b5b12d3abe81415bcebe0878c5cf13f4c541c1bc7481035d490144d429ac0e37adb82f02da21199f906
+  data.tar.gz: d160894003a7d1e48fbc952a6f3e8c27de913816162938b4b77bb67114e3294e04ce46ef866e08ca0696e6cbbb4f2762d7f811cee6721f6b8c4c447fc22e6c85

data/lib/labclient.rb

@@ -3,7 +3,7 @@ require 'oj'
 require 'pry'
 require 'typhoeus'
 require 'active_support/all'
-require 'awesome_print'
+require 'amazing_print'
 require 'gitlab_chronic_duration'
 require 'ostruct'
 
@@ -13,8 +13,8 @@ require 'labclient/http'
 require 'labclient/access_levels'
 require 'labclient/common'
 require 'labclient/curl'
+require 'labclient/lab_struct'
 require 'labclient/klass'
-require 'labclient/open_struct'
 require 'labclient/class_helpers'
 require 'labclient/paginated_response'
 require 'labclient/error'
@@ -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,47 +46,10 @@ 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'
 
-# User Keys
-require 'labclient/users/keys/client'
-require 'labclient/users/keys/list'
-require 'labclient/users/keys/show'
-require 'labclient/users/keys/create'
-require 'labclient/users/keys/delete'
-
-# Notifications
-require 'labclient/notifications/list'
-require 'labclient/notifications/update'
-
-# User GPG Keys
-require 'labclient/users/gpg/client'
-require 'labclient/users/gpg/list'
-require 'labclient/users/gpg/show'
-require 'labclient/users/gpg/create'
-require 'labclient/users/gpg/delete'
-require 'labclient/users/gpg/gpg_key'
-
-# User Emails
-require 'labclient/users/email/client'
-require 'labclient/users/email/list'
-require 'labclient/users/email/show'
-require 'labclient/users/email/create'
-require 'labclient/users/email/delete'
-require 'labclient/users/email/email'
-
-# Impersonation Tokens
-require 'labclient/impersonation_tokens/impersonation_token'
-require 'labclient/impersonation_tokens/list'
-require 'labclient/impersonation_tokens/show'
-require 'labclient/impersonation_tokens/create'
-require 'labclient/impersonation_tokens/revoke'
-
-# Namespaces
-require 'labclient/namespaces/namespace'
-require 'labclient/namespaces/list'
-require 'labclient/namespaces/show'
-
 # ===============================================
 # Projects
 # ===============================================
@@ -116,6 +78,9 @@ require 'labclient/projects/restore'
 require 'labclient/projects/snapshot'
 require 'labclient/projects/github_import'
 
+# Group Stub / Docs ORder
+require 'labclient/groups/stub'
+
 # Project Forks
 require 'labclient/projects/forks/list'
 require 'labclient/projects/forks/fork'
@@ -185,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'
@@ -684,6 +656,45 @@ require 'labclient/notes/epics/delete'
 require 'labclient/notes/note'
 # -----------------------------------
 
+# User Keys
+require 'labclient/users/keys/client'
+require 'labclient/users/keys/list'
+require 'labclient/users/keys/show'
+require 'labclient/users/keys/create'
+require 'labclient/users/keys/delete'
+
+# Notifications
+require 'labclient/notifications/list'
+require 'labclient/notifications/update'
+
+# User GPG Keys
+require 'labclient/users/gpg/client'
+require 'labclient/users/gpg/list'
+require 'labclient/users/gpg/show'
+require 'labclient/users/gpg/create'
+require 'labclient/users/gpg/delete'
+require 'labclient/users/gpg/gpg_key'
+
+# User Emails
+require 'labclient/users/email/client'
+require 'labclient/users/email/list'
+require 'labclient/users/email/show'
+require 'labclient/users/email/create'
+require 'labclient/users/email/delete'
+require 'labclient/users/email/email'
+
+# Impersonation Tokens
+require 'labclient/impersonation_tokens/impersonation_token'
+require 'labclient/impersonation_tokens/list'
+require 'labclient/impersonation_tokens/show'
+require 'labclient/impersonation_tokens/create'
+require 'labclient/impersonation_tokens/revoke'
+
+# Namespaces
+require 'labclient/namespaces/namespace'
+require 'labclient/namespaces/list'
+require 'labclient/namespaces/show'
+
 # Runners
 require 'labclient/runners/list'
 require 'labclient/runners/all'
@@ -765,6 +776,7 @@ require 'labclient/files/delete'
 # Branches
 require 'labclient/branches/list'
 require 'labclient/branches/show'
+require 'labclient/branches/create'
 require 'labclient/branches/delete'
 require 'labclient/branches/delete_merged'
 require 'labclient/branches/branch'
@@ -839,5 +851,16 @@ require 'labclient/resource_labels/merge_requests/show'
 
 require 'labclient/resource_labels/resource_label'
 
+# Generators
+require 'labclient/generator/names'
+require 'labclient/generator/template_helper' # Default Include Template
+
+# Wizard
+require 'labclient/generator/generator'
+require 'labclient/generator/wizard'
+
+# Dynamically Require Templates (Simplify new template creation)
+Dir[File.dirname(__FILE__) + '/labclient/generator/templates/*.rb'].sort.each { |file| require file }
+
 # I am Very Last
 require 'labclient/client'

data/lib/labclient/branches/branch.rb

@@ -11,5 +11,30 @@ module LabClient
     def commit
       Commit.new(@table[:commit], response, client)
     end
+
+    def pipelines
+      project_id = collect_project_id
+      client.pipelines.list(project_id, ref: name)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_pipelines(total_time = 300, sleep_time = 15)
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts 'Waiting for Pipelines'
+          break unless pipelines.empty?
+
+          sleep sleep_time
+        end
+      end
+    end
+
+    help do
+      subtitle 'Branch'
+      option 'commit', 'Show Commit information for branch'
+      option 'pipelines', 'Show Pipelines for this Branch/Ref'
+      option 'wait_for_pipelines', 'Looping, on newly created branches, wait for pipelines to populate (not finish) [Timeout, Interval]'
+    end
   end
 end

data/lib/labclient/branches/create.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Branches < Common
+    doc 'Create' do
+      desc 'Get a list of repository branches from a project, sorted by name alphabetically. [Project ID, String]'
+      example 'client.branches.create(264, branch: :branch, ref: :master)'
+      result '[#<Branch name: feature>, #<Branch name: master>]'
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description                                                                                                  |
+        |----------|--------|---------|-------------------------------------------------------------------------------------------------------------|
+        | id      | integer | yes      | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
+        | branch  | string  | yes      | Name of the branch.                                                                                          |
+        | ref     | string  | yes      | Branch name or commit SHA to create branch from.                                                             |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.branch_create(branch: :branch, ref: :master)
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/repository/branches", Branch, query)
+    end
+  end
+end

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
@@ -37,6 +38,7 @@ module LabClient
       epics: Epics,
       events: Events,
       files: Files,
+      wizard: Generator::Wizard,
       groups: Groups,
       impersonation_tokens: ImpersonationTokens,
       issues: Issues,
@@ -54,6 +56,7 @@ module LabClient
       project_runners: ProjectRunners,
       projects: Projects,
       protected_branches: ProtectedBranches,
+      protected_environments: ProtectedEnvironments,
       protected_tags: ProtectedTags,
       registry: Registry,
       repo: Repositories,
@@ -90,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?
@@ -111,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 })
@@ -138,10 +177,10 @@ module LabClient
       resp
     end
 
-    # Assume we want OpenStruct if @klass is ever nil
+    # Assume we want LabStruct if @klass is ever nil
     def process(resp)
       case resp.data
-      when OpenStruct
+      when LabStruct
         klass ? klass.new(resp.data, resp, self) : resp.data
       when Array
         if @klass.nil?
@@ -154,4 +193,5 @@ module LabClient
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/common.rb

@@ -72,6 +72,11 @@ module LabClient
       CGI.escape obj_id.to_s
     end
 
+    def format_query_id(key, query)
+      query[key] = format_id(query[key]) if query.key? key
+      query[key.to_s] = format_id(query[key.to_s]) if query.key? key.to_s
+    end
+
     def format_query_ids(key, query)
       query[key] = query[key].map { |x| format_id(x) } if query.key? key
 

data/lib/labclient/docs.rb

@@ -50,10 +50,14 @@ module LabClient
     end
 
     def desc(value)
-      # @result[:desc] = simple_format value
       @result[:desc] = value
     end
 
+    def demo(value)
+      @result[:demo_url] = "https://asciinema.org/a/#{value}.js"
+      @result[:demo] = "<script id='asciicast-#{value}' src='#{@result[:demo_url]}' data-autoplay='true' data-loop='true' async></script>"
+    end
+
     def example(value)
       @result[:example] = value
     end

data/lib/labclient/epics/epic.rb

@@ -51,6 +51,15 @@ module LabClient
       client.resource_labels.epics.show(group_id, id, resource_event_id)
     end
 
+    # Notes
+    def notes
+      client.notes.epics.list(group_id, iid)
+    end
+
+    def note_create(query)
+      client.notes.epics.create(group_id, iid, query)
+    end
+
     date_time_attrs %i[created_at closed_at updated_at]
 
     help do
@@ -64,6 +73,10 @@ module LabClient
       option 'issue_remove', 'Remove issue from Epic [Epic Issue ID]'
       option 'issue_update', 'Update issue association [Epic Issue ID, Hash]'
 
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
+
       # Resource Labels
       option 'resource_labels', 'List of all label events'
       option 'resource_label', 'Show single label event [Resource Event ID]'

data/lib/labclient/error.rb

@@ -3,6 +3,7 @@ module LabClient
   # Class Shim
   class Error < StandardError
     attr_reader :resp
+
     def initialize(resp)
       super
       @resp = resp

data/lib/labclient/files/create.rb

@@ -16,15 +16,18 @@ module LabClient
       result '{:file_path=>"new.md", :branch=>"master"}'
 
       markdown <<~DOC
-        **Parameters**:
+        Parameters
+
+        | **Attribute**  | **Required** | **Description**                                 |
+        | -------------- | ------------ | ----------------------------------------------- |
+        | branch         | yes          | Name of the branch                              |
+        | content        | yes          | File content                                    |
+        | start_branch   | no           | Name of the branch to start the new commit from |
+        | encoding       | no           | Change encoding to ‘base64’. Default is text.   |
+        | author_email   | no           | Specify the commit author’s email address       |
+        | author_name    | no           | Specify the commit author’s name                |
+        | commit_message | no           | Commit message                                  |
 
-        * branch (required) - Name of the branch
-        * start_branch (optional) - Name of the branch to start the new commit from
-        * encoding (optional) - Change encoding to ‘base64’. Default is text.
-        * author_email (optional) - Specify the commit author’s email address
-        * author_name (optional) - Specify the commit author’s name
-        * content (required) - File content
-        * commit_message (required) - Commit message
 
       DOC
     end
@@ -43,6 +46,9 @@ module LabClient
     def create(project_id, file_path, query)
       project_id = format_id(project_id)
 
+      # Path Name Encoding
+      file_path = CGI.escape(file_path)
+
       client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end
   end