tableau_server_client 0.0.17 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 002d3eb5a6e6a504c3eba7abf7910f161d5ae5ddbd1253978444a251117084bd
-  data.tar.gz: a50e3f36b5538a27d7c3026d8947ed55b032b89129919e55224f76e8d977ad4e
+  metadata.gz: b1558ccb1a6e4e24c51290e44d1731769cbd4097ba15f7234b109182ad9104e8
+  data.tar.gz: 7d64b81492f87d2f180cf7ca0e744dda911af13b9aa3e7646a7f8ccbf9c51b2a
 SHA512:
-  metadata.gz: 7d1a387be9b4e864c3eb01dde59d7b589240e2eccfab1debe1c50e2b1409126655a1e1cdac9df270cb9551a3fb07aec32466871d312af039093cbbc1b952098c
-  data.tar.gz: f163b5763430fc45882e26c0bca32f203a73b51525ce23a8575089f2ab8c06febfe5190993759ca8544b9da2f4b82fc425814c3c8680ac0e2a565ce5acad3da8
+  metadata.gz: 47b55e561f1b3a4d4d793c902fe4ed68812371abc8d0a787db0601d49875b788ca46ac352e53852d7a7a6ed9807e8c84ffdee5c82c0d32f3371bc27ae7e2e9de
+  data.tar.gz: a975ceace9239d04b36eb5c392b34ae1a8b6df969f1c564b58feb9d5a500ae83691aa09fc88d6813552f3c5bc4447c08a261d8a2fcedb78b1b197765362a97e7

data/lib/tableau_server_client/client.rb

@@ -14,17 +14,18 @@ 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, content_url, api_version, token_lifetime, logger, impersonation_user_id)
       @server_url = server_url
       @username = username
       @password = password
-      @site_name = site_name
+      @content_url = content_url
       @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 :content_url, :username, :api_version, :token_lifetime, :logger, :impersonation_user_id
 
     def server_url
       @_server_url ||= URI(@server_url.chomp("/"))
@@ -65,15 +66,27 @@ module TableauServerClient
       return response
     end
 
-    def update(resource)
+    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.body
+    end
+
+    def update(resource, path: nil, request: nil)
+      path = path || resource.path
+      request = request || resource.to_request
       session.put do |req|
-        req.url request_url(resource.path).to_s
-        req.body = resource.to_request
+        req.url request_url(path).to_s
+        req.body = request
       end
     end
 
-    def delete(resource)
-      session.delete request_url(resource.path).to_s
+    def delete(resource, path: nil)
+      path = path || resource.path
+      session.delete request_url(path).to_s
     end
 
     def session
@@ -104,6 +117,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
@@ -114,10 +128,6 @@ module TableauServerClient
       @token = TableauServerClient::Token.parse(res.body, token_lifetime)
     end
 
-    def content_url
-      site_name == 'default' ? "" : site_name
-    end
-
     def faraday
       @faraday ||= Faraday.new(request: {params_encoder: EmptyEncoder.new}, headers: {'Content-Type' => 'application/xml'}) do |f|
         f.response :raise_error

data/lib/tableau_server_client/exception.rb

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

data/lib/tableau_server_client/resources/datasource.rb

@@ -9,7 +9,7 @@ module TableauServerClient
     class Datasource < Resource
       include Downloadable
 
-      attr_reader :id, :name, :content_url, :type, :created_at, :updated_at, :is_certified
+      attr_reader :id, :name, :webpage_url, :content_url, :type, :created_at, :updated_at, :is_certified
       attr_writer :owner
 
       def self.from_response(client, path, xml)

data/lib/tableau_server_client/resources/extract_refresh.rb

@@ -41,7 +41,15 @@ module TableauServerClient
       end
 
       def schedule
-        @client.get_collection(Resources::Schedule.location(nil)).first {|s| s.id == schedule_id }
+        @client.get_collection(Resources::Schedule.location(nil)).find {|s| s.id == schedule_id }
+      end
+
+      def workbook
+        @client.get_collection(Workbook.location(site_path)).find {|w| w.id == workbook_id }
+      end
+
+      def datasource
+        @client.get_collection(Datasource.location(site_path)).find {|d| d.id == datasource_id }
       end
 
       def run_now
@@ -50,6 +58,10 @@ module TableauServerClient
         Job.from_response(@client, Job.location(site_path, id = job_id).path, resp)
       end
 
+      def delete!
+        resp = @client.delete(self)
+      end
+
     end
   end
 end

data/lib/tableau_server_client/resources/project.rb

@@ -1,4 +1,5 @@
 require 'tableau_server_client/resources/resource'
+require 'tableau_server_client/resources/workbook'
 
 module TableauServerClient
   module Resources
@@ -59,6 +60,12 @@ module TableauServerClient
         @hierarchy ||= (parent_projects << self).map {|p| p.name }.join('/')
       end
 
+      def workbooks
+        @client.get_collection(Workbook.location(site_path, filter: [])).select {|w|
+          w.project_id == id
+        }
+      end
+
       def extract_values_in_description
         @values_in_description ||=\
           description.lines.map { |l|/^(.*):\s*(.*)$/.match(l) }.reject { |m| m.nil? }.map { |m| m[1,2] }.to_h

data/lib/tableau_server_client/resources/resource.rb

@@ -61,6 +61,14 @@ module TableauServerClient
         self.class.extract_site_path(path)
       end
 
+      def site_id
+        site_path.split('/')[1]
+      end
+
+      def server_url
+        @client.server_url
+      end
+
       def delete!
         @client.delete self
       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,14 @@ module TableauServerClient
         @client.get Workbook.location(path, id)
       end
 
+      def views(filter: [])
+        @client.get_collection View.location(path, filter: filter)
+      end
+
+      def view(id)
+        @client.get View.location(path, id)
+      end
+
       def users(filter: [])
         @client.get_collection User.location(path, filter: filter)
       end

data/lib/tableau_server_client/resources/view.rb

@@ -0,0 +1,45 @@
+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
+        "#{server_url}#{content}/#/views/#{webpage_path}"
+      end
+
+      def webpage_path
+        content_url.gsub('/sheets/', '/')
+      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/resources/workbook.rb

@@ -3,6 +3,7 @@ require 'tableau_server_client/resources/project'
 require 'tableau_server_client/resources/connection'
 require 'tableau_server_client/resources/downloadable'
 require 'tableau_server_client/resources/datasource'
+require 'tableau_server_client/resources/view'
 
 module TableauServerClient
   module Resources
@@ -10,13 +11,14 @@ module TableauServerClient
     class Workbook < Resource
       include Downloadable
 
-      attr_reader :id, :name, :content_url, :show_tabs, :size, :created_at, :updated_at
+      attr_reader :id, :name, :webpage_url, :content_url, :show_tabs, :size, :created_at, :updated_at, :project_id, :owner_id, :tags
       attr_writer :owner
 
       def self.from_response(client, path, xml)
         attrs = extract_attributes(xml)
         attrs['project_id'] = xml.xpath("xmlns:project")[0]['id']
-        attrs['owner_id']   = xml.xpath("xmlns:owner")[0]['id']
+        attrs['owner_id'] = xml.xpath("xmlns:owner")[0]['id']
+        attrs['tags'] = xml.xpath("xmlns:tags/xmlns:tag").map {|t| t['label'] }
         new(client, path, attrs)
       end
 
@@ -32,13 +34,17 @@ module TableauServerClient
       end
 
       def project
-        @project ||= @client.get_collection(Project.location(site_path)).find {|p| p.id == @project_id }
+        @project ||= @client.get_collection(Project.location(site_path)).find {|p| p.id == project_id }
       end
 
       def owner
         @owner ||= @client.get User.location(site_path, @owner_id)
       end
 
+      def views
+        @views ||= @client.get_collection(View.location(site_path)).select {|v| v.workbook_id == id }
+      end
+
       def to_request
         request = build_request {|b|
           b.workbook {|w|
@@ -52,6 +58,21 @@ module TableauServerClient
         @client.update self
       end
 
+      def add_tags!(tags)
+        request = build_request {|b|
+          b.tags {
+            tags.each do |t|
+              b.tag(label: t)
+            end
+          }
+        }
+        resp = @client.update(self, path: "#{path}/tags", request: request)
+      end
+
+      def delete_tag!(tag)
+        @client.delete(self, path: "#{path}/tags/#{tag}")
+      end
+
       def embedded_datasources
         download.xpath('//datasources//datasource').map do |ds|
           Datasource::DatasourceContent.new(ds)

data/lib/tableau_server_client/server.rb

@@ -1,25 +1,43 @@
 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
   class Server
 
+    #Implement for_token
+    #def for_token(token)
+
     def initialize(server_url, username, password,
-                   site_name: "default", api_version: "3.1", token_lifetime: 240,
-                   log_level: :info)
+                   content_url: "", api_version: "3.1", token_lifetime: 240,
+                   log_level: :info, impersonation_username: nil)
+      @server_url = server_url
+      @username = username
+      @password = password
+      @content_url = content_url
+      @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, :content_url, :api_version, :token_lifetime, :logger, :impersonation_username
+
     def sites
-      client.get_collection Resources::Site.location(path)
+      client.get_collection(Resources::Site.location(path)).map {|s|
+        client_for_site(s.content_url).get_collection(Resources::Site.location(path)).select {|x| x.id == s.id }.first
+      }
     end
 
     def site(id)
-      client.get Resources::Site.location(path, id)
+      sites.select { |s| s.id == id }.first
+    end
+
+    def full_site(id)
+      client_for_site(client.get(Resources::Site.location(path, id)).content_url).get Resources::Site.location(path, id)
     end
 
     def schedules
@@ -32,7 +50,35 @@ module TableauServerClient
 
     private
 
-    attr_reader :client
+    attr_reader :password
+
+    def client
+      @client ||= client_for_site(content_url)
+    end
+
+    def client_for_site(_content_url)
+      Client.new(server_url, username, password, _content_url, api_version, token_lifetime, @logger, impersonation_user_id)
+    end
+
+    def site_id
+      admin_client.get_collection(Resources::Site.location(path)).each do |site|
+        if site.content_url == content_url
+          return site.id
+        end
+      end
+    end
+
+    def impersonation_user_id
+      return @impersonation_user_id if @impersonation_user_id
+      return nil unless impersonation_username
+      user = admin_client.get(Resources::Site.location(path, site_id)).users(filter: ["name:eq:#{impersonation_username}"]).first
+      return @impersonation_user_id = user.id if user
+      raise TableauServerClientError.new("User '#{username}' not found.")
+    end
+
+    def admin_client
+      @admin_client ||= Client.new(server_url, username, password, content_url, 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.17"
+  VERSION = "0.2.0"
 end

data/tableau_server_client.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = ["console"]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tableau_server_client
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.2.0
 platform: ruby
 authors:
 - shimpeko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -175,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Tableau Server REST API Client