tableau_server_client 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ece5e128410a403cebb77343a1efecfcaa11af7943e63e0f5cd4742a7b86e8
-  data.tar.gz: 26692e9b42d023e71498afaa938daf96886af823eb24100bb48a790e34369830
+  metadata.gz: 78810d795bb6f32ec40ba5ad9236263bcd10bf2ef112af789ba1815b106fde11
+  data.tar.gz: a35aa637bb4cacf18f12755d3e5561ee57b8dbf0ce3b736f86da94535c9a4730
 SHA512:
-  metadata.gz: 15ce18273d3ef76cb0db3978ad7c246520e22e114c53a72f7d08d9502d6422217fd52ddafc2649d2503c4a1184e731f620505a58e6e4575d98643691b3276ea0
-  data.tar.gz: 0ea42f4fe5dfcaac59a08e7ceb5b24e5ae4f9959f588d4b05b7cca0b52eab52dda5ebc7b0329d9d9f2f434990fad3b5e7604e4097a7b95673c0759eb5ddd3562
+  metadata.gz: 0affb6c80c2ec2af64d9a49e72e5d63d7711444a7983165cc59e2ea4cea8ba72efdc1e3bc2ef7473481741e678806db0e7e8090049586aa6958e813584742e38
+  data.tar.gz: 9fd19bb7a5df41908737b511c298a396c955efcd724f650b449b12322e49238d58d8f450f56a3a07a6ef35a9845b52eeb792f19252c6219ffc53afc94236a7a0

data/lib/tableau_server_client/client.rb

@@ -14,7 +14,7 @@ module TableauServerClient
   class Client
     include RequestBuilder
 
-    def initialize(server_url, username, password, site_name, api_version, token_lifetime, logger)
+    def initialize(server_url, username, password, site_name, api_version, token_lifetime, logger, impersonation_user_id)
       @server_url = server_url
       @username = username
       @password = password
@@ -22,9 +22,10 @@ module TableauServerClient
       @api_version = api_version
       @token_lifetime = token_lifetime
       @logger = logger
+      @impersonation_user_id = impersonation_user_id
     end
 
-    attr_reader :site_name, :username, :api_version, :token_lifetime, :logger
+    attr_reader :site_name, :username, :api_version, :token_lifetime, :logger, :impersonation_user_id
 
     def server_url
       @_server_url ||= URI(@server_url.chomp("/"))
@@ -65,6 +66,15 @@ module TableauServerClient
       return response
     end
 
+    def download_image(resource_location, file_path: nil)
+      req_url = request_url("#{resource_location.path}/image", resource_location.query_params)
+      response = session.get req_url.to_s
+      if file_path
+        File.write(file_path, response.body)
+      end
+      return response
+    end
+
     def update(resource)
       session.put do |req|
         req.url request_url(resource.path).to_s
@@ -104,6 +114,7 @@ module TableauServerClient
       request = request_body {|b|
         b.credentials(name: username, password: password) {
           b.site(contentUrl: content_url)
+          b.user(id: impersonation_user_id) if impersonation_user_id
         }
       }
       # POST without Token

data/lib/tableau_server_client/exception.rb

@@ -0,0 +1,5 @@
+module TableauServerClient
+
+  class TableauServerClientError < StandardError; end
+
+end

data/lib/tableau_server_client/resources/site.rb

@@ -4,6 +4,7 @@ require 'tableau_server_client/resources/workbook'
 require 'tableau_server_client/resources/user'
 require 'tableau_server_client/resources/subscription'
 require 'tableau_server_client/resources/extract_refresh'
+require 'tableau_server_client/resources/view'
 
 module TableauServerClient
   module Resources
@@ -40,6 +41,10 @@ module TableauServerClient
         @client.get Workbook.location(path, id)
       end
 
+      def views(filter: [])
+        @client.get_collection View.location(path, filter: filter)
+      end
+
       def users(filter: [])
         @client.get_collection User.location(path, filter: filter)
       end

data/lib/tableau_server_client/resources/view.rb

@@ -0,0 +1,42 @@
+require 'tableau_server_client/resources/resource'
+require 'tableau_server_client/resources/workbook'
+
+module TableauServerClient
+  module Resources
+
+    class View < Resource
+
+      attr_reader :id, :name, :content_url, :workbook_id
+      attr_writer :owner
+
+      def self.from_response(client, path, xml)
+        attrs = extract_attributes(xml)
+        attrs['workbook_id'] = xml.xpath("xmlns:workbook")[0]['id']
+        new(client, path, attrs)
+      end
+
+      def self.from_collection_response(client, path, xml)
+        xml.xpath("//xmlns:views/xmlns:view").each do |s|
+          id = s['id']
+          yield from_response(client, "#{path}/#{id}", s)
+        end
+      end
+
+      def workbook
+        client.get Workbook.location(site_path, workbook_id)
+      end
+
+      def webpage_url
+        webpage_path = content_url.gsub('/sheets/', '/')
+        "#{server_url}#{content}/#/views/#{webpage_path}"
+      end
+
+      def image(query_params: {}, file_path: nil)
+        return @image if @iamge
+        @image = client.download_image(location(query_params: query_params), file_path: file_path)
+        @image
+      end
+
+    end
+  end
+end

data/lib/tableau_server_client/server.rb

@@ -1,6 +1,7 @@
 require 'tableau_server_client/client'
 require 'tableau_server_client/resources/site'
 require 'tableau_server_client/resources/schedule'
+require 'tableau_server_client/exception'
 require 'logger'
 
 module TableauServerClient
@@ -8,12 +9,20 @@ module TableauServerClient
 
     def initialize(server_url, username, password,
                    site_name: "default", api_version: "3.1", token_lifetime: 240,
-                   log_level: :info)
+                   log_level: :info, impersonation_username: nil)
+      @server_url = server_url
+      @username = username
+      @password = password
+      @site_name = site_name
+      @api_version = api_version
+      @token_lifetime = token_lifetime
       @logger = ::Logger.new(STDOUT)
       @logger.level = ::Logger.const_get(log_level.upcase.to_sym)
-      @client = Client.new(server_url, username, password, site_name, api_version, token_lifetime, @logger)
+      @impersonation_username = impersonation_username
     end
 
+    attr_reader :server_url, :username, :site_name, :api_version, :token_lifetime, :logger, :impersonation_username
+
     def sites
       client.get_collection Resources::Site.location(path)
     end
@@ -30,9 +39,28 @@ module TableauServerClient
       nil
     end
 
+    def client
+      @client ||= Client.new(server_url, username, password, site_name, api_version, token_lifetime, @logger, user_id(impersonation_username))
+    end
+
     private
 
-    attr_reader :client
+    attr_reader :password
+
+    def user_id(username)
+      return nil unless username
+      admin_client.get_collection(Resources::Site.location(path)).each do |site|
+        user = site.users(filter: ["name:eq:#{username}"]).first
+        if user
+          return user.id
+        end
+      end
+      raise TableauServerClientError.new("User '#{username}' not found.")
+    end
+
+    def admin_client
+      @admin_client ||= Client.new(server_url, username, password, site_name, api_version, token_lifetime, @logger, nil)
+    end
 
   end
 end

data/lib/tableau_server_client/version.rb

@@ -1,3 +1,3 @@
 module TableauServerClient
-  VERSION = "0.0.19"
+  VERSION = "0.0.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tableau_server_client
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - shimpeko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,7 @@ files:
 - bin/console
 - lib/tableau_server_client.rb
 - lib/tableau_server_client/client.rb
+- lib/tableau_server_client/exception.rb
 - lib/tableau_server_client/paginatable_response.rb
 - lib/tableau_server_client/request_builder.rb
 - lib/tableau_server_client/request_url.rb
@@ -151,6 +152,7 @@ files:
 - lib/tableau_server_client/resources/site.rb
 - lib/tableau_server_client/resources/subscription.rb
 - lib/tableau_server_client/resources/user.rb
+- lib/tableau_server_client/resources/view.rb
 - lib/tableau_server_client/resources/workbook.rb
 - lib/tableau_server_client/server.rb
 - lib/tableau_server_client/token.rb