tableau_api 2.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4798e618f0d34f889de213df1639f637bd10725
-  data.tar.gz: 101be1cca96ab9cb21fd6061f557ea2d718ac8a7
+  metadata.gz: a147139944855ed7147760ceae5d65bcd5f6fb1c
+  data.tar.gz: ea08dc0b70183fc30620959fa255e041e6c318ea
 SHA512:
-  metadata.gz: 2ebb0f01b35a52a1270cd50dc21dc883d801acfe82dfaa4d0284ab3c47cef1fc61a0c024d02abc9720ac3114852355e105ba711d7b8ff4a926950b5dda7f0bd6
-  data.tar.gz: 75afe1a966db2064aa0a89c2f0e321e43a701288bba57a1dd8f22f031db2be5e2a699e2a74ad988196517923bbf63f91d71737ff88b61282c7cc2dda54b1f6fa
+  metadata.gz: b60cbc7aec82d7a36868faadbe38f775786a67b84c809c2803e384424c877d6c22116b1da652d0634f57d731b0d99a2b3e69123d746499390e7e2a2c34d71a63
+  data.tar.gz: f36628abb279e8ca26aee9747a9fafb0ab29e41268b6787e2da9a90d2d4a116d3f18fd7d7ca6557481340a72aaf6a6306cb95f5ce6caf83a4ab274b2df17b994

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+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,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## upcoming
+
+### Changed
+
+## [4.1.0] - 2022-04-13
+
+- Specify major version number of ruby in Docker testing command in README
+- Add support for CreateRefreshMetrics and RunExplainData workbook capabilities
+
+## [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
+
+- Added Jobs resource
+
+
+### Changed
+
+- Updated to API version 3.1
+  - This is a breaking change for site roles:
+    https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_new_site_roles.htm
+- Include full error detail in TableauError message
+
+
 ## [2.0.0] - 2019-08-29
 
 - Updated to API version 2.8, compatible with Tableau Server >= 10.5

data/README.md

@@ -54,7 +54,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ### Docker
 
 ```
-docker run -it -d -v $(pwd):/src ruby /bin/bash
+docker run -it -d -v $(pwd):/src ruby:2 /bin/bash
 docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
 ```
 
@@ -62,16 +62,31 @@ docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
 
 Cassettes should be self-contained, generated by a single spec file
 run in defined order. To make changes to specs, it's best to delete a whole cassette
-and rerun the whole spec file.
+and rerun the whole spec file, except for auth.yml, since it could be difficult to
+generate a trusted ticket from a non-trusted host.
 
-Set the environment variables below to an administrator account, create a tunnel
-to your tableau server on port 2000, then run the commands below.
+To regenerate all the the cassettes, you'll first need to create the following on the Tableau server:
+* *Site*: Default
+* *Site*: TestSite
+ * *Datasource*: test (this might need to be created from Tableau Desktop)
+ * *Username*: test_test
+
+And delete the following if they exist:
+* *Group*: testgroup (probably under TestSite)
+* *Project*: test_project (probably under Default)
+* *Site*: Test Site 2
+* *User*: test (probably under TestSite)
+* *Workbook*: test
+* *Workbook*: testpublish
+
+Set the environment variables below to an administrator account and your Tableau Server hostname.
+
+Then run the commands below:
 
 ```
 docker run -it -d \
   -v $(pwd):/src \
-  --add-host=docker:$(ifconfig en0 | grep 'inet\b' | cut -d ' ' -f 2) \
-  -e TABLEAU_HOST='http://docker:2000' -e TABLEAU_ADMIN_USERNAME -e TABLEAU_ADMIN_PASSWORD \
+  -e TABLEAU_HOST -e TABLEAU_ADMIN_USERNAME -e TABLEAU_ADMIN_PASSWORD \
   ruby /bin/bash
 docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
 ```

data/lib/tableau_api/client.rb

@@ -29,7 +29,8 @@ module TableauApi
         users: TableauApi::Resources::Users,
         groups: TableauApi::Resources::Groups,
         workbooks: TableauApi::Resources::Workbooks,
-        datasources: TableauApi::Resources::Datasources
+        datasources: TableauApi::Resources::Datasources,
+        jobs: TableauApi::Resources::Jobs
       }
     end
 

data/lib/tableau_api/connection.rb

@@ -1,30 +1,30 @@
 module TableauApi
   class Connection
-    API_VERSION = '2.8'.freeze
+    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(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/error.rb

@@ -8,7 +8,7 @@ module TableauApi
       @error_code = error['code']
       @summary = error['summary']
       @detail = error['detail']
-      super(summary)
+      super("#{error_code}: #{summary}; #{detail}")
     end
   end
 end

data/lib/tableau_api/resources/jobs.rb

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

data/lib/tableau_api/resources/users.rb

@@ -2,13 +2,14 @@ module TableauApi
   module Resources
     class Users < Base
       SITE_ROLES = %w[
-        Interactor
-        Publisher
-        SiteAdministrator
+        Creator
+        Explorer
+        ExplorerCanPublish
+        SiteAdministratorCreator
+        SiteAdministratorExplorer
+        ServerAdministrator
         Unlicensed
-        UnlicensedWithPublish
         Viewer
-        ViewerWithPublish
       ].freeze
 
       def create(username:, site_role: 'Viewer')

data/lib/tableau_api/resources/workbooks.rb

@@ -49,8 +49,8 @@ module TableauApi
       # rubocop:enable Metrics/ParameterLists
 
       CAPABILITIES = %w[
-        AddComment ChangeHierarchy ChangePermissions Delete ExportData ExportImage ExportXml
-        Filter Read ShareView ViewComments ViewUnderlyingData WebAuthoring Write
+        AddComment ChangeHierarchy ChangePermissions CreateRefreshMetrics Delete ExportData ExportImage
+        ExportXml Filter Read RunExplainData ShareView ViewComments ViewUnderlyingData WebAuthoring Write
       ].freeze
 
       CAPABILITY_MODES = %w[ALLOW DENY].freeze

data/lib/tableau_api/version.rb

@@ -1,3 +1,3 @@
 module TableauApi
-  VERSION = '2.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

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'
@@ -13,7 +15,7 @@ require 'tableau_api/resources/users'
 require 'tableau_api/resources/groups'
 require 'tableau_api/resources/workbooks'
 require 'tableau_api/resources/datasources'
-require 'tableau_api/version'
+require 'tableau_api/resources/jobs'
 
 module TableauApi
   class << self

data/tableau_api.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'multipart-post', '~> 2.0'
   spec.add_dependency 'rubyzip', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 11.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'vcr', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tableau_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Christopher Manning
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -68,20 +68,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +209,7 @@ files:
 - lib/tableau_api/resources/base.rb
 - lib/tableau_api/resources/datasources.rb
 - lib/tableau_api/resources/groups.rb
+- lib/tableau_api/resources/jobs.rb
 - lib/tableau_api/resources/projects.rb
 - lib/tableau_api/resources/sites.rb
 - lib/tableau_api/resources/users.rb
@@ -249,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the Tableau API.