labclient 0.1.1 → 0.2.0

data/lib/labclient/notes/snippets/create.rb

@@ -4,7 +4,7 @@ module LabClient
   class SnippetNotes < Common
     doc 'Snippets' do
       title 'Create'
-      desc 'Creates a new note for a single merge request [Project, Snippet ID]'
+      desc 'Creates a new note for a single snippet [Project, Snippet ID]'
       example 'client.notes.snippets.create(16, 2, body: "Hello!")'
       result <<~DOC
         => #<Note id: 44, type: Snippet>

data/lib/labclient/notes/snippets/list.rb

@@ -5,18 +5,35 @@ module LabClient
     @group_name = 'Notes'
     doc 'Snippets' do
       title 'List'
-      desc 'Gets a list of all notes for a single merge request. [Project ID, Snippet ID]'
+      desc 'Gets a list of all notes for a single snippet. [Project ID, Snippet ID]'
+      markdown <<~DOC
+        | Attribute | Type   | Required | Description                                                                          |
+        | --------- | ------ | -------- | ------------------------------------------------------------------------------------ |
+        | sort      | string | no       | Return snippet notes sorted in asc or desc order. Default is desc                      |
+        | order_by  | string | no       | Return snippet notes ordered by created_at or updated_at fields. Default is created_at |
+      DOC
+    end
+
+    doc 'Snippets' do
       example 'client.notes.snippets.list(16, 1)'
       result <<~DOC
         => [#<Note id: 21, type: Snippet>, #<Note id: 20, type: Snippet> .. ]
       DOC
     end
 
-    def list(project_id, snippet_id)
+    doc 'Snippets' do
+      desc 'Filter or Sort'
+      example 'client.notes.snippets.list(16, 1, order_by: :created_at, sort: :asc)'
+      result <<~DOC
+        => [#<Note id: 21, type: Snippet>, #<Note id: 20, type: Snippet> .. ]
+      DOC
+    end
+
+    def list(project_id, snippet_id, query = {})
       project_id = format_id(project_id)
       snippet_id = format_id(snippet_id)
 
-      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/notes", Note)
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/notes", Note, query)
     end
   end
 end

data/lib/labclient/notes/snippets/show.rb

@@ -4,7 +4,7 @@ module LabClient
   class SnippetNotes < Common
     doc 'Snippets' do
       title 'Show'
-      desc 'Returns a single note for a given merge request. [Project ID, Snippet ID, Note ID]'
+      desc 'Returns a single note for a given snippet. [Project ID, Snippet ID, Note ID]'
       example 'client.notes.snippets.show(16, 1, 43)'
       result <<~DOC
         => #<Note id: 21, type: Snippet>

data/lib/labclient/notifications/update.rb

@@ -33,7 +33,7 @@ module LabClient
       result <<~DOC
            OpenStruct {
              :level => "custom",
-            :events => OpenStruct {
+            :events => LabStruct {
                            :new_release => nil,
                               :new_note => nil,
                              :new_issue => nil,

data/lib/labclient/overview.rb

@@ -7,11 +7,15 @@ module LabClient
 
     doc 'Overview' do
       title 'About'
-      desc <<~DOC
+      markdown <<~DOC
         Labclient is another Gitlab API Gem. A focus on ease of use and helpers and snippets.
 
         <a href="https://github.com/NARKOZ/gitlab">Gitlab</a> is an excellent gem, and is nearly complete in its implementation. While this is still a work in progress and you are looking for general use you should use it.
+
+        Here's a quick whirlwind example of some of the features:
       DOC
+
+      demo '350689'
     end
 
     doc 'Overview' do
@@ -44,6 +48,41 @@ module LabClient
       DOC
     end
 
+    doc 'Authentication' do
+      title 'Named Profiles'
+      markdown 'Within the `~/.gitlab-labclient` you can also specify profile names'
+      example <<~DOC
+        {
+          "prod": {
+            "url": "https://labclient-prod",
+            "token": "super_secure",
+            "paginate": false
+          },
+          "dev": {
+            "url": "https://labclient-dev",
+            "token": "super_secure",
+            "ssl_verify": false,
+            "paginate": true
+          }
+        }
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Manually select a named profile'
+      example <<~DOC
+        client = LabClient::Client.new(profile: 'prod')
+      DOC
+    end
+
+    doc 'Authentication' do
+      desc 'Automatically select via ENV Variables'
+      example <<~DOC
+        ENV['LABCLIENT_PROFILE'] = 'dev'
+        client = LabClient::Client.new
+      DOC
+    end
+
     doc 'Authentication' do
       title 'Environment Variables'
       desc 'If not provided, and credentials file does not exist will attempt to use ENV variables'
@@ -143,6 +182,27 @@ module LabClient
       DOC
     end
 
+    doc 'Response' do
+      title 'Status'
+      desc 'Each object/call will return a "response" object or the instantiated class object. On each of these you can use "success?" to verify the response of a call.'
+
+      result <<~DOC
+        project = client.projects.show 123123
+        # => #<TyphoeusResponse code: 404>
+        project.success?
+        # => false
+
+        user = client.users.show 1
+        => #<User id: 1, username: root>
+        user.success?
+        => true
+      DOC
+
+      result <<~DOC
+        curl -k -H "Private-Token: super_secret_token" -H "Accept: application/json" "https://labclient/api/v4/users?"
+      DOC
+    end
+
     doc 'Other' do
       title 'Common Helpers'
       markdown <<~DOC
@@ -191,6 +251,20 @@ module LabClient
       DOC
     end
 
+    doc 'Other' do
+      desc 'Object Help'
+
+      result <<~DOC
+        project = client.projects.show(5)
+
+        # List Possible Methods
+        project.help
+
+        # Array result of methods
+        project.api_methods
+      DOC
+    end
+
     doc 'Other' do
       title 'Object IDs'
 
@@ -218,17 +292,18 @@ module LabClient
     end
 
     doc 'Other' do
-      title 'Docker'
-      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
-
-      example 'docker run -it registry.gitlab.com/labclient/labclient'
-
-      result <<~DOC
-        # Run Container
-        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="token" registry.gitlab.com/labclient/labclient
+      title 'Quiet'
+      desc 'Error messages by default are printed to STDOUT. This can be supressed via the :quiet setting'
 
-        client = LabClient::Client.new
-        client.users.list
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab api token',
+          quiet: true
+        )
+        
+        # Or after the init
+        client.settings[:quiet] = true
       DOC
     end
 
@@ -256,6 +331,30 @@ module LabClient
         - [API Authentication](https://docs.gitlab.com/ee/api/README.html#authentication)
       DOC
     end
+
+    doc 'Docker' do
+      desc 'A docker image is created from master and can be used to execute snippets or load a quick pry session'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        # Run Container
+        docker run -it registry.gitlab.com/labclient/labclient
+        # Without settings configured, initial will prompt for credentials
+
+        client.users.list
+      DOC
+    end
+
+    doc 'Docker' do
+      desc 'The docker container configured and execute code snippets'
+
+      example 'docker run -it registry.gitlab.com/labclient/labclient'
+
+      result <<~DOC
+        docker run -it -e LABCLIENT_URL="https://labclient" -e LABCLIENT_TOKEN="secure_token" labclient 'puts client.users.list.count'
+      DOC
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/labclient/paginated_response.rb

@@ -40,7 +40,9 @@ module LabClient
       DOC
     end
 
+    # rubocop:disable Lint/MissingSuper
     def respond_to_missing?(method_name, include_private = false); end
+    # rubocop:enable Lint/MissingSuper
 
     def each_page(&block)
       yield @array # This will eventually be the whole list
@@ -86,7 +88,7 @@ module LabClient
     end
 
     def link_regex
-      /<([^>]+)>; rel=\"([^\"]+)\"/
+      /<([^>]+)>; rel="([^"]+)"/
     end
 
     def next_page
@@ -111,5 +113,10 @@ module LabClient
         process_entry(entry, @response)
       end
     end
+
+    # Forward response success
+    def success?
+      @response.success?
+    end
   end
 end

data/lib/labclient/pipelines/pipeline.rb

@@ -33,6 +33,45 @@ module LabClient
       client.jobs.pipeline(project_id, id, scope)
     end
 
+    def reload
+      project_id = collect_project_id
+      update_self client.pipelines.show(project_id, id)
+    end
+
+    # The status of pipelines, one of: running, pending, success, failed, canceled, skipped, created, manual
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_status(total_time = 300, sleep_time = 15)
+      # running
+      # pending
+      # success
+      # failed
+      # canceled
+      # skipped
+      # manual
+      # created
+
+      # Wait
+      # [running created pending]
+
+      # Success
+      # [skipped manual canceled success]
+
+      # Fail
+      # [failed]
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts "Waiting for Pipeline: #{status}"
+          break if %w[skipped manual canceled success].include? status
+          raise 'Pipeline failed' if status == 'failed'
+
+          sleep sleep_time
+        end
+      end
+    end
+
     # DateTime Fields
     date_time_attrs %i[created_at updated_at finished_at started_at]
     user_attrs %i[user]
@@ -43,6 +82,8 @@ module LabClient
       option 'retry', 'Retry jobs in this pipeline'
       option 'cancel', 'Cancel jobs in this pipeline'
       option 'delete', 'Delete this pipeline'
+      option 'reload', 'Reload this pipeline object (New API Call)'
+      option 'wait_for_status', 'Looping, wait for merge request status [Timeout, Interval]'
     end
   end
 end

data/lib/labclient/projects/methods.rb

@@ -7,8 +7,8 @@ module LabClient
       client.projects.users(id)
     end
 
-    def events
-      client.events.project(id)
+    def events(query = {})
+      client.events.project(id, query)
     end
 
     def delete
@@ -346,6 +346,10 @@ module LabClient
       client.branches.show(id, branch_id)
     end
 
+    def branch_create(query)
+      client.branches.create(id, query)
+    end
+
     def branch_delete(branch_id)
       client.branches.delete(id, branch_id)
     end
@@ -488,6 +492,23 @@ module LabClient
       client.projects.environments.stop(id, environment_id)
     end
 
+    # Protected Environments
+    def protected_environments
+      client.protected_environments.list(id)
+    end
+
+    def protected_environment(environment_id)
+      client.protected_environments.show(id, environment_id)
+    end
+
+    def protect_environment(query)
+      client.protected_environments.protect(id, query)
+    end
+
+    def unprotect_environment(environment_id)
+      client.protected_environments.unprotect(id, environment_id)
+    end
+
     # Project Triggers
     def triggers
       client.projects.triggers.list(id)
@@ -620,6 +641,10 @@ module LabClient
       client.merge_requests.list_project(id, query)
     end
 
+    def merge_request_create(query)
+      client.merge_requests.create(id, query)
+    end
+
     # Access Requests
     def request_access
       client.projects.access_requests.create(id)
@@ -681,6 +706,50 @@ module LabClient
     def clusters
       client.projects.clusters.list(id)
     end
+
+    # Reload
+    def reload
+      update_self client.projects.show(id)
+    end
+
+    # Parent Helper
+    def parent
+      case namespace.kind
+      when 'user'
+        client.users.show(namespace.id)
+      when 'group'
+        client.groups.show(namespace.id)
+      end
+    end
+
+    # Snippets
+    def snippets
+      client.projects.snippets.list(id)
+    end
+
+    def snippet_create(query)
+      client.projects.snippets.create(id, query)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_import(total_time = 300, sleep_time = 15)
+      # none
+      # scheduled
+      # failed
+      # started
+      # finished
+
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts "Waiting for Import Status: #{import_status}"
+          break if %w[none finished].include? import_status
+          raise "Import Failed: #{import_error}" if import_status == 'failed'
+
+          sleep sleep_time
+        end
+      end
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/labclient/projects/reference.rb

@@ -8,6 +8,9 @@ module LabClient
       option 'archive', 'Archive this project'
       option 'delete', 'Schedule/Delete this project'
       option 'events', "List this project's events"
+      option 'reload', 'Reload this project object (New API Call)'
+      option 'wait_for_import', 'Looping, wait for project import [Timeout, Interval]'
+
       option 'fork_existing', 'Create Fork Relationship [Target/Source Project]'
       option 'fork_remove', 'Remove Fork Relationshgip'
       option 'fork', 'Fork this project, accepts hash, [namespace, path, name]'
@@ -68,6 +71,12 @@ module LabClient
       option 'environment_update', 'Update project environment [Environment ID, Hash]'
       option 'environment_stop', 'Stop project environment [Environment ID]'
 
+      # Protected Environments
+      option 'protected_environments', 'List protected environments [String]'
+      option 'protected_environment', 'Show single protected environment [String]'
+      option 'protect_environment', 'Protect a single environment [Hash]'
+      option 'unprotect_environment', 'Unprotect environment [Environment]'
+
       # Deployments
       option 'deployments', "List this project's deployments"
       option 'deployment_create', 'Create project deployment [Hash]'
@@ -201,6 +210,7 @@ module LabClient
       # Branches
       option 'branches', 'List repository branches [String]'
       option 'branch', 'Get a single repository branches [Branch Name]'
+      option 'branch_create', 'Create a repository branches [Hash]'
       option 'branch_delete', 'Delete a single repository branches [Branch Name]'
       option 'branch_delete_merged', 'Will delete all branches that are merged into the project’s default branch'
 
@@ -238,6 +248,7 @@ module LabClient
 
       # Merge Requests
       option 'merge_requests', 'List project merge requests, [Hash]'
+      option 'merge_request_create', 'Create new merge request [Hash]'
 
       # Access Requests
       option 'access_requests', 'List access requests for project'
@@ -251,6 +262,9 @@ module LabClient
 
       # Clusters
       option 'clusters', 'Returns a list of project clusters.'
+
+      option 'events', 'List project events [Hash]'
+      option 'parent', 'Show (API Call) Project Parent, returns either Group or User'
     end
   end
   # rubocop:enable Metrics/BlockLength, Metrics/ClassLength