tableau_rest_api 0.1.2

data/fixtures/vcr_cassettes/workbooks_through_site.yml

@@ -0,0 +1,250 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://tableau.lvh.me/api/2.6/auth/signin
+    body:
+      encoding: UTF-8
+      string: '{"credentials":{"name":"<TABLEAU_USERNAME>","password":"<TABLEAU_PASSWORD>","site":{"contentUrl":""}}}'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.3.3p222
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '94'
+      Host:
+      - tableau.lvh.me
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 26 Jun 2017 10:50:21 GMT
+      Server:
+      - Tableau
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+      P3p:
+      - CP="NON"
+      X-Ua-Compatible:
+      - IE=Edge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '195'
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAAz2MvQ6CMBgA3+WbbdIf/uqGoAwatUYTdTGlFENQMC1KCPLu
+        wuJ0y931oIzOdNUU8mFh3oMtGj2xyGAORBKcuylHmPIUOUw7SHoUI99nGfE4
+        ZixQMANVV824OJnH2MAwg7fV5j+hKSGcU44ylrvIyXGAJFcEUYyVdlju+0E6
+        RU1d6mr02/3ldgnPndDdcRG+2mW0NUJ8n+uKtvaDD/F9USdMRNe4tbsk2JRH
+        Ks1KwDD8AFV7PaPNAAAA
+    http_version: 
+  recorded_at: Mon, 26 Jun 2017 10:50:24 GMT
+- request:
+    method: get
+    uri: https://tableau.lvh.me/api/2.6/sites
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.3.3p222
+      Content-Type:
+      - application/json
+      X-Tableau-Auth:
+      - wPY_YAXyQeyTBApwECNrQQ|mKn2wsv0RDgBoG3QCZDwsOG8LkT2arFQ
+      Host:
+      - tableau.lvh.me
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 26 Jun 2017 10:50:21 GMT
+      Server:
+      - Tableau
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+      P3p:
+      - CP="NON"
+      X-Ua-Compatible:
+      - IE=Edge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '521'
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA92VS2sbMRDHv0rYcwb0Wj1yM22hhz4OaeihlKDHyBHY67CS
+        A23wd++oCZjY8SmH4t52/n/NSPoxo30c7v2yTL6VzTRcPfYIv2zXAefhauDD
+        5V/huvzGHjJGQts0v1o8+LLyYdVlO+wuh1oa1l6gfwxXPx6HknqK5yyPwQET
+        LoCSqMBrwcAYmbh2TEobqebk173Se8x+u2okxM3UcGo384pkin1al+nzJvVV
+        7568xZRuKs6V3Np833RYxFYekIQZH0qlG30stW3mXx+mflQ6T5u3uHc/lXVp
+        lCbGXmMbapxLwK/tjqoepCy3WNsiRqx7J/tVJSv6eIff/bze3r9I2l0+M7DC
+        SAzKgDZRgRrFCJ55A6OMiRtnMaPZM/hGG10TQ3FIwXv/T0E8X/ctJLSVNqGK
+        gFlJUMEKcIxZUFp6HS1qpdUxCXlIgjqt1WdEZ82D5ei1zQo4z5k6w3CaDgqF
+        cNl46WhoXuGhT/HQ584jcO6iiCPEmCIoZyUElT1oDCJIF6RIYc9jcdGJlGl5
+        0akcjctte3Jv65N71mTYGJNmHIFj0tQp0kCI0oIMMmiT2IjcveyUV6F0JP8J
+        D0QntQMv6GGlHtH0khgEpmLOIotAP5ljHqdwnDuNFBTnnJ7UrCwDpZwGO6oR
+        Riu7TkOF+YjGCRjnyuLnbvcHHjntMMwIAAA=
+    http_version: 
+  recorded_at: Mon, 26 Jun 2017 10:50:24 GMT
+- request:
+    method: post
+    uri: https://tableau.lvh.me/api/2.6/auth/signin
+    body:
+      encoding: UTF-8
+      string: '{"credentials":{"name":"<TABLEAU_USERNAME>","password":"<TABLEAU_PASSWORD>","site":{"contentUrl":""}}}'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.3.3p222
+      Content-Type:
+      - application/json
+      X-Tableau-Auth:
+      - wPY_YAXyQeyTBApwECNrQQ|mKn2wsv0RDgBoG3QCZDwsOG8LkT2arFQ
+      Content-Length:
+      - '94'
+      Host:
+      - tableau.lvh.me
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 26 Jun 2017 10:50:22 GMT
+      Server:
+      - Tableau
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+      P3p:
+      - CP="NON"
+      X-Ua-Compatible:
+      - IE=Edge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '193'
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAAz3MuQ6CQBSF4Xe5NZPMAgxjp9EYiHEJEWxnjYRNWWIUfXex
+        sTrN+b8JdGeNbYZCVj0sJuiLwf62MLAAIgl2gRIIU6GQz6yPZEgx4pwZEgrM
+        WKTBA902w0ycu2pu4OPB2Nvuj1BFiBBUIMNcgHyHIySFJohirK3PHOeR+kVD
+        W9pm/i/dMXo97/v0lOP9rcvi3aVWj3eWPXnCVVGWJt2sctuM9fYeq0N+fTCZ
+        rGfi8wW5CskzzQAAAA==
+    http_version: 
+  recorded_at: Mon, 26 Jun 2017 10:50:25 GMT
+- request:
+    method: get
+    uri: https://tableau.lvh.me/api/2.6/sites/1a10f5b9-029b-43e4-a620-773d1690338c/workbooks
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.3.3p222
+      Content-Type:
+      - application/json
+      X-Tableau-Auth:
+      - AfP8zyqNSQW0NprVILXmbw|VVy7J7bikkdSEBWenumGqIbOWhw3aJDb
+      Host:
+      - tableau.lvh.me
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 26 Jun 2017 10:50:22 GMT
+      Server:
+      - Tableau
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+      P3p:
+      - CP="NON"
+      X-Ua-Compatible:
+      - IE=Edge
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '1194'
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA82YS2/bRhDHvwqhUwtkgX0/eFMQoIfERRA7lxQ9zL4c1ZJo
+        kFRcO/B376ykWLQsurHbAwEfzNn/7gx/nJ2d1ffZNVwu1tAvmvWs/l6e0u+b
+        lU/trJ6x2Zut4Xxxl8ojpWjomx6W82+wWIJfbs1qdv9mdtO0V75prrqyyo+H
+        Wf0HLtk2f6XQF/siop4anXQQhnjglkhvDbHWAFHBGaqCdiIH9LOGVVn9oniB
+        TXUOq+tl6oqr5mZdwtsvxz1jznFHosiKyEwtARcY4ZSGJEU2xvoyq4fLEhv+
+        t50mHQeuwZEEWmMUUhAfUiZcacMhCs1jPkRxvrlObdc3bUJbaNZ9Wvef2+Xx
+        SPe1ucGA0c+sbzdbyx5dmdYm6FOc9yVoyjShhjBxwWmtTC3sF5RsruNjCeOE
+        qguma+5qSb/ge0yVJ0ssBxUTiarwFNljFFkQLgIH55IEgEMUn9IlJhwsj2kO
+        7K9laWsmXs1SgPWaScToRCCMJU1Ac0Z0FtI54SQId3iLdynDZtn/bwwN59ri
+        TOJ5BCKlQO9RcOJdyExLzSWLB+8fFt9She8IxxDLwN7+MoiFkL5gtBa8VvoE
+        RIMECdMFIlW1mCREoEbEGB3RCjAEHZCfVZp4QYXWUjHl6MH727QOX1fQXi3W
+        l8ccj8ZGWUoxBtMVmMzVio1m5IOETxEmjVJSZEhYipJIhgvYwCPutexcpsoz
+        7w/ez+YXlX8GKI77n2TKR5AyWXhxTD41hpThJpe1xD83RaRWam21FySahEgl
+        HkHeh0wsBYulXNPA8mOkgAXxtl+Eropp1ZyA+iDYj79k1+OWZtu6qMqWHtv1
+        O4mtJa/ZJBNVCsspHjSYIDQTSb0lTiPVpJJRIUaewR68vz+XjxK1+mWxrvCF
+        LtvUdb8eE0b1ULxY/1A+WxT0CGuOGcwxN2t+qig8SJC12H6O6bGmPFjHjCZR
+        ZjymGChinQMSPIXAODDDBxk8b6+qD7+9rd5B99U30MZjvCjA8eHwi/OX45Fk
+        aoqF9FQbtZOYkuKC1nSSTK13zDKNp1b0FJs4ITB/sZhZpxNQS7mgA+/v0211
+        jiukSlZnGMaCzAPg5r+tLtpN1z9bhHHudqp8NHE772eL8+hn2DJWrmby+c+w
+        l0zvM0BQoDLPhFkjMLVlIg67CZLRMwRJnfHp4P3j57N59XHxaV6lv/ft9BHs
+        oiiCwfgLqfLS12K/hZlbKu8pqjuJqYtqkkcetrPYgdlEvJF45HkFxHmFC3AD
+        1rDITR60ZA99bUUq6DqssyvkWfWp68c6XXLQ7WUvpsx5qblCbxuxU5TFnjI2
+        FkJM+SamlQhKREuswPNQBmw1LOYvMVQEQ7NUMetDFLl50lHsTAOCGZbdvyLU
+        W4SiXGZPXsCOJCOJOg2ElGvlvJXY9vqIPRp+fB+TIDklp1IUBi+5hyg8tMcI
+        d6bXIZQ1NTUfqaBDychBNg2E5eeVIBwWG2o4ZiGlxEmTCI8xeOOCSCwNEd49
+        RXj33xCqUzeEI4mdMkKFZZMZZOYlTXgYBewJLMUCqhkEzUFRyoYb+QnCnem1
+        CDkeJyMt6lBSauGf9/f/ABbHJgpJFAAA
+    http_version: 
+  recorded_at: Mon, 26 Jun 2017 10:50:25 GMT
+recorded_with: VCR 3.0.3

data/lib/tableau_rest_api.rb

@@ -0,0 +1,32 @@
+require 'json'
+require 'rest-client'
+require 'aspector'
+require 'timerizer'
+require 'securerandom'
+
+require 'tableau_rest_api/version'
+require 'tableau_rest_api/client'
+require 'tableau_rest_api/area/user_group'
+require 'tableau_rest_api/area/workbook_datasource'
+require 'tableau_rest_api/area/schedule_subscription'
+require 'tableau_rest_api/resource'
+require 'tableau_rest_api/api_error'
+require 'tableau_rest_api/util/config'
+require 'tableau_rest_api/util/response'
+require 'tableau_rest_api/util/upload'
+require 'tableau_rest_api/util/token'
+require 'tableau_rest_api/helpers/helpers'
+require 'tableau_rest_api/resources/base'
+require 'tableau_rest_api/resources/site'
+require 'tableau_rest_api/resources/user'
+require 'tableau_rest_api/resources/group'
+require 'tableau_rest_api/resources/datasource'
+require 'tableau_rest_api/resources/project'
+require 'tableau_rest_api/resources/workbook'
+require 'tableau_rest_api/resources/subscription'
+require 'tableau_rest_api/resources/schedule'
+require 'tableau_rest_api/resources/server'
+
+# Tableau API wrapper lib
+module TableauRestApi
+end

data/lib/tableau_rest_api/api_error.rb

@@ -0,0 +1,7 @@
+module TableauRestApi
+  class ApiError < StandardError
+    def initialize(error)
+      super(error)
+    end
+  end
+end

data/lib/tableau_rest_api/area/schedule_subscription.rb

@@ -0,0 +1,41 @@
+module TableauRestApi
+  module ScheduleSubscription
+    aspector do
+      before :subscriptions, :login
+      before :query_subscription, :login
+      before :create_subscription, :login
+      before :delete_subscription, :login
+      before :schedules, :login
+    end
+
+    def subscriptions(site_id)
+      url = build_url ['sites', site_id, 'subscriptions']
+      (get url).subscriptions.subscription.to_a.map { |sub| Subscription.new(sub) }
+    end
+
+    def query_subscription(site_id, sub_id)
+      url = build_url ['sites', site_id, 'subscriptions', sub_id]
+      Subscription.new((get url).subscription)
+    end
+    
+    def create_subscription(site_id, subscription)
+      url = build_url ['sites', site_id, 'subscriptions']
+      Subscription.new((post url, subscription).subscription)
+    end
+
+    def delete_subscription(site_id, subscription_id)
+      url = build_url ['sites', site_id, 'subscriptions', subscription_id]
+      delete url
+    end
+  
+    def delete_schedule(schedule_id)
+      url = build_url ['schedules', schedule_id]
+      delete url
+    end
+
+    def schedules
+      url = build_url 'schedules'
+      (get url).schedules.schedule.to_a.map { |schedule| Schedule.new(schedule) }
+    end
+  end
+end

data/lib/tableau_rest_api/area/user_group.rb

@@ -0,0 +1,72 @@
+module TableauRestApi
+  module UserGroup
+    aspector do
+      before :users_on_site,:login
+      before :groups, :login
+      before :users_in_group, :login
+      before :add_user_to_site, :login
+      before :add_user_to_group, :login
+      before :create_group, :login
+      before :delete_group, :login
+      before :remove_user_from_group, :login
+      before :remove_user_from_site, :login
+      before :update_user, :login
+      before :update_group, :login
+    end
+ 
+    def users_on_site(site_id)
+      url = build_url ['sites', site_id, 'users']
+      (get url).users.user.to_a.map { |user| User.new(user) }
+    end
+
+    def groups(site_id)
+      url = build_url ['sites', site_id, 'groups']
+      (get url).groups.group.to_a.map { |group| Group.new(group) }
+    end
+
+    def users_in_group(site_id, group_id)
+      url = build_url ['sites', site_id, 'groups', group_id, 'users']
+      (get url).users.user.to_a.map { |user| User.new(user) }
+    end
+
+    def add_user_to_site(site_id, user)
+      url = build_url ['sites', site_id, 'users']
+      User.new((post url, { :user => user }).user)
+    end
+
+    def add_user_to_group(site_id, group_id, user_id)
+      url = build_url ['sites', site_id, 'groups', group_id, 'users']
+      User.new((post url, { :user => { :id => user_id } }).user)
+    end
+
+    def create_group(site_id, group)
+      url = build_url ['sites', site_id, 'groups']
+      Group.new((post url, { :group => { :name => group } }).group)
+    end
+
+    def delete_group(site_id, group_id)
+      url = build_url ['sites', site_id, 'groups', group_id]
+      delete url
+    end
+
+    def remove_user_from_group(site_id, group_id, user_id)
+      url = build_url ['sites', site_id, 'groups', group_id, 'users', user_id]
+      delete url
+    end
+
+    def remove_user_from_site(site_id, user_id)
+      url = build_url ['sites', site_id, 'users', user_id]
+      delete url
+    end
+
+    def update_user(site_id, user)
+      url = build_url ['sites', site_id, 'users', user[:id]]
+      User.new((put url, { :user => user }).user)
+    end
+
+    def update_group(site_id, group)
+      url = build_url ['sites', site_id, 'groups', group[:id]]
+      Group.new((put url, { :group => group }).group)
+    end
+  end
+end

data/lib/tableau_rest_api/area/workbook_datasource.rb

@@ -0,0 +1,87 @@
+module TableauRestApi
+  module WorkbookDatasource
+    aspector do
+      before :query_workbooks, :login
+      before :get_workbook, :login
+      before :datasources, :login
+      before :get_datasource, :login
+      before :update_workbook, :login
+      before :update_datasource, :login
+      before :update_project, :login
+      before :query_projects, :login
+      before :publish_workbook, :login
+      before :publish_datasource, :login
+      before :delete_workbook, :login
+      before :delete_datasource, :login
+    end
+
+    def query_workbooks(site_id)
+      url = build_url ['sites', site_id, 'workbooks']
+      (get url).workbooks.workbook.to_a.map { |workbook| Workbook.new(workbook) }
+    end
+
+    def datasources(site_id)
+      url = build_url ['sites', site_id, 'datasources']
+      (get url).datasources.datasource.to_a.map { |ds| Datasource.new(ds) }
+    end
+
+    def get_workbook(site_id, workbook_id)
+      url = build_url ['sites', site_id, 'workbooks', workbook_id, 'content']
+      RestClient.get url, header
+    end
+
+    def get_datasource(site_id, datasource_id)
+      url = build_url ['sites', site_id, 'datasources', datasource_id, 'content']
+      RestClient.get url, header
+    end
+
+    def update_workbook(site_id, workbook_id, workbook)
+      url = build_url ['sites', site_id, 'workbooks', workbook_id]
+      Workbook.new((put url, workbook).workbook)
+    end
+    
+    def update_datasource(site_id, datasource_id, datasource)
+      url = build_url ['sites', site_id, 'datasources', datasource_id]
+      Datasource.new((put url, datasource).datasource)
+    end
+
+    def update_project(site_id, project_id, project)
+      url = build_url ['sites', site_id, 'projects', project_id]
+      Project.new((put url, project).project)
+    end
+
+    def query_projects(site_id)
+      url = build_url ['sites', site_id, 'projects']
+      (get url).projects.project.to_a.map { |project| Project.new(project) }
+    end
+
+    def delete_workbook(site_id, workbook_id)
+      url = build_url ['sites', site_id, 'workbooks', workbook_id]
+      delete url
+    end
+
+    def delete_datasource(site_id, datasource_id)
+      url = build_url ['sites', site_id, 'datasources', datasource_id]
+      delete url
+    end
+
+    def delete_project(site_id, project_id)
+      url = build_url ['sites', site_id, 'projects', project_id]
+      delete url
+    end
+
+    def publish_workbook(site_id, metadata, payload)
+      url = build_url ['sites', site_id, 'workbooks']
+      boundary = SecureRandom.uuid
+      request = Upload.new(metadata, payload, boundary).build
+      Workbook.new((post url, request, boundary).workbook)
+    end
+    
+    def publish_datasource(site_id, metadata, payload)
+      url = build_url ['sites', site_id, 'datasources']
+      boundary = SecureRandom.uuid
+      request = Upload.new(metadata, payload, boundary).build(:datasource)
+      Datasource.new((post url, request, boundary).datasource)
+    end
+  end
+end