labclient 0.1.2 → 0.2.1

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

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/environments/project_environment.rb

@@ -24,6 +24,14 @@ module LabClient
       client.projects.environments.delete(project_id, id)
     end
 
+    def show
+      project_id = collect_project_id
+
+      update_self client.projects.environments.show(project_id, id)
+    end
+
+    alias reload show
+
     def stop
       project_id = collect_project_id
 
@@ -35,6 +43,8 @@ module LabClient
     help do
       subtitle 'ProjectEnvironment'
       option 'project', 'Show Project'
+      option 'show', 'Collect/reload environment'
+      option 'reload', 'Collect/reload environment'
       option 'update', 'Update this environment [Hash]'
       option 'delete', 'Delete this environment'
       option 'stop', 'Stop this environment'

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
@@ -472,6 +476,8 @@ module LabClient
       client.projects.environments.show(id, environment_id)
     end
 
+    alias environment environment_show
+
     def environment_create(query)
       client.projects.environments.create(id, query)
     end
@@ -488,6 +494,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 +643,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)
@@ -687,6 +714,25 @@ module LabClient
       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
@@ -698,6 +744,7 @@ module LabClient
       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'
 

data/lib/labclient/projects/reference.rb

@@ -71,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]'
@@ -133,6 +139,7 @@ module LabClient
 
       # Commits
       option 'commits', 'List Commits [Hash]'
+      option 'commit', 'Show Commit [String/Commit Sha]'
       option 'commit_create', 'Create new commit [Hash]'
       option 'commit_refs', 'Get all references (from branches or tags) a commit is pushed to. [Commit ID, Scope]'
       option 'commit_cherry_pick', 'Cherry picks a commit to a target branch. [Commit ID, Branch]'
@@ -204,6 +211,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'
 
@@ -241,6 +249,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'
@@ -254,6 +263,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

data/lib/labclient/projects/snippets/project_snippet.rb

@@ -35,6 +35,14 @@ module LabClient
       client.projects.snippets.delete(project_id, id)
     end
 
+    def notes
+      client.notes.snippets.list(project_id, id)
+    end
+
+    def note_create(query)
+      client.notes.snippets.create(project_id, id, query)
+    end
+
     date_time_attrs %i[updated_at created_at]
 
     user_attrs %i[author]
@@ -45,6 +53,10 @@ module LabClient
       option 'agent_detail', 'Hash of user agent details.'
       option 'delete', 'Delete this deploy key.'
       option 'update', 'Update this this deploy key.'
+
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
     end
   end
 end

data/lib/labclient/protected_branches/protect.rb

@@ -19,11 +19,12 @@ module LabClient
         | allowed_to_unprotect          | array          | no  | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
         | code_owner_approval_required  | boolean        | no  | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the CODEOWNERS file (defaults: false) |
 
-        *Valid access levels*
-        0  => No access, :none
-        30 => Developer access, :developer
-        40 => Maintainer access, :maintainer
-        60 => Admin access, :admin
+        **Valid access levels**
+
+        - 0, :none  => No access
+        - 30, :developer => Developer access
+        - 40, :maintainer => Maintainer access
+        - 60, :admin => Admin access
 
       DOC
     end

data/lib/labclient/protected_environments/list.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'List' do
+      desc 'Gets a list of protected environmentes from a project. [Project ID, String]'
+      example 'client.protected_environments.list(36)'
+      result '[#<ProtectedEnvironment name: prod>]'
+
+      markdown <<~DOC
+        Search: You can use ^term and term$ to find environmentes that begin and end with term respectively.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environments
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/protected_environments", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/protect.rb

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Protect' do
+      desc 'Protects a single environment [Project ID, Hash]'
+      example <<~DOC
+        client.protected_environments.protect(36,
+          name: :prod,
+          deploy_access_levels: [
+            { access_level: :developer }
+          ]
+        )
+      DOC
+      result '#<ProtectedEnvironment name: prod>'
+
+      markdown <<~DOC
+        | Attribute            | Type           | Required | Description                                                                                                      |
+        | -------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
+        | name                 | string         | yes      | The name of the environment.                                                                                     |
+        | deploy_access_levels | array          | yes      | Array of access levels allowed to deploy, with each described by a hash.                                         |
+
+        Elements in the deploy_access_levels array should take the form {user_id: integer}, {group_id: integer} or {access_level: integer}. Each user must have access to the project and each group must have this project shared.
+
+        **Valid access levels**
+
+        | Access Level | Values          |
+        | ------------ | --------------- |
+        | Developer    | 30, :developer  |
+        | Maintainer   | 40, :maintainer |
+        | Admin        | 60, :admin      |
+
+      DOC
+    end
+
+    doc 'Protect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protect_environment(name: :other, push_access_level: :admin)
+      DOC
+    end
+
+    def protect(project_id, query)
+      query[:deploy_access_levels].each do |access_level|
+        protected_query_access_level(access_level, :access_level)
+      end
+
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/protected_environments", ProtectedEnvironment, query)
+    end
+  end
+end

data/lib/labclient/protected_environments/protected_environment.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProtectedEnvironment < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProtectedEnvironment name: #{name}>"
+    end
+
+    def unprotect
+      project_id = collect_project_id
+
+      client.protected_environments.unprotect(project_id, name)
+    end
+
+    help do
+      subtitle 'ProjectEnvironment'
+      option 'project', 'Show Project'
+      option 'unprotect', 'Remove protected environment'
+    end
+  end
+end

data/lib/labclient/protected_environments/show.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Show' do
+      desc 'Gets a single protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.show(36, :prod)'
+      result '#<ProtectedEnvironment name: prod>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_environment(:master)
+      DOC
+    end
+
+    def show(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", ProtectedEnvironment)
+    end
+  end
+end

data/lib/labclient/protected_environments/unprotect.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedEnvironments < Common
+    doc 'Unprotect' do
+      desc 'Unprotects the given protected environment [Project ID, ProtectedEnvironment]'
+      example 'client.protected_environments.unprotect(264, :prod)'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.unprotect_environment(:other)
+      DOC
+    end
+
+    doc 'Unprotect' do
+      desc 'via ProtectedEnvironment'
+      example <<~DOC
+        protected_env = client.protected_environments.show(36, :prod)
+        protected_env.unprotect
+      DOC
+    end
+
+    def unprotect(project_id, environment_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/protected_environments/#{environment_id}")
+    end
+  end
+end