tableau_trusted_interface 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5467bb2e8e072b64e254eb22bbfc0a22de0225cb
+  data.tar.gz: 562c0a1ea10ee21c050ad01f3bf6ef81916ecc61
+SHA512:
+  metadata.gz: 6f94eac10f739571ce49d90eea266afe956e83a36e4e4db84933da887fd30b7b600c5fccf492f613dd42429e76154a86360a58f7f3b2a7f3e8678d739963ba90
+  data.tar.gz: 3f5118366a095ed348bb9f4ec5e97954941cded77d0f09fd626fbd01641f2cdb32c33254ba296bbd7a97950d6d2ae7a765ccd3633b733c712aa0d2dd0ea5276b

data/README.md

@@ -0,0 +1,50 @@
+# Tableau Trusted Interface for Ruby
+
+Wrapper for embedding Tableau workbooks using the [Tableau trusted interface](http://onlinehelp.tableau.com/current/server/en-us/help.htm#trusted_auth_how.htm).
+
+## Installation
+
+Add to your `Gemfile`:
+
+``` ruby
+gem 'tableau_trusted_interface'
+```
+
+You have the option of specifying a default server address and user:
+
+``` ruby
+TableauTrustedInterface.configure do |config|
+  config.default_tableau_user = 'foobar'
+  config.default_tableau_server = 'http://example.com'
+end
+```
+
+## Usage
+
+ Instantiate the interface by specifying which workbook you want and the embed params you wish to use:
+
+ ``` ruby
+@report = TableauTrustedInterface::Report.new(
+  path: 'project/workbook',
+  embed_params: { embed: 'yes', toolbar: 'no' }
+)
+```
+
+You can optionally pass `user:` and `server:` options here too if you don’t want to use the configured defaults.
+
+This would typically be put in a Rails controller. Then in your view you have two public methods:
+
+ - `@report.report_url`
+ - `@report.report_embed_url`
+
+For convenience, this is how you embed the report in a responsive Bootstrap 3 iframe:
+
+``` erb
+<div class="embed-responsive embed-responsive-16by9">
+  <iframe class="embed-responsive-item" src="<%= @report.report_embed_url %>"></iframe>
+</div>
+```
+
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

data/lib/tableau_trusted_interface/config.rb

@@ -0,0 +1,8 @@
+require 'active_support/configurable'
+
+module TableauTrustedInterface
+  include ActiveSupport::Configurable
+
+  config_accessor :default_tableau_user
+  config_accessor :default_server
+end

data/lib/tableau_trusted_interface/errors.rb

@@ -0,0 +1,5 @@
+module TableauTrustedInterface
+  class TicketDenied < StandardError; end
+  class ServerUnavailable < StandardError; end
+  class MissingConfiguration < StandardError; end
+end

data/lib/tableau_trusted_interface/report.rb

@@ -0,0 +1,53 @@
+require 'addressable/template'
+require 'rest-client'
+
+module TableauTrustedInterface
+  class Report
+    attr_reader :server, :ticket, :user
+    attr_accessor :embed_params, :path
+
+    def initialize(options = {})
+      @path = options.fetch(:path, nil)
+      @embed_params = parse_embed_params(options.fetch(:embed_params, []))
+      @user = options.fetch(:user, TableauTrustedInterface.config.default_tableau_user)
+      @server = options.fetch(:server, TableauTrustedInterface.config.default_tableau_server)
+
+      @ticket = generate_ticket
+      raise TicketDenied, 'Check Tableau IP white-listing or user access' if @ticket == '-1'
+    end
+
+    def report_url
+      report.expand(query: nil).to_s
+    end
+
+    def report_embed_url
+      report.expand(query: embed_params).to_s
+    end
+
+    private
+
+    def parse_embed_params(params)
+      Hash[params.map { |key, value| [":#{key}", value] }]
+    end
+
+    def generate_ticket
+      raise MissingConfiguration unless user && server
+      RestClient.post(URI.join(server, 'trusted').to_s, username: user)
+    rescue SocketError, RestClient::RequestTimeout
+      raise ServerUnavailable, server
+    end
+
+    def report
+      address.partial_expand(
+        scheme: URI.parse(server).scheme,
+        host: URI.parse(server).host,
+        segments: ['trusted', ticket, 'views'],
+        report_path: path
+      )
+    end
+
+    def address
+      Addressable::Template.new('{scheme}://{host}{/segments*}/{+report_path}{?query*}')
+    end
+  end
+end

data/lib/tableau_trusted_interface/version.rb

@@ -0,0 +1,3 @@
+module TableauTrustedInterface
+  VERSION = '0.9.0'
+end

data/lib/tableau_trusted_interface.rb

@@ -0,0 +1,3 @@
+require 'tableau_trusted_interface/config'
+require 'tableau_trusted_interface/errors'
+require 'tableau_trusted_interface/report'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: tableau_trusted_interface
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Hugh Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Wrapper for embedding Tableau workbooks using the Tableau trusted interface.
+email: hugh@hughevans.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tableau_trusted_interface.rb
+- lib/tableau_trusted_interface/config.rb
+- lib/tableau_trusted_interface/errors.rb
+- lib/tableau_trusted_interface/report.rb
+- lib/tableau_trusted_interface/version.rb
+homepage: http://github.com/hughevans/tableau_trusted_interface
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for embedding Tableau workbooks using the Tableau trusted interface.
+test_files: []