labclient 0.3.0 → 0.3.5

data/lib/labclient/http.rb

@@ -42,13 +42,19 @@ module LabClient
     def headers(dump_json)
       default_headers = {
 
-        'Private-Token' => settings[:token],
-
         'Accept' => 'application/json',
         'User-Agent' => "LabClient #{LabClient::VERSION}"
       }
 
+      token_type = settings[:token_type]
+      default_headers[token_type] = if token_type == 'Authorization'
+                                      "Bearer #{settings[:token]}"
+                                    else
+                                      settings[:token]
+                                    end
+
       default_headers['Content-Type'] = 'application/json' if dump_json
+
       default_headers
     end
   end
@@ -58,11 +64,12 @@ end
 module Typhoeus
   # Add Data :  OJ Parsing
   class Response
+    include CurlHelper
     def inspect
       "#<TyphoeusResponse code: #{code}>"
     end
 
-    attr_reader :path
+    attr_reader :path, :client
 
     def data
       return @data if @data
@@ -70,13 +77,20 @@ module Typhoeus
       @data = process_body
     end
 
+    # Shim for CurlHelper
+    def response
+      self
+    end
+
     def process_body
       if body.empty?
         nil
       elsif headers['content-type']&.include? 'text/plain'
         body
       else
-        Oj.load(body, mode: :compat, object_class: LabClient::LabStruct)
+        result = Oj.load(body, mode: :compat, object_class: LabClient::LabStruct)
+        result.instance_variable_set(:@response, self) if result.instance_of?(LabClient::LabStruct)
+        result
       end
     end
 

data/lib/labclient/klass.rb

@@ -8,8 +8,9 @@ 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
@@ -61,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
+        CGI.unescape 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.'
@@ -235,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
 
@@ -329,7 +372,7 @@ module LabClient
           token: 'gitlab api token',
           quiet: true
         )
-        
+
         # Or after the init
         client.settings[:quiet] = true
       DOC