labclient 0.3.2 → 0.3.3

data/lib/labclient/overview.rb

@@ -11,10 +11,10 @@ module LabClient
         LabClient is a Gitlab API Gem. Focusing on ease of use, documentation, helpers, and snippets.
 
         - Objects for resources (User, Project)
-        - Method Chaining ( project.branch(:master).pipelines ) 
-        
+        - Method Chaining ( project.branch(:master).pipelines )
+
         Lots of Helpers
-        
+
         - Pagination
         - IRB/Pry
         - Setup: credentials file, profiles, and prompt
@@ -202,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.'
@@ -255,26 +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
 
@@ -349,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