labclient 0.1.3 → 0.3.0

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

@@ -11,6 +11,14 @@ module LabClient
       DOC
     end
 
+    doc 'Merge Request' do
+      desc 'Via Merge Request'
+      example <<~DOC
+        merge_request = client.merge_requests.show(16, 2)
+        merge_request.note_create(body: 'There!')
+      DOC
+    end
+
     doc 'Merge Requests' do
       markdown <<~DOC
         | Attribute  | Type   | Required | Description |

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'
@@ -167,16 +206,21 @@ module LabClient
     doc 'Other' do
       title 'Common Helpers'
       markdown <<~DOC
-        The main api namespaces have a `help` and an `api_methods` methods. These will print out available methods and examples
+        The main api namespaces have a `help` and an `api_methods` methods. These will print out available methods and examples.
+
+        These each accept a filter argument
       DOC
 
       result <<~DOC
+        # General Help / Available Methods
         client.help
         client.api_methods
 
+        # Show Project specific Methods
         client.projects.api_methods
         # => [:show, :list, :create]
 
+        # Show Users specific help
         client.users.help
         Users
           Available Methods
@@ -191,6 +235,26 @@ module LabClient
         User
           - client.users.show(5)
           - client.users.show(5)
+          
+        # General Help Filter
+        client.help :protect
+        Available Methods
+        - protected_branches protected_environments protected_tags
+        
+        # Projects Help Filter
+        client.projects.help :cluster
+        Projects
+          Available Methods
+              - clusters
+      
+        # Project Object Help
+        project = client.projects.show(16)
+        project.help
+
+        # Project Object Help Filter
+        project.help :member
+
+
       DOC
     end
 
@@ -209,6 +273,9 @@ module LabClient
         # Awesome Print all details
         project.valid_group_project_levels
         # => [:guest, :reporter, :developer, :maintainer, :owner]
+
+        # Select Data from objects with `slice`
+        project.slice(:readme_url, :owner)
       DOC
     end
 
@@ -253,17 +320,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'
+      title 'Quiet'
+      desc 'Error messages by default are printed to STDOUT. This can be supressed via the :quiet setting'
 
-      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
-
-        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
 
@@ -291,6 +359,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

data/lib/labclient/projects/clusters/add.rb

@@ -27,7 +27,7 @@ module LabClient
         | --------- | ---- | -------- | ----------- |
         | name      | string | yes | The name of the cluster |
         | domain      | string | no | The base domain of the cluster |
-        | management_project_id | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster |
+        | management_project_id | integer | no | The ID of the management project for the cluster |
         | enabled      | boolean | no | Determines if cluster is active or not, defaults to true |
         | managed      | boolean | no | Determines if GitLab will manage namespaces and service accounts for this cluster, defaults to true |
         | platform_kubernetes_attributes[api_url] | string | yes | The URL to access the Kubernetes API |

data/lib/labclient/projects/clusters/delete.rb

@@ -11,11 +11,10 @@ module LabClient
 
     doc 'Delete' do
       markdown <<~DOC
-        | Attribute              | Type    | Required   | Description                                         |
-        | ----------             | -----   | ---------  | ------------                                        |
-        | url                    | String  | yes        | The URL of the remote repository to be clustered.    |
-        | enabled                | Boolean | no         | Determines if the cluster is enabled.                |
-        | only_protected_branches| Boolean | no         | Determines if only protected branches are clustered. |
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | `id` | integer | yes | The ID of the project owned by the authenticated user |
+        | `cluster_id` | integer | yes | The ID of the cluster |
       DOC
     end
 
@@ -23,7 +22,7 @@ module LabClient
       desc 'Via ProjectCluster [Params]'
       example <<~DOC
         cluster = client.projects.clusters.list(310).first
-        cluster.update(enabled: false)
+        cluster.delete
       DOC
     end
 

data/lib/labclient/projects/clusters/show.rb

@@ -12,10 +12,10 @@ module LabClient
     end
 
     doc 'Show' do
-      desc 'Via Project'
+      desc 'Via Project [Cluster ID]'
       example <<~DOC
         project = client.projects.show(16)
-        project.clusters
+        project.cluster(cluster_id)
       DOC
     end
 

data/lib/labclient/projects/clusters/update.rb

@@ -11,11 +11,19 @@ module LabClient
 
     doc 'Update' do
       markdown <<~DOC
-        | Attribute              | Type    | Required   | Description                                         |
-        | ----------             | -----   | ---------  | ------------                                        |
-        | url                    | String  | yes        | The URL of the remote repository to be clustered.    |
-        | enabled                | Boolean | no         | Determines if the cluster is enabled.                |
-        | only_protected_branches| Boolean | no         | Determines if only protected branches are clustered. |
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name      | string | yes | The name of the cluster |
+        | domain      | string | no | The base domain of the cluster |
+        | management_project_id | integer | no | The ID of the management project for the cluster |
+        | platform_kubernetes_attributes[api_url] | string | yes | The URL to access the Kubernetes API |
+        | platform_kubernetes_attributes[token] | string | yes | The token to authenticate against Kubernetes |
+        | platform_kubernetes_attributes[ca_cert] | string | no | TLS certificate. Required if API is using a self-signed TLS certificate. |
+        | platform_kubernetes_attributes[namespace] | string | no | The unique namespace related to the project |
+        | environment_scope | string | no | The associated environment to the cluster. Defaults to * **(PREMIUM)** |
+
+        `name`, `api_url`, `ca_cert` and `token` can only be updated if the cluster was added through the
+        “Add existing Kubernetes cluster” option or through the “Add existing cluster to project” endpoint.
       DOC
     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/forks/fork.rb

@@ -2,8 +2,6 @@
 module LabClient
   # Specifics
   class Projects < Common
-    @group_name = 'Project Forks'
-
     doc 'Create' do
       desc 'Forks a project into the user namespace of the authenticated user or the one provided.'
       example 'client.projects.fork(299)'

data/lib/labclient/projects/methods.rb

@@ -476,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
@@ -492,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)
@@ -690,6 +709,10 @@ module LabClient
       client.projects.clusters.list(id)
     end
 
+    def cluster(cluster_id)
+      client.projects.clusters.show(id, cluster_id)
+    end
+
     # Reload
     def reload
       update_self client.projects.show(id)

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]'

data/lib/labclient/projects/stars/starrers.rb

@@ -2,8 +2,6 @@
 module LabClient
   # Specifics
   class Projects < Common
-    @group_name = 'Project Stars'
-
     doc 'Starrers' do
       desc 'List the users who starred the specified project. [user id]'
       example 'client.projects.starrers(5)'

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