Ruby interface to the Tableau 9.0 API.
Add this line to your application's Gemfile:
gem 'tableau_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install tableau_api
client = TableauApi.new(host: 'https://tableau.domain.tld', site_name: 'Default', username: 'ExampleUsername', password: 'ExamplePassword')
client.users.create(username: 'baz')
client = TableauApi.new(host: 'https://tableau.domain.tld', site_name: 'Default', username: 'ExampleUsername')
client.auth.trusted_ticket
# find a workbook by name
workbook = client.workbooks.list.find do |w|
w['name'] == 'Example Workbook Name'
end
After checking out the repo, run bin/setup
to install dependencies. Then, run rake
to run the tests and linters. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
docker run -it -d -v $(pwd):/src ruby:2 /bin/bash
docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
Cassettes should be self-contained, generated by a single spec file run in defined order. To make changes to specs, it's best to delete a whole cassette and rerun the whole spec file, except for auth.yml, since it could be difficult to generate a trusted ticket from a non-trusted host.
To regenerate all the the cassettes, you'll first need to create the following on the Tableau server:
- Site: Default
- Site: TestSite
- Datasource: test (this might need to be created from Tableau Desktop)
- Username: test_test
And delete the following if they exist:
- Group: testgroup (probably under TestSite)
- Project: test_project (probably under Default)
- Site: Test Site 2
- User: test (probably under TestSite)
- Workbook: test
- Workbook: testpublish
Set the environment variables below to an administrator account and your Tableau Server hostname.
Then run the commands below:
docker run -it -d \
-v $(pwd):/src \
-e TABLEAU_HOST -e TABLEAU_ADMIN_USERNAME -e TABLEAU_ADMIN_PASSWORD \
ruby /bin/bash
docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
Bug reports and pull requests are welcome on GitHub at https://github.com/civisanalytics/tableau_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
tableau_api is released under the BSD 3-Clause License.