labclient 0.2.0 → 0.3.3

data/lib/labclient/lab_struct.rb

@@ -2,6 +2,9 @@
 module LabClient
   # Unique inherited class to not override top level openstruct
   class LabStruct < OpenStruct
+    include CurlHelper
+    attr_reader :response
+
     def keys
       to_h.keys.sort
     end
@@ -13,5 +16,18 @@ module LabClient
     def as_json(*args)
       super.as_json['table']
     end
+
+    def slice(*opts)
+      to_h.slice(*opts)
+    end
+
+    def client
+      response.client
+    end
+
+    # Forward response success
+    def success?
+      @response.success?
+    end
   end
 end

data/lib/labclient/merge_requests/list.rb

@@ -58,7 +58,7 @@ module LabClient
     doc 'List' do
       title 'Project'
       desc 'List project merge requests [Project ID, Hash]'
-      example 'client.merge_requests.list(16, created_after: 10.day.ago)'
+      example 'client.merge_requests.list_project(16, created_after: 10.day.ago)'
       result <<~DOC
         => [#<MergeRequest id: 37, title: Add new file>, #<MergeRequest id: 36, title: Update README.md>, ...]
       DOC

data/lib/labclient/overview.rb

@@ -8,11 +8,20 @@ module LabClient
     doc 'Overview' do
       title 'About'
       markdown <<~DOC
-        Labclient is another Gitlab API Gem. A focus on ease of use and helpers and snippets.
+        LabClient is a Gitlab API Gem. Focusing on ease of use, documentation, 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.
+        - Objects for resources (User, Project)
+        - Method Chaining ( project.branch(:master).pipelines )
 
-        Here's a quick whirlwind example of some of the features:
+        Lots of Helpers
+
+        - Pagination
+        - IRB/Pry
+        - Setup: credentials file, profiles, and prompt
+        - Permission Levels
+        - Curl generator
+
+        Here is a quick whirlwind example of some of the features:
       DOC
 
       demo '350689'
@@ -93,6 +102,17 @@ module LabClient
       DOC
     end
 
+    doc 'Authentication' do
+      title 'OAuth Authorization'
+      desc 'Use OAuth access tokens to make requests to the API on behalf of a user. '
+      example <<~DOC
+        client = LabClient::Client.new(
+          url: 'https://gitlab.labclient',
+          token: 'gitlab oauth token',
+          token_type: 'Authorization'
+        )
+      DOC
+    end
     doc 'Pagination' do
       desc 'Pagination is enabled by default if not specified. Can be explicitly enabled or disabled'
       example <<~DOC
@@ -182,6 +202,31 @@ module LabClient
       DOC
     end
 
+    doc 'Pagination' do
+      title 'Other Pagination Helpers'
+    end
+
+    doc 'Pagination' do
+      desc 'Total Results'
+      example <<~DOC
+        client.users.list.total
+      DOC
+    end
+
+    doc 'Pagination' do
+      desc 'Total Pages'
+      example <<~DOC
+        client.users.list.total_pages
+      DOC
+    end
+
+    doc 'Pagination' do
+      desc 'Current Page'
+      example <<~DOC
+        client.users.list.page
+      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.'
@@ -206,16 +251,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
@@ -230,6 +280,24 @@ 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
 
@@ -248,6 +316,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
 
@@ -301,7 +372,7 @@ module LabClient
           token: 'gitlab api token',
           quiet: true
         )
-        
+
         # Or after the init
         client.settings[:quiet] = true
       DOC

data/lib/labclient/paginated_response.rb

@@ -118,5 +118,17 @@ module LabClient
     def success?
       @response.success?
     end
+
+    def total_pages
+      response.headers['x-total-pages'].to_i
+    end
+
+    def total
+      response.headers['x-total'].to_i
+    end
+
+    def page
+      response.headers['x-page'].to_i
+    end
   end
 end

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