tableau_rest_api 0.1.2

data/lib/tableau_rest_api/client.rb

@@ -0,0 +1,65 @@
+module TableauRestApi
+  # Client class wrapping a subset of the Tableau Rest API
+  # This class just contains worker methods for interacting with Tableau.
+  # See the Request sub-class for resource requests.
+  class Client
+    attr_reader :config, :token
+    
+    def initialize
+      @config = Config.new.options
+    end
+
+    def configure(config)
+      @config = Config.new(config).options
+    end
+
+    def login(*_args)
+      return if authorised?
+      url = build_url ['auth', 'signin']
+      resp = post url, @config[:credentials]
+      @token = Token.new(resp.credentials.token, @config[:auth_duration])
+    end
+
+    def logout
+      post(build_url ['auth', 'signout'])
+      @token = nil
+      !authorised?
+    end
+
+    def authorised?
+      token = self.token
+      token && !token.expired? ? true : false
+    end
+    
+    private
+
+    def header(boundary=nil)
+      head = { :accept => :json, :content_type => :json }
+      head = authorised? ? head.merge({ :x_tableau_auth => self.token.value }) : head
+      head = boundary ? head.merge({ :content_type => "multipart/mixed; boundary=#{boundary}"}) : head
+    end
+
+    def build_url(endpoint)
+      endpoint = endpoint.is_a?(Array) ? endpoint.join('/') : endpoint
+      "#{@config[:host]}/#{@config[:base]}/#{@config[:api_version]}/#{endpoint}"
+    end
+
+    def get(url)
+      Response.new(RestClient.get(url, header)).parse
+    end
+    
+    def post(url, data={}, boundary=nil)
+      data = data.to_json unless boundary
+      headers = header boundary
+      Response.new(RestClient.post(url, data, headers)).parse
+    end
+    
+    def put(url, data={})
+      Response.new(RestClient.put(url, data.to_json, header)).parse
+    end
+    
+    def delete(url)
+      Response.new(RestClient.delete(url, header)).parse
+    end 
+  end
+end

data/lib/tableau_rest_api/helpers/helpers.rb

@@ -0,0 +1,9 @@
+module TableauRestApi
+  module Helpers
+    def self.camel_case_lower(term)
+      term.split('_')
+        .inject([]){ |buf,elm| buf.push(buf.empty? ? elm : elm.capitalize) }
+        .join
+    end
+  end
+end

data/lib/tableau_rest_api/resource.rb

@@ -0,0 +1,42 @@
+module TableauRestApi
+  # Subclass providing access to Tableau resources.
+  # An auth token is requested if missing or expired.
+  class Resource < Client
+    aspector do
+      before :sites, :login
+      before :create_site, :login
+      before :switch_site, :login
+      before :delete_site, :login
+    end
+
+    include TableauRestApi::UserGroup
+    include TableauRestApi::WorkbookDatasource
+    include TableauRestApi::ScheduleSubscription
+
+    def server_info
+      url = build_url 'serverinfo'
+      Server.new((get url).serverInfo)
+    end
+
+    def sites
+      url = build_url 'sites'
+      (get url).sites.site.to_a.map { |site| Site.new(site, self) }
+    end
+ 
+    def create_site(site)
+      url = build_url 'sites'
+      Site.new((post url, site).site, self)
+    end
+
+    def switch_site(site)
+      url = build_url ['auth', 'switchSite']
+      @token = Token.new((post url, site).credentials.token, self.config[:auth_duration])
+    end
+
+    def delete_site(site_id)
+      url = build_url ['sites', site_id]
+      delete url
+      @token = nil
+    end
+ end
+end

data/lib/tableau_rest_api/resources/base.rb

@@ -0,0 +1,24 @@
+module TableauRestApi
+  class Base
+    def to_hash
+      self.to_array.to_h
+    end
+    
+    def to_h
+      self.to_hash
+    end
+
+    def to_array
+      filter_instance_variables.map do |var|
+        [Helpers::camel_case_lower(var[1..-1]).to_sym, self.instance_variable_get(var)]
+      end
+    end
+
+    private
+
+    def filter_instance_variables
+      self.instance_variables.select { |var| var != :@called_by }
+    end
+  end
+end
+

data/lib/tableau_rest_api/resources/datasource.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class Datasource < Base
+    attr_reader :id, :name, :type, :created_at
+
+    def initialize(ds)
+      @id = ds.id
+      @name = ds.name
+      @type = ds.type
+      @created_at = ds.createdAt
+    end
+  end
+end

data/lib/tableau_rest_api/resources/group.rb

@@ -0,0 +1,10 @@
+module TableauRestApi
+  class Group < Base
+    attr_reader :id, :name 
+
+    def initialize(group)
+      @id = group.id
+      @name = group.name
+    end
+  end
+end

data/lib/tableau_rest_api/resources/project.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class Project < Base
+    attr_reader :id, :name, :description, :content_permissions 
+
+    def initialize(project)
+      @id = project.id
+      @name = project.name
+      @description = project.description
+      @content_permissions = project.contentPermissions
+    end
+  end
+end

data/lib/tableau_rest_api/resources/schedule.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class Schedule < Base
+    attr_reader :id, :name, :state, :priority 
+
+    def initialize(schedule)
+      @id = schedule.id
+      @name = schedule.name
+      @state = schedule.state
+      @priority = schedule.priority
+    end
+  end
+end

data/lib/tableau_rest_api/resources/server.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class Server < Base
+    attr_reader :version, :build , :api_version
+
+    def initialize(server)
+      product_version = server.productVersion
+      @version = product_version.value
+      @build = product_version.build
+      @api_version = server.restApiVersion 
+    end
+  end
+end

data/lib/tableau_rest_api/resources/site.rb

@@ -0,0 +1,68 @@
+module TableauRestApi
+  class Site < Base
+    attr_reader :id, :name, :content_url 
+
+    def initialize(site, called_by)
+      @id = site.id
+      @name = site.name
+      @content_url = site.contentUrl
+      @called_by = called_by
+    end
+
+    def users
+      @called_by.users_on_site(@id)
+    end
+
+    def groups
+      @called_by.groups(@id)
+    end
+
+    def datasources
+      @called_by.datasources(@id)
+    end
+    
+    def projects
+      @called_by.query_projects(@id)
+    end
+
+    def workbooks
+      @called_by.query_workbooks(@id)
+    end
+
+    def users_in_group(group_id)
+      @called_by.users_in_group(@id, group_id)
+    end
+
+    def create_group(group)
+      @called_by.create_group(@id, group)
+    end
+
+    def delete_group(group_id)
+      @called_by.delete_group(@id, group_id)
+    end
+
+    def add_user_to_group(group_id, user_id)
+      @called_by.add_user_to_group(@id, group_id, user_id)
+    end
+
+    def add_user_to_site(user)
+      @called_by.add_user_to_site(@id, user)
+    end
+
+    def remove_user_from_group(group_id, user_id)
+      @called_by.remove_user_from_group(@id, group_id, user_id)
+    end
+
+    def remove_user_from_site(user_id)
+      @called_by.remove_user_from_site(@id, user_id)
+    end
+
+    def update_user(user)
+      @called_by.update_user(@id, user)
+    end
+
+    def update_group(group)
+      @called_by.update_group(@id, group)
+    end
+  end
+end

data/lib/tableau_rest_api/resources/subscription.rb

@@ -0,0 +1,10 @@
+module TableauRestApi
+  class Subscription < Base
+    attr_reader :id, :subject 
+
+    def initialize(sub)
+      @id = sub.id
+      @subject = sub.subject
+    end
+  end
+end

data/lib/tableau_rest_api/resources/user.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class User < Base
+    attr_reader :id, :name, :site_role, :last_login 
+
+    def initialize(user)
+      @id = user.id
+      @name = user.name
+      @site_role = user.siteRole
+      @last_login = user.lastLogin
+    end
+  end
+end

data/lib/tableau_rest_api/resources/workbook.rb

@@ -0,0 +1,12 @@
+module TableauRestApi
+  class Workbook < Base
+    attr_reader :id, :name, :content_url, :project 
+
+    def initialize(workbook)
+      @id = workbook.id
+      @name = workbook.name
+      @content_url = workbook.contentUrl
+      @project = Project.new(workbook.project)
+    end
+  end
+end

data/lib/tableau_rest_api/util/config.rb

@@ -0,0 +1,22 @@
+module TableauRestApi
+  class Config
+    attr_reader :options
+    
+    def initialize(config={})
+      @options = {
+        host: ENV['TABLEAU_HOST'] || 'https://tableau.lvh.me',
+        api_version: '2.6',
+        base: 'api',
+        auth_duration: ENV['TABLEAU_AUTH_TOKEN_DURATION'] || 4.hours,
+        credentials: {
+          credentials: { 
+            name: ENV['TABLEAU_USERNAME'] || 'admin',
+            password: ENV['TABLEAU_PASSWORD'] || 'admin',
+            site: { contentUrl: "" }
+          }
+        }
+      }
+      @options = @options.merge(config)
+    end
+  end
+end

data/lib/tableau_rest_api/util/response.rb

@@ -0,0 +1,11 @@
+module TableauRestApi
+  class Response
+    def initialize(resp)
+      @body = resp.body
+    end
+
+    def parse
+      @body.length >= 2 ? JSON::parse(@body, object_class: OpenStruct) : nil
+    end
+  end
+end

data/lib/tableau_rest_api/util/token.rb

@@ -0,0 +1,16 @@
+module TableauRestApi
+  # Representation of a x_auth_tableau token
+  # These tokens have a finite lifespan, the default is 4 hours.
+  class Token
+    attr_reader :value, :expires
+
+    def initialize(token, duration)
+      @value = token
+      @expires = duration.from_now
+    end
+
+    def expired?
+      @value ? Time.now > @expires : true
+    end
+  end
+end

data/lib/tableau_rest_api/util/upload.rb

@@ -0,0 +1,29 @@
+module TableauRestApi
+  class Upload
+    def initialize(metadata, payload, boundary)
+      @metadata = metadata
+      @payload = payload
+      @boundary = boundary
+    end
+
+    def build(obj=:workbook)
+      <<-END
+        --#{@boundary}\r
+        Content-Disposition: name="request_payload"\r
+        Content-Type: text/xml\r
+        \r
+        <tsRequest>\r
+          <#{obj} name="#{@metadata[:name]}">\r
+            <project id="#{@metadata[:project]}"/>\r
+          </#{obj}>\r
+        </tsRequest>\r
+        --#{@boundary}\r
+        Content-Disposition: name="tableau_#{obj}"; filename="#{@payload[:filename]}"\r
+        Content-Type: application/octet-stream\r
+        \r
+        #{@payload[:data]}\r
+        --#{@boundary}--\r
+      END
+    end
+  end
+end

data/lib/tableau_rest_api/version.rb

@@ -0,0 +1,3 @@
+module TableauRestApi
+  VERSION = "0.1.2"
+end

data/tableau_rest_api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tableau_rest_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tableau_rest_api"
+  spec.version       = TableauRestApi::VERSION
+  spec.authors       = ["Dave Lancaster"]
+  spec.email         = ["lancaster.dave@gmail.com"]
+
+  spec.summary       = %q{Ruby library wrapping the Tableau REST API.}
+  spec.description   = %q{Exposes a subset of the Tablea v2.6 REST API (json).}
+  spec.homepage      = "https://github.com/davelancaster/tableau-rest-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "aspector", "~> 0.14"
+  spec.add_dependency "timerizer", "~> 0.1"
+end