labclient 0.2.1 → 0.3.4

data/lib/labclient/klass.rb

@@ -8,13 +8,14 @@ module LabClient
 
     extend Docs
 
+    # TODO: Awesome Print / Amazing Print Conflicts?
     def verbose
-      ap self, ruby19_syntax: true
+      ap @table, ruby19_syntax: true
     end
 
     # API Methods here have to be explicitly documented / custom helpers
     # Assume no methods by default
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize
     def help(help_filter = nil)
       docs = LabClient::Docs.docs.dig(group_name, 'Reference')
       unless docs
@@ -27,9 +28,7 @@ module LabClient
         next unless doc[:options]
 
         doc[:options].each do |opt|
-          if help_filter
-            next unless (opt[:name] + opt[:text]).include? help_filter.to_s
-          end
+          next if help_filter && !(opt[:name] + opt[:text]).include?(help_filter.to_s)
 
           puts "  #{opt[:name]}"
           puts "    #{opt[:text]}\n"
@@ -39,7 +38,7 @@ module LabClient
       # Ignore Output
       nil
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize
 
     # Documented API Methods
     def api_methods
@@ -63,7 +62,12 @@ module LabClient
 
     # TODO: Combine all of these?
     def collect_project_id(position = 1)
-      response.path.split('/')[position]
+      # Check if Path / Pagination will be blank
+      if response.path.nil?
+        response.request.base_url.split(@client.base_url, 2)[position]
+      else
+        response.path.split('/')[position]
+      end
     end
 
     alias collect_group_id collect_project_id

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
@@ -17,5 +20,14 @@ module LabClient
     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,7 +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
 
@@ -305,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