labclient 0.1.0 → 0.1.5

data/lib/labclient/issues/todo.rb

@@ -4,7 +4,7 @@ module LabClient
   class Issues < Common
     doc 'Update' do
       title 'Todo'
-      desc 'Manually creates a todo for the current user on an issue. [project id, merge request iid]'
+      desc 'Manually creates a todo for the current user on an issue. [Project ID, merge request iid]'
 
       example 'client.issues.todo(30, 1)'
 

data/lib/labclient/issues/unsubscribe.rb

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

data/lib/labclient/issues/update.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class Issues < Common
     doc 'Update' 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.update(5, 1, title: "Moar Fancy!")'
       result <<~DOC
         => #<Issue id: 1, title: Moar Fancy!, state: opened>

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,6 +27,10 @@ module LabClient
         next unless doc[:options]
 
         doc[:options].each do |opt|
+          if help_filter
+            next unless (opt[:name] + opt[:text]).include? help_filter.to_s
+          end
+
           puts '  ' + opt[:name]
           puts "    #{opt[:text]}\n"
         end
@@ -33,6 +39,27 @@ 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]
+    end
 
     # TODO: Combine all of these?
     def collect_project_id(position = 1)
@@ -81,6 +108,11 @@ module LabClient
       end
     end
 
+    # Forward response success
+    def success?
+      @response.success?
+    end
+
     # Formatting Time Helper
     def format_time?(time)
       time.respond_to?(:to_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

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

@@ -4,13 +4,22 @@ module LabClient
   class MergeRequests < Common
     doc 'Update' do
       title 'Accept'
-      desc 'Merge changes submitted with MR. [project id, merge request iid]'
+      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/cancel_auto_merge.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Update' do
       title 'Cancel Auto Merge'
-      desc 'Cancel Automatic Merge When Pipeline Succeeds [project id, merge request iid]'
+      desc 'Cancel Automatic Merge When Pipeline Succeeds [Project ID, merge request iid]'
       markdown <<~DOC
         - If you don't have permissions to accept this merge request - you'll get a `401`
 

data/lib/labclient/merge_requests/changes.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Show' do
       title 'Changes'
-      desc 'Shows information about the merge request including its files and changes. [project id, mr iid]'
+      desc 'Shows information about the merge request including its files and changes. [Project ID, mr iid]'
       example 'client.merge_requests.changes(333,1)'
       result <<~DOC
         => #<Changes MR: 1, title: Update README.md>

data/lib/labclient/merge_requests/closes_issues.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Show' do
       title 'Closes Issues'
-      desc 'Get all the issues that would be closed by merging the provided merge request. [project id, mr iid]'
+      desc 'Get all the issues that would be closed by merging the provided merge request. [Project ID, mr iid]'
       example 'client.merge_requests.closes_issues(343, 1)'
       result <<~DOC
         => => [#<Issue id: 1, title: Problem!, state: opened>]

data/lib/labclient/merge_requests/commits.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Show' do
       title 'Commits'
-      desc 'Get a list of merge request commits. [project id, mr iid]'
+      desc 'Get a list of merge request commits. [Project ID, mr iid]'
       example 'client.merge_requests.commits(333,1)'
       result <<~DOC
         => [#<Commit title: Update README.md, sha: 50c90734>, #<Commit title: Add new file, sha: 6534a685>]

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/delete.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class MergeRequests < Common
     doc 'Delete' do
-      desc 'Only for admins and project owners. Deletes the merge request in question. [project id, merge request iid]'
+      desc 'Only for admins and project owners. Deletes the merge request in question. [Project ID, merge request iid]'
 
       example 'client.merge_requests.delete(343, 2)'
 

data/lib/labclient/merge_requests/diff_versions.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Diff' do
       title 'Versions'
-      desc 'Get a list of merge request diff versions. [project id, mr iid]'
+      desc 'Get a list of merge request diff versions. [Project ID, mr iid]'
       example 'client.merge_requests.diff_versions(333,1)'
       result <<~DOC
         => [#<MergeRequestDiff id: 3, MR: 1, state: collected>, #<MergeRequestDiff id: 2, MR: 1, state: collected>, ..]

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

data/lib/labclient/merge_requests/participants.rb

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

data/lib/labclient/merge_requests/pipelines.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Pipelines' do
       title 'List'
-      desc 'Get a list of merge request pipelines. [project id, mr iid]'
+      desc 'Get a list of merge request pipelines. [Project ID, mr iid]'
       example 'client.merge_requests.pipelines(343,1)'
       result <<~DOC
         => [#<Pipeline id: 4, ref: branch, status: success>]
@@ -33,7 +33,7 @@ module LabClient
 
     doc 'Pipelines' do
       title 'Create'
-      desc 'Create a new pipeline for a merge request. Requires .gitlab-ci.yml to be configured with only: [merge_requests] to create jobs. [project id, mr iid]'
+      desc 'Create a new pipeline for a merge request. Requires .gitlab-ci.yml to be configured with only: [merge_requests] to create jobs. [Project ID, mr iid]'
       example 'client.merge_requests.create_pipeline(343, 1)'
       result <<~DOC
         => #<Pipeline id: 7, ref: refs/merge-requests/1/head, status: pending>

data/lib/labclient/merge_requests/rebase.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Update' do
       title 'Rebase'
-      desc 'Rebase a merge request [project id, merge request iid, skip_ci (true/false)]'
+      desc 'Rebase a merge request [Project ID, merge request iid, skip_ci (true/false)]'
       markdown <<~DOC
         - Automatically rebase the `source_branch` of the merge request against its `target_branch`.
 

data/lib/labclient/merge_requests/show.rb

@@ -3,7 +3,7 @@ module LabClient
   # Specifics
   class MergeRequests < Common
     doc 'Show' do
-      desc 'Shows information about a single merge request. [project id, mr iid]'
+      desc 'Shows information about a single merge request. [Project ID, mr iid]'
       example 'client.merge_requests.show(333,1)'
       result <<~DOC
         => #<MergeRequest id: 37, title: Add new file>

data/lib/labclient/merge_requests/subscribe.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Update' do
       title 'Subscribe'
-      desc 'Subscribes the authenticated user to a merge request to receive notification. [project id, merge request iid]'
+      desc 'Subscribes the authenticated user to a merge request to receive notification. [Project ID, merge request iid]'
 
       example 'client.merge_requests.subscribe(343, 7)'
 

data/lib/labclient/merge_requests/time_stats.rb

@@ -4,7 +4,7 @@ module LabClient
   class MergeRequests < Common
     doc 'Time Stats' do
       title 'Show'
-      desc 'Get time tracking stats. [project id, mr iid]'
+      desc 'Get time tracking stats. [Project ID, mr iid]'
       example 'client.merge_requests.time_stats(333, 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, mr iid, duration]'
+      desc 'Adds spent time for this merge request. [Project ID, mr 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, mr iid, duration]'
+      desc 'Sets an estimated time of work for this merge request. [Project ID, mr 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, mr iid]'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [Project ID, mr iid]'
       example 'client.merge_requests.reset_time_estimate(333, 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, mr iid]'
+      desc 'Resets the estimated time for this merge request to 0 seconds. [Project ID, mr iid]'
       example 'client.merge_requests.reset_spent_time(333, 1)'
       result <<~DOC
         => {:time_estimate=>0, :total_time_spent=>0, :human_time_estimate=>nil, :human_total_time_spent=>nil}