tableau_api 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4798e618f0d34f889de213df1639f637bd10725
-  data.tar.gz: 101be1cca96ab9cb21fd6061f557ea2d718ac8a7
+  metadata.gz: 32337332fcbfbd3e1df178024ad0eb90c64ba347
+  data.tar.gz: 1acad5975fe2d1e33637e0d7092415697d0db997
 SHA512:
-  metadata.gz: 2ebb0f01b35a52a1270cd50dc21dc883d801acfe82dfaa4d0284ab3c47cef1fc61a0c024d02abc9720ac3114852355e105ba711d7b8ff4a926950b5dda7f0bd6
-  data.tar.gz: 75afe1a966db2064aa0a89c2f0e321e43a701288bba57a1dd8f22f031db2be5e2a699e2a74ad988196517923bbf63f91d71737ff88b61282c7cc2dda54b1f6fa
+  metadata.gz: a2685533571a39906bc593726395b3555123b7ceee2e2921ed3d614938873d9b03777e7b20f215180999e2e2af25064004b575ed5793bb2dd53710bf31a5062c
+  data.tar.gz: 91f5141706ffff117ec5fd6c4643b00066d17a19e69c2f895256b6c4f33fd7dc6e2f4c8e7c22d672f185ec60af27ed0ccd720767060f3d1c6020cf7fc4e3b50f

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.4.9

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] -
+
+### 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

@@ -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
+ * *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.rb

@@ -13,6 +13,7 @@ require 'tableau_api/resources/users'
 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

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,6 +1,6 @@
 module TableauApi
   class Connection
-    API_VERSION = '2.8'.freeze
+    API_VERSION = '3.1'.freeze
 
     include HTTParty
 
@@ -22,7 +22,7 @@ module TableauApi
         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
+          uri = URI::HTTP.build(path: "/#{path}", query: URI.encode_www_form(**args[0], pageSize: page_size, pageNumber: page_number)).request_uri
 
           res = api_get(uri, *args)
           raise TableauError, res if res.code.to_s != '200'

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(kwargs = {})
+        url = "sites/#{@client.auth.site_id}/jobs"
+        @client.connection.api_get_collection(url, 'backgroundJobs.backgroundJob', **kwargs)
+      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/version.rb

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

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: 3.0.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: 2020-11-11 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.