tableau_rest_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8890790a4a3afb041589eabfbb6519624af16ae1
-  data.tar.gz: 81f3bc4ac96e1c26049d2b2ca7bf07cd7dec4056
+  metadata.gz: b09a487d6e675e8c269d57e3034fa3d8889fb6c7
+  data.tar.gz: e9b1d15ecf421e2af1615370d5b9dcdb2e6e6bff
 SHA512:
-  metadata.gz: 312646153259d40c71fa7230de20fe41507a423c596feb9e54ea9c7b2533c4881f59f4c033529c4595d91df69209faeb8619c8bc19da05d9063f5ef48ec1cea4
-  data.tar.gz: acb36633edb38836e04ace51a13b6f9796124bb0179dc431f8a151aa938707fbc8d3046866536698b69289f6aff2b67cfef1aee131e03cb163f95d9ae7efde2f
+  metadata.gz: ff6cbe3ebf6bda4ea65619b0c3946549029fdcafe0528b471a533a47951e8591a1239e8fe8683d2b5188b0805df1695b001ee76537dc46ef6c39a6bc99c49ff6
+  data.tar.gz: bf7b55e5c93883561ff88514127cde5b0749fed5d3cf1b393526dba77db88bc2a042ff3fd017cfba099def4d6213dfeaa5b525b39f7b86730647205344f6a8fe

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.reek
+.travis.yml
+/*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/lib/tableau_rest_api/client.rb

@@ -4,6 +4,8 @@ module TableauRestApi
   # See the Request sub-class for resource requests.
   class Client
     attr_reader :config, :token
+
+    include TableauRestApi::Pagination
     
     def initialize
       @config = Config.new.options
@@ -39,9 +41,10 @@ module TableauRestApi
       head = boundary ? head.merge({ :content_type => "multipart/mixed; boundary=#{boundary}"}) : head
     end
 
-    def build_url(endpoint)
+    def build_url(endpoint, page=nil)
       endpoint = endpoint.is_a?(Array) ? endpoint.join('/') : endpoint
-      "#{@config[:host]}/#{@config[:base]}/#{@config[:api_version]}/#{endpoint}"
+      url = "#{@config[:host]}/#{@config[:base]}/#{@config[:api_version]}/#{endpoint}"
+      url = page ? url + "?pageNumber=#{page}" : url
     end
 
     def get(url)
@@ -60,6 +63,6 @@ module TableauRestApi
     
     def delete(url)
       Response.new(RestClient.delete(url, header)).parse
-    end 
-  end
+    end
+ end
 end

data/lib/tableau_rest_api/resource.rb

@@ -19,8 +19,9 @@ module TableauRestApi
     end
 
     def sites
-      url = build_url 'sites'
-      (get url).sites.site.to_a.map { |site| Site.new(site, self) }
+      resp = get build_url('sites')
+      sites = extract_sites(resp)
+      sites = retrieve_additional_pages(resp, sites, 'sites', :extract_sites) 
     end
  
     def create_site(site)
@@ -38,5 +39,11 @@ module TableauRestApi
       delete url
       @token = nil
     end
+
+    private
+
+    def extract_sites(response)
+      response.sites.site.to_a.map { |site| Site.new(site, self) }
+    end
  end
 end

data/lib/tableau_rest_api/util/pagination.rb

@@ -0,0 +1,40 @@
+module TableauRestApi
+  module Pagination
+    def complete?(response)
+      pagination = response.pagination
+      pagination ? paginate(pagination) : true
+    end
+
+    def paginate(pagination)
+      read_pagination_header(pagination)
+      return has_multiple_pages? if first_page
+      @total % ((@page) * @per_page) == @total
+    end
+
+    def first_page
+      @page == 0
+    end
+
+    def has_multiple_pages?
+      @total > @per_page ? false : true
+    end
+
+    def read_pagination_header(pagination)
+      @page = pagination.pageNumber.to_i
+      @per_page = pagination.pageSize.to_i
+      @total = pagination.totalAvailable.to_i
+    end
+    
+    def next_page
+      @page + 1
+    end
+ 
+    def retrieve_additional_pages(response, collection, entity, extract)
+      until complete?(response) do
+        response = (get build_url(entity, next_page))
+        collection = collection + self.send(extract, response)
+      end
+      collection
+    end
+  end
+end

data/lib/tableau_rest_api/version.rb

@@ -1,3 +1,3 @@
 module TableauRestApi
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/tableau_rest_api.rb

@@ -5,6 +5,7 @@ require 'timerizer'
 require 'securerandom'
 
 require 'tableau_rest_api/version'
+require 'tableau_rest_api/util/pagination'
 require 'tableau_rest_api/client'
 require 'tableau_rest_api/area/user_group'
 require 'tableau_rest_api/area/workbook_datasource'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tableau_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dave Lancaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -190,6 +192,7 @@ files:
 - lib/tableau_rest_api/resources/user.rb
 - lib/tableau_rest_api/resources/workbook.rb
 - lib/tableau_rest_api/util/config.rb
+- lib/tableau_rest_api/util/pagination.rb
 - lib/tableau_rest_api/util/response.rb
 - lib/tableau_rest_api/util/token.rb
 - lib/tableau_rest_api/util/upload.rb
@@ -215,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby library wrapping the Tableau REST API.