tableau_api 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79d15e26e8441669e7c04c13794a049dc968d69e
-  data.tar.gz: 05e49453e17574474a356d20cb21fc0ce094e6e0
+  metadata.gz: f4798e618f0d34f889de213df1639f637bd10725
+  data.tar.gz: 101be1cca96ab9cb21fd6061f557ea2d718ac8a7
 SHA512:
-  metadata.gz: 8e69aba0b041e655e0e93b1fc0de62f069c966148675b755365bac2572a01dd78fbc322ce1020e1e588bef1600a554e77b8e54089c5936390573d3bb0137d018
-  data.tar.gz: ca5ebe0289ac4af7c5ccf6c0e1945ce61f01d693b31f027cf1ed8baafcfbf7e980042afb09167c48befbf074a1a46e1d003367d1565fc30ede71cee7f2884957
+  metadata.gz: 2ebb0f01b35a52a1270cd50dc21dc883d801acfe82dfaa4d0284ab3c47cef1fc61a0c024d02abc9720ac3114852355e105ba711d7b8ff4a926950b5dda7f0bd6
+  data.tar.gz: 75afe1a966db2064aa0a89c2f0e321e43a701288bba57a1dd8f22f031db2be5e2a699e2a74ad988196517923bbf63f91d71737ff88b61282c7cc2dda54b1f6fa

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.2
 
@@ -18,3 +20,8 @@ Metrics/AbcSize:
 
 MethodLength:
   Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - ./tableau_api.gemspec
+    - ./spec/resources/workbooks_spec.rb

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-08-21 17:54:45 +0000 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 13
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 316

data/.travis.yml

@@ -4,7 +4,6 @@ branches:
     - master
 language: ruby
 rvm:
+  - 2.6.3
+  - 2.5.5
   - 2.4.1
-  - 2.3.4
-  - 2.2.7
-  - 2.1.10

data/CHANGELOG.md

@@ -3,7 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [2.0.0] - 2019-08-29
+
+- Updated to API version 2.8, compatible with Tableau Server >= 10.5
+- Add `refresh` and `image_preview` methods for workbooks
+- Bumped the Ruby versions in the Travis matrix build to 2.3.4, 2.2.7, and
 
 ## [1.1.2] - 2017-05-24
 

data/Rakefile

@@ -6,4 +6,4 @@ RuboCop::RakeTask.new(:rubocop)
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/lib/tableau_api/client.rb

@@ -28,7 +28,8 @@ module TableauApi
         sites: TableauApi::Resources::Sites,
         users: TableauApi::Resources::Users,
         groups: TableauApi::Resources::Groups,
-        workbooks: TableauApi::Resources::Workbooks
+        workbooks: TableauApi::Resources::Workbooks,
+        datasources: TableauApi::Resources::Datasources
       }
     end
 

data/lib/tableau_api/connection.rb

@@ -1,6 +1,6 @@
 module TableauApi
   class Connection
-    API_VERSION = '2.0'.freeze
+    API_VERSION = '2.8'.freeze
 
     include HTTParty
 
@@ -45,10 +45,14 @@ module TableauApi
     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)
     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)
     end
 
@@ -75,7 +79,8 @@ module TableauApi
       # 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] = auth_headers
+        args[0][:headers] = {} unless args[0][:headers]
+        args[0][:headers].merge!(auth_headers)
       end
       self.class.send(method, url_for(path), *args)
     end

data/lib/tableau_api/resources/datasources.rb

@@ -0,0 +1,10 @@
+module TableauApi
+  module Resources
+    class Datasources < Base
+      def list
+        url = "sites/#{@client.auth.site_id}/datasources"
+        @client.connection.api_get_collection(url, 'datasources.datasource')
+      end
+    end
+  end
+end

data/lib/tableau_api/resources/users.rb

@@ -1,7 +1,7 @@
 module TableauApi
   module Resources
     class Users < Base
-      SITE_ROLES = %w(
+      SITE_ROLES = %w[
         Interactor
         Publisher
         SiteAdministrator
@@ -9,7 +9,7 @@ module TableauApi
         UnlicensedWithPublish
         Viewer
         ViewerWithPublish
-      ).freeze
+      ].freeze
 
       def create(username:, site_role: 'Viewer')
         raise 'invalid site_role' unless SITE_ROLES.include? site_role

data/lib/tableau_api/resources/workbooks.rb

@@ -48,12 +48,12 @@ module TableauApi
       end
       # rubocop:enable Metrics/ParameterLists
 
-      CAPABILITIES = %w(
+      CAPABILITIES = %w[
         AddComment ChangeHierarchy ChangePermissions Delete ExportData ExportImage ExportXml
         Filter Read ShareView ViewComments ViewUnderlyingData WebAuthoring Write
-      ).freeze
+      ].freeze
 
-      CAPABILITY_MODES = %w(ALLOW DENY).freeze
+      CAPABILITY_MODES = %w[ALLOW DENY].freeze
 
       def permissions(workbook_id:)
         res = @client.connection.api_get("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/permissions")
@@ -98,7 +98,7 @@ module TableauApi
         raise 'invalid mode' unless CAPABILITY_MODES.include? capability_mode.to_s
 
         subpath = user_id ? "users/#{user_id}" : "groups/#{group_id}"
-        subpath += "/#{capability}/#{capability_mode}"
+        subpath += "/#{capability}/#{capability_mode.capitalize}"
         res = @client.connection.api_delete("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/permissions/#{subpath}")
 
         res.code == 204
@@ -116,6 +116,17 @@ module TableauApi
         res.code == 200
       end
 
+      def refresh(workbook_id:)
+        request = Builder::XmlMarkup.new.tsRequest
+        res = @client.connection.api_post("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/refresh", body: request)
+        res.code == 202
+      end
+
+      def preview_image(workbook_id:)
+        res = @client.connection.api_get("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/previewImage")
+        res.body if res.code == 200
+      end
+
       def find(workbook_id)
         res = @client.connection.api_get("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}")
         res['tsResponse']['workbook'] if res.code == 200

data/lib/tableau_api/version.rb

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

data/lib/tableau_api.rb

@@ -12,6 +12,7 @@ require 'tableau_api/resources/sites'
 require 'tableau_api/resources/users'
 require 'tableau_api/resources/groups'
 require 'tableau_api/resources/workbooks'
+require 'tableau_api/resources/datasources'
 require 'tableau_api/version'
 
 module TableauApi

data/tableau_api.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tableau_api/version'
@@ -10,7 +11,7 @@ Gem::Specification.new do |spec|
                         'Jonathan Cobian']
   spec.email         = ['opensource@civisanalytics.com']
 
-  spec.summary       = 'Ruby interface to the Tableau 9.0 API.'
+  spec.summary       = 'Ruby interface to the Tableau API.'
   spec.homepage      = 'https://github.com/civisanalytics/tableau_api'
   spec.license       = 'BSD-3-Clause'
 
@@ -32,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.46.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+  spec.add_development_dependency 'chunky_png', '~> 1.3.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tableau_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Christopher Manning
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -172,14 +172,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
 description: 
 email:
 - opensource@civisanalytics.com
@@ -190,6 +204,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -206,6 +221,7 @@ files:
 - lib/tableau_api/error.rb
 - lib/tableau_api/resources/auth.rb
 - lib/tableau_api/resources/base.rb
+- lib/tableau_api/resources/datasources.rb
 - lib/tableau_api/resources/groups.rb
 - lib/tableau_api/resources/projects.rb
 - lib/tableau_api/resources/sites.rb
@@ -233,8 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
-summary: Ruby interface to the Tableau 9.0 API.
+summary: Ruby interface to the Tableau API.
 test_files: []