gitlab_ruby 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90821189da268f6135e016d179b18e8a735193e5
-  data.tar.gz: 873b28591624edb594704eb49656e958eac20a8b
+  metadata.gz: bb9367bda76771fed3eee0814db63776fcb1f94d
+  data.tar.gz: b18be4250cacebbbb8299e577b58755f9b3e6d22
 SHA512:
-  metadata.gz: 483d4b7cf43cae4847b1a1dc6bf53023007df4ddfbd9b387f16090128f6c5bae200cb2624c3213c729b6a18071cfd507d4254df06e6a99df1c4f9a2b4572e01c
-  data.tar.gz: cdf1b08e6cce35ea27578edf31d19e66c0bcc3d5dbe796e966ec3dcdd0b80add053ba555703bbbe86767c311804a6cdd507e5fa6a69abc588691bde10474996e
+  metadata.gz: 4da0c49448f9113357e201117b3359ed19a50599a837fe4b1c1c03578169915df6e966c7258a0644c41815ceeeadcc3386e3810ba5258576c644279e88f30309
+  data.tar.gz: 7bfeeb554cf07e7b607e8f9b09f1641bd057a71bfa7b34db946fe95fc9ec3839ec559396c289b47ff7051743154716eb461000f791d8f9f259735d0d2ee2358d

data/README.md

@@ -118,6 +118,16 @@ Translates to
 ```
 Query parameters are passed into the `execute` method
 
+#### Pagination
+```ruby
+    projects.next_page?     # returns true or false
+    projects.prev_page?     # returns true or false
+    projects.next_page      # make API call to fetch next page
+    projects.prev_page      # make API call to fetch prev page
+    projects.first_page     # make API call to fetch first page
+    projects.last_page      # make API call to fetch last page
+```
+
 #### Complete API
 
 Refer to the complete [https://docs.gitlab.com/ce/api/](documentation) endpoints.
@@ -135,9 +145,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## TODO
-[] Script to automatically update API routes from Gitlab CE project
-[] Support sudo
-[] Support pagination
+
+- [] Script to automatically update API routes from Gitlab CE project
+- [] Support sudo
+- [/] Support pagination
+- [] Support more versions of Rubies (by dropping some gem dependencies)
+- [] Refactor and reduce coupling within classes
 
 ## License
 

data/lib/gitlab_ruby.rb

@@ -5,6 +5,7 @@ require 'gitlab_ruby/api_object'
 require 'gitlab_ruby/errors'
 require 'gitlab_ruby/api_errors'
 require 'gitlab_ruby/helpers/query_chain'
+require 'gitlab_ruby/paginated_response'
 require 'faraday'
 require 'json'
 require 'csv'

data/lib/gitlab_ruby/client.rb

@@ -39,7 +39,11 @@ module GitlabRuby
       puts response.inspect if self.class.debug
       result = parse_response(response)
       if result.is_a? Array
-        result.map { |item| APIObject.new(item) }
+        GitlabRuby::PaginatedResponse.new(
+          client: self,
+          array: result.map { |item| APIObject.new(item) },
+          headers: response.headers
+        )
       elsif result.is_a? Hash
         APIObject.new(result)
       end

data/lib/gitlab_ruby/paginated_response.rb

@@ -0,0 +1,99 @@
+require 'strscan'
+
+module GitlabRuby
+  class PaginatedResponse
+    def initialize(params = {})
+      @client = params[:client]
+      @array = params[:array]
+      @page_links = parse_page_links_from(params[:headers])
+    end
+
+    def next_page?
+      return nil unless @page_links['next']
+      true
+    end
+
+    def prev_page?
+      return nil unless @page_links['prev']
+      true
+    end
+
+    def next_page
+      return nil unless next_page?
+      fetch(@page_links['next'][:href])
+    end
+
+    def prev_page
+      return nil unless prev_page?
+      fetch(@page_links['prev'][:href])
+    end
+
+    def last_page
+      fetch(@page_links['last'][:href])
+    end
+
+    def first_page
+      fetch(@page_links['first'][:href])
+    end
+
+    ## Treat this like an Array (START)
+    #
+    def ==(other)
+      @array == other
+    end
+
+    def inspect
+      @array.inspect
+    end
+
+    def method_missing(name, *args, &block)
+      if @array.respond_to?(name)
+        @array.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @array.respond_to?(method_name, include_private)
+    end
+    #
+    ## Treat this like an Array (ENDS)
+
+    private
+
+    HREF   = / *< *([^>]*) *> *;? */                  #:nodoc: note: no attempt to check URI validity
+    TOKEN  = /([^()<>@,;:\"\[\]?={}\s]+)/             #:nodoc: non-empty sequence of non-separator characters
+    QUOTED = /"((?:[^"\\]|\\.)*)"/                    #:nodoc: double-quoted strings with backslash-escaped double quotes
+    ATTR   = /#{TOKEN} *= *(#{TOKEN}|#{QUOTED}) */    #:nodoc:
+    SEMI   = /; */                                    #:nodoc:
+    COMMA  = /, */                                    #:nodoc:
+
+    def fetch(href)
+      query_chain = GitlabRuby::QueryChain.new(client: @client, verb: :get)
+      query_chain.urlstring = href
+      query_chain.execute
+    end
+
+    def parse_page_links_from(headers)
+      # Example {"link"=>"<https://gitlab.com/api/v4/projects?archived=false&membership=false&order_by=created_at&owned=false&page=2&per_page=20&simple=false&sort=desc&starred=false>; rel=\"next\", <https://gitlab.com/api/v4/projects?archived=false&membership=false&order_by=created_at&owned=false&page=1&per_page=20&simple=false&sort=desc&starred=false>; rel=\"first\", <https://gitlab.com/api/v4/projects?archived=false&membership=false&order_by=created_at&owned=false&page=13086&per_page=20&simple=false&sort=desc&starred=false>; rel=\"last\"", "vary"=>"Origin", "x-next-page"=>"2", "x-page"=>"1", "x-per-page"=>"20", "x-prev-page"=>"", "x-request-id"=>"eb9bd5b4-5ca9-441b-ac8e-8a6bc99d1684", "x-runtime"=>"9.262252", "x-total"=>"261707", "x-total-pages"=>"13086", "strict-transport-security"=>"max-age=31536000"}
+      scanner = StringScanner.new(headers['link'])
+      links = {}
+      while scanner.scan(HREF)
+        href = scanner[1]
+        attrs = []
+        while scanner.scan(ATTR)
+          attr_name = scanner[1]
+          token = scanner[3]
+          quoted = scanner[4]
+          attrs.push([attr_name, token || quoted.gsub(/\\"/, '"')])
+          puts attrs
+          break unless scanner.scan(SEMI)
+        end
+        links[attrs[0].last] = { href: href, attrs: attrs }
+        break unless scanner.scan(COMMA)
+      end
+      links
+    end
+  end
+end

data/lib/gitlab_ruby/version.rb

@@ -1,3 +1,3 @@
 module GitlabRuby
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - TM Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,6 +146,7 @@ files:
 - lib/gitlab_ruby/client.rb
 - lib/gitlab_ruby/errors.rb
 - lib/gitlab_ruby/helpers/query_chain.rb
+- lib/gitlab_ruby/paginated_response.rb
 - lib/gitlab_ruby/query_chain.rb
 - lib/gitlab_ruby/routes_table_no_verb.csv
 - lib/gitlab_ruby/version.rb