labclient 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea1ef7fca86883f565358293520dd1b39484ca9c190e543408d91eba2d2e0e5
-  data.tar.gz: 4d963d0f5b7740d9e514ab3e5bc170576a628e7f8642d59cf6777463cd0c3141
+  metadata.gz: a4c0988633436f9872d93e241ceb4c85e5b780b5f419a08054231138d8448dc5
+  data.tar.gz: '06268afb4c985bd5dbffebf72c610aa0c4fe1083af0b86d30d5624a69e25f52e'
 SHA512:
-  metadata.gz: b46b5af89a9b7beafd0b7287e7c6047200e748cfedcd72021231823d75885b1551158d4d80227b1a6ba6c09b6024c27a02f63cb0aaefa8ea399c13a669fcaa94
-  data.tar.gz: 5bf022a157f8f3cccdd0776a5e851bfe6a30ad189efcee4da7c3c43bc27cc5eb8ca185d857d165024f83edb17ec992657b4f33cc3a9065a19f2ab15655d9fc67
+  metadata.gz: c558d37e33b7efdad2b9e0621c3a0d437e2345cc987403af2c15bed6e1d0a04c926de86442e1595a7fbfb6b0aae63af8583430f4046782edea2362a0ebf946f7
+  data.tar.gz: 211e88abab828ddc51c7b6a8965a962ec34f95fb4f7e3106611f3af5b5d72e6c75431c3eabedb618a838f29b3b64e4301ed173d38120c9ef4bb0e5b0d45a8e69

data/lib/labclient.rb

@@ -1,9 +1,8 @@
 # Public Gems
 require 'oj'
-require 'pry'
 require 'typhoeus'
 require 'active_support/all'
-require 'awesome_print'
+require 'amazing_print'
 require 'gitlab_chronic_duration'
 require 'ostruct'
 
@@ -13,8 +12,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 +35,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,6 +45,8 @@ 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'
 
 # ===============================================
@@ -149,6 +149,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'
@@ -768,6 +775,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'
@@ -844,12 +852,14 @@ require 'labclient/resource_labels/resource_label'
 
 # Generators
 require 'labclient/generator/names'
-require 'labclient/generator/templates/template' # Helper
-require 'labclient/generator/templates/pages'
+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/access_levels.rb

@@ -2,46 +2,40 @@
 module LabClient
   # Shared Methods
   module AccessLevel
+    HUMAN_ACCESS_LEVELS = {
+      0 => :none,
+      10 => :guest,
+      20 => :reporter,
+      30 => :developer,
+      40 => :maintainer,
+      50 => :owner,
+      60 => :admin
+    }.freeze
+
+    MACHINE_ACCESS_LEVELS = {
+      none: 0,
+      guest: 10,
+      reporter: 20,
+      developer: 30,
+      maintainer: 40,
+      owner: 50,
+      admin: 60
+    }.freeze
+
     def human_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 10 then :guest
-      when 20 then :reporter
-      when 30 then :developer
-      when 40 then :maintainer
-      when 50 then :owner
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
 
     def machine_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :guest then 10
-      when :reporter then 20
-      when :developer then 30
-      when :maintainer then 40
-      when :owner then 50
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def machine_protected_access_level(level = :developer)
-      case level
-      when :none then 0
-      when :developer then 30
-      when :maintainer then 40
-      when :admin then 60
-      end
+      MACHINE_ACCESS_LEVELS[level]
     end
 
     def human_protected_access_level(level = 10)
-      case level
-      when 0 then :none
-      when 30 then :developer
-      when 40 then :maintainer
-      when 60 then :admin
-      end
+      HUMAN_ACCESS_LEVELS[level]
     end
   end
 end

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
@@ -55,6 +56,7 @@ module LabClient
       project_runners: ProjectRunners,
       projects: Projects,
       protected_branches: ProtectedBranches,
+      protected_environments: ProtectedEnvironments,
       protected_tags: ProtectedTags,
       registry: Registry,
       repo: Repositories,
@@ -91,27 +93,64 @@ 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?
+      @settings[:quiet] = false if @settings[:quiet].nil?
     end
 
     def home_file
-      ENV['HOME'] + '/.gitlab-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 })
@@ -135,14 +174,14 @@ module LabClient
 
       process resp
     rescue LabClient::Error => e
-      puts e.message
+      puts e.message unless settings[:quiet]
       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?
@@ -155,4 +194,5 @@ module LabClient
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/labclient/commits/project_helpers.rb

@@ -6,6 +6,10 @@ module LabClient
       client.commits.list(id, query)
     end
 
+    def commit(commit_id, query = {})
+      client.commits.show(id, commit_id, query)
+    end
+
     def commit_create(query = {})
       client.commits.create(id, query)
     end

data/lib/labclient/commits/show.rb

@@ -16,10 +16,19 @@ module LabClient
       DOC
     end
 
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit("b539e5d3")
+      DOC
+    end
+
     # Show
-    def show(project_id, commit_id)
+    def show(project_id, commit_id, query = {})
       project_id = format_id(project_id)
-      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit, query)
     end
   end
 end

data/lib/labclient/docs.rb

@@ -26,11 +26,11 @@ module LabClient
     # ---------------------------------
 
     # Klass Helper
-    def help
+    def help(&block)
       # require 'active_support/inflector'
       @group_name ||= group_name.pluralize
       doc 'Reference' do
-        yield
+        block.call
       end
     end
 
@@ -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
@@ -81,10 +85,10 @@ module LabClient
       subnav = subgroup.gsub(' ', '_')
 
       # Title
-      subnav += '_' + @result[:title].gsub(' ', '_') if @result.key? :title
+      subnav += "_#{@result[:title].gsub(' ', '_')}" if @result.key? :title
 
       @result[:nav] = nav
-      @result[:nav] += '-' + subnav if subnav
+      @result[:nav] += "-#{subnav}" if subnav
     end
 
     def doc(subgroup)

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