tableau_api 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32337332fcbfbd3e1df178024ad0eb90c64ba347
-  data.tar.gz: 1acad5975fe2d1e33637e0d7092415697d0db997
+  metadata.gz: ab171fa9db1acc1d2baa0134e86df90f9fabae6c
+  data.tar.gz: 7ade53d8f0ed080241ddc2f37810a0e29193773c
 SHA512:
-  metadata.gz: a2685533571a39906bc593726395b3555123b7ceee2e2921ed3d614938873d9b03777e7b20f215180999e2e2af25064004b575ed5793bb2dd53710bf31a5062c
-  data.tar.gz: 91f5141706ffff117ec5fd6c4643b00066d17a19e69c2f895256b6c4f33fd7dc6e2f4c8e7c22d672f185ec60af27ed0ccd720767060f3d1c6020cf7fc4e3b50f
+  metadata.gz: a15d7705a00c982b44d3b3ceb47eae9231440a77acb8af470df74dcb95baa28f1375c8479bce2eb778d4f83c99003230180b345cfdc30f74326f54ecb3955006
+  data.tar.gz: 4523b88ddaf739fa6064b428a2c555ea533bb93d6d65e70280182d362144a0b05da0c87a42294170574c12b045edca33a2e9fae2e0db13abf7ae74062b9b5f09

data/.ruby-version

@@ -1 +1 @@
-2.4.9
+2.4.10

data/.travis.yml

@@ -4,6 +4,6 @@ branches:
     - master
 language: ruby
 rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.1
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10

data/CHANGELOG.md

@@ -3,7 +3,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [3.0.0] -
+## [4.0.0] - 2020-11-30
+
+### Changed/Fixed
+
+- Changed interface to Connection#api_get_collection to properly merge a string
+  query with the pagination parameters instead of overwriting the pagination
+  params. This means you can't pass a Hash `query` parameter to `Jobs#list`
+  anymore, but job filtering now works properly because colons in the filter
+  will not be URL-encoded.
+- Avoid mutating extra argument hash to endpoint methods
+
+
+## [3.0.0] - 2020-11-11
 
 ### Added
 

data/README.md

@@ -68,7 +68,7 @@ generate a trusted ticket from a non-trusted host.
 To regenerate all the the cassettes, you'll first need to create the following on the Tableau server:
 * *Site*: Default
 * *Site*: TestSite
- * *Datasource*: test
+ * *Datasource*: test (this might need to be created from Tableau Desktop)
  * *Username*: test_test
 
 And delete the following if they exist:

data/lib/tableau_api.rb

@@ -2,6 +2,8 @@ require 'httparty'
 require 'builder'
 require 'net/http/post/multipart'
 
+require 'tableau_api/version'
+
 require 'tableau_api/client'
 require 'tableau_api/connection'
 require 'tableau_api/error'
@@ -14,7 +16,6 @@ require 'tableau_api/resources/groups'
 require 'tableau_api/resources/workbooks'
 require 'tableau_api/resources/datasources'
 require 'tableau_api/resources/jobs'
-require 'tableau_api/version'
 
 module TableauApi
   class << self

data/lib/tableau_api/connection.rb

@@ -3,28 +3,28 @@ module TableauApi
     API_VERSION = '3.1'.freeze
 
     include HTTParty
+    headers 'User-Agent' => "tableau_api/#{::TableauApi::VERSION} Ruby/#{RUBY_VERSION}"
 
     def initialize(client)
       @client = client
     end
 
-    def post(path, *args)
-      self.class.post("#{@client.host}/#{path}", *args)
+    def post(path, **kwargs)
+      self.class.post("#{@client.host}/#{path}", kwargs)
     end
 
     # if the result is paginated, it will fetch subsequent pages
     # collection can be delimited with a period to do nested hash lookups
     # e.g. objects.object
-    def api_get_collection(path, collection, *args)
+    def api_get_collection(path, collection, page_number: 1, page_size: 100, **kwargs)
       Enumerator.new do |enum|
-        args[0] = {} unless args[0]
-        page_size = (args[0].delete(:page_size) { 100 }).to_i
-        page_number = (args[0].delete(:page_number) { 1 }).to_i
-
         loop do
-          uri = URI::HTTP.build(path: "/#{path}", query: URI.encode_www_form(**args[0], pageSize: page_size, pageNumber: page_number)).request_uri
+          query = kwargs.fetch(:query, '')
+          query += '&' unless query.empty?
+          query += "pageSize=#{page_size}&pageNumber=#{page_number}"
+          new_kwargs = kwargs.merge(query: query)
 
-          res = api_get(uri, *args)
+          res = api_get(path, **new_kwargs)
           raise TableauError, res if res.code.to_s != '200'
 
           # ensure the result is an array because it will not be an array if there is only one element
@@ -40,24 +40,22 @@ module TableauApi
       end
     end
 
-    def api_get(path, *args)
-      api_method(:get, path, *args)
+    def api_get(path, **kwargs)
+      api_method(:get, path, kwargs)
     end
 
-    def api_post(path, *args)
-      args[0][:headers] = {} unless args[0][:headers]
-      args[0][:headers]['Content-Type'] = 'application/xml'
-      api_method(:post, path, *args)
+    def api_post(path, **kwargs)
+      new_headers = kwargs.fetch(:headers, {}).merge('Content-Type' => 'application/xml')
+      api_method(:post, path, kwargs.merge(headers: new_headers))
     end
 
-    def api_put(path, *args)
-      args[0][:headers] = {} unless args[0][:headers]
-      args[0][:headers]['Content-Type'] = 'application/xml'
-      api_method(:put, path, *args)
+    def api_put(path, **kwargs)
+      new_headers = kwargs.fetch(:headers, {}).merge('Content-Type' => 'application/xml')
+      api_method(:put, path, kwargs.merge(headers: new_headers))
     end
 
-    def api_delete(path, *args)
-      api_method(:delete, path, *args)
+    def api_delete(path, **kwargs)
+      api_method(:delete, path, kwargs)
     end
 
     def api_post_multipart(path, parts, headers)
@@ -75,14 +73,12 @@ module TableauApi
 
     private
 
-    def api_method(method, path, *args)
+    def api_method(method, path, kwargs)
       # do not attach auth headers or attempt to signin if we're signing in
       unless path == 'auth/signin'
-        args[0] = {} unless args[0]
-        args[0][:headers] = {} unless args[0][:headers]
-        args[0][:headers].merge!(auth_headers)
+        new_headers = auth_headers(kwargs.fetch(:headers, {}))
       end
-      self.class.send(method, url_for(path), *args)
+      self.class.public_send(method, url_for(path), kwargs.merge(headers: new_headers))
     end
 
     def url_for(path)

data/lib/tableau_api/resources/jobs.rb

@@ -1,9 +1,9 @@
 module TableauApi
   module Resources
     class Jobs < Base
-      def list(kwargs = {})
+      def list(params = {})
         url = "sites/#{@client.auth.site_id}/jobs"
-        @client.connection.api_get_collection(url, 'backgroundJobs.backgroundJob', **kwargs)
+        @client.connection.api_get_collection(url, 'backgroundJobs.backgroundJob', **params)
       end
     end
   end

data/lib/tableau_api/version.rb

@@ -1,3 +1,3 @@
 module TableauApi
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tableau_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Christopher Manning
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty