tableau_api 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30da344a82d4ce33c21a5e921b40b9efbdc4493c
-  data.tar.gz: 97271bab0ec0bbc33a94cbbe60e3af0aa9e48f70
+  metadata.gz: 79d15e26e8441669e7c04c13794a049dc968d69e
+  data.tar.gz: 05e49453e17574474a356d20cb21fc0ce094e6e0
 SHA512:
-  metadata.gz: a340b001cd5d0ffbb75707fc2059f65342424d696e8cb5851f5078f9b9ad6ac641437e20816f7abf6bdece110681cc1993528397eafa34918dd37ab3215542e4
-  data.tar.gz: 33ee40ceee96a90680e7daaa1b87acd96cdbb99d24644854818f1d363b184d3717da4e00879b2e8d60915059829ff66eb30f515f665cc34c76371caf7098e709
+  metadata.gz: 8e69aba0b041e655e0e93b1fc0de62f069c966148675b755365bac2572a01dd78fbc322ce1020e1e588bef1600a554e77b8e54089c5936390573d3bb0137d018
+  data.tar.gz: ca5ebe0289ac4af7c5ccf6c0e1945ce61f01d693b31f027cf1ed8baafcfbf7e980042afb09167c48befbf074a1a46e1d003367d1565fc30ede71cee7f2884957

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.2
 
+ClassLength:
+  Max: 200
+
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.2.5
+2.4.1

data/.travis.yml

@@ -4,6 +4,7 @@ branches:
     - master
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2.5
-  - 2.1.9
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
+  - 2.1.10

data/CHANGELOG.md

@@ -1,12 +1,69 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-## [1.0.0] - 2016-06-06
+## [1.1.2] - 2017-05-24
+
+### Fixed
+
+- Replaced corrupt `.gem` upload to RubyGems
+
+## [1.1.1] - 2017-05-24 - [YANKED]
+
+### Added
+
+- Added Ruby 2.4.1 to the Travis matrix build
+
+### Changed
+
+- Bumped the Ruby versions in the Travis matrix build to 2.3.4, 2.2.7, and
+  2.1.10
+- Bumped the Ruby version for development to 2.4.1
+- Bumped the RSpec version for development to 3.6
+- Bumped the WebMock version for development to 3.0
+- Updated the authors
+
+### Fixed
+
+- Updated `TableauApi::VERSION`
+
+## [1.1.0] - 2017-03-02
+
 ### Added
+
+- [#2](https://github.com/civisanalytics/tableau_api/pull/2)
+  - `TableauApi::Resources::Groups` added to support API calls for
+    adding/deleting/updating groups.
+  - `TableauApi::Resources::Workbook#remove_permissions` added, including
+    support for user and group permissions.
+  - `TableauApi::Resources::Workbook#add_permissions` supports group
+    permissions.
+- [#6](https://github.com/civisanalytics/tableau_api/pull/6)
+  Added `Users#update_user`
+- [#7](https://github.com/civisanalytics/tableau_api/pull/7)
+  Added `Sites#create` and `Sites#delete`
+
+### Changed
+
+- [#3](https://github.com/civisanalytics/tableau_api/pull/3)
+  `TableauApi::Resources::Workbook#permissions` now returns existing permissions
+  instead of adding new permissions. New permissions can be added with
+  `TableauApi::Resources::Workbook#add_permissions`.
+
+### Fixed
+
+- [#4](https://github.com/civisanalytics/tableau_api/pull/4)
+  Always parse/return workbook permissions as an array
+
+## [1.0.0] - 2016-06-06
+
 - Initial Release
 
-[Unreleased]: https://github.com/civisanalytics/tableau_api/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/civisanalytics/tableau_api/compare/v1.1.2...HEAD
+[1.1.2]: https://github.com/civisanalytics/tableau_api/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/civisanalytics/tableau_api/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/civisanalytics/tableau_api/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/civisanalytics/tableau_api/tree/v1.0.0

data/README.md

@@ -60,6 +60,10 @@ docker exec -it CONTAINER_ID /bin/bash -c "cd /src && bundle && rake"
 
 ### Creating New VCR Cassettes
 
+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.
+
 Set the environment variables below to an administrator account, create a tunnel
 to your tableau server on port 2000, then run the commands below.
 

data/lib/tableau_api.rb

@@ -10,6 +10,7 @@ require 'tableau_api/resources/auth'
 require 'tableau_api/resources/projects'
 require 'tableau_api/resources/sites'
 require 'tableau_api/resources/users'
+require 'tableau_api/resources/groups'
 require 'tableau_api/resources/workbooks'
 require 'tableau_api/version'
 

data/lib/tableau_api/client.rb

@@ -27,6 +27,7 @@ module TableauApi
         projects: TableauApi::Resources::Projects,
         sites: TableauApi::Resources::Sites,
         users: TableauApi::Resources::Users,
+        groups: TableauApi::Resources::Groups,
         workbooks: TableauApi::Resources::Workbooks
       }
     end
@@ -39,5 +40,9 @@ module TableauApi
         super
       end
     end
+
+    def respond_to_missing?(name, include_private = false)
+      self.class.resources.keys.include?(name) || super
+    end
   end
 end

data/lib/tableau_api/connection.rb

@@ -28,7 +28,7 @@ module TableauApi
           raise TableauError, res if res.code.to_s != '200'
 
           # ensure the result is an array because it will not be an array if there is only one element
-          [collection.split('.').reduce(res['tsResponse']) { |a, e| a && a[e] }].flatten.compact.each do |obj|
+          [collection.split('.').reduce(res['tsResponse']) { |acc, elem| acc && acc[elem] }].flatten.compact.each do |obj|
             enum.yield obj
           end
 
@@ -52,6 +52,10 @@ module TableauApi
       api_method(:put, path, *args)
     end
 
+    def api_delete(path, *args)
+      api_method(:delete, path, *args)
+    end
+
     def api_post_multipart(path, parts, headers)
       headers = auth_headers(headers)
       headers['Content-Type'] = 'multipart/mixed'
@@ -60,7 +64,7 @@ module TableauApi
 
       req = Net::HTTP::Post::Multipart.new(uri.to_s, parts, headers)
 
-      Net::HTTP.start(uri.host, uri.port) do |http|
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         http.request(req)
       end
     end

data/lib/tableau_api/resources/groups.rb

@@ -0,0 +1,43 @@
+module TableauApi
+  module Resources
+    class Groups < Base
+      def create(name:, default_site_role: 'Viewer')
+        raise 'invalid default_site_role' unless Users::SITE_ROLES.include? default_site_role
+
+        request = Builder::XmlMarkup.new.tsRequest do |ts|
+          ts.group(name: name, defaultSiteRole: default_site_role)
+        end
+
+        res = @client.connection.api_post("sites/#{@client.auth.site_id}/groups", body: request)
+
+        res['tsResponse']['group'] if res.code == 201
+      end
+
+      def list
+        url = "sites/#{@client.auth.site_id}/groups"
+        @client.connection.api_get_collection(url, 'groups.group')
+      end
+
+      def users(group_id:)
+        url = "sites/#{@client.auth.site_id}/groups/#{group_id}/users"
+        @client.connection.api_get_collection(url, 'users.user')
+      end
+
+      def add_user(group_id:, user_id:)
+        request = Builder::XmlMarkup.new.tsRequest do |ts|
+          ts.user(id: user_id)
+        end
+
+        res = @client.connection.api_post("sites/#{@client.auth.site_id}/groups/#{group_id}/users", body: request)
+
+        res.code == 200
+      end
+
+      def remove_user(group_id:, user_id:)
+        res = @client.connection.api_delete("sites/#{@client.auth.site_id}/groups/#{group_id}/users/#{user_id}")
+
+        res.code == 204
+      end
+    end
+  end
+end

data/lib/tableau_api/resources/sites.rb

@@ -4,6 +4,33 @@ module TableauApi
       def list
         @client.connection.api_get_collection('sites', 'sites.site')
       end
+
+      def create(name:, content_url:, admin_mode: nil, num_users: nil, storage_quota: nil)
+        # required parameters
+        request_hash = {
+          name: name,
+          contentUrl: content_url
+        }
+        # optional parameters
+        request_hash[:admin_mode] = admin_mode if admin_mode
+        request_hash[:num_users] = num_users if num_users
+        request_hash[:storage_quota] = storage_quota if storage_quota
+
+        request = Builder::XmlMarkup.new.tsRequest do |ts|
+          ts.site(request_hash)
+        end
+
+        res = @client.connection.api_post('sites', body: request)
+
+        return res['tsResponse']['site'] if res.code == 201
+        raise TableauError, res
+      end
+
+      def delete(site_id:)
+        res = @client.connection.api_delete("sites/#{site_id}")
+        return true if res.code == 204
+        raise TableauError, res
+      end
     end
   end
 end

data/lib/tableau_api/resources/users.rb

@@ -27,6 +27,23 @@ module TableauApi
         url = "sites/#{@client.auth.site_id}/users"
         @client.connection.api_get_collection(url, 'users.user')
       end
+
+      def update_user(user_id:, site_role:)
+        raise 'invalid site_role' unless SITE_ROLES.include? site_role
+
+        res = @client.connection.api_get("sites/#{@client.auth.site_id}/users/#{user_id}")
+
+        raise 'failed to find user' if res.code != 200
+        user = res['tsResponse']['user']
+
+        request = Builder::XmlMarkup.new.tsRequest do |ts|
+          ts.user(name: user['name'], siteRole: site_role)
+        end
+
+        res = @client.connection.api_put("sites/#{@client.auth.site_id}/users/#{user_id}", body: request)
+
+        res['tsResponse']['user'] if res.code == 200
+      end
     end
   end
 end

data/lib/tableau_api/resources/workbooks.rb

@@ -53,29 +53,57 @@ module TableauApi
         Filter Read ShareView ViewComments ViewUnderlyingData WebAuthoring Write
       ).freeze
 
-      # capabilities is a hash of symbol keys to booleans { Read: true, ChangePermissions: false }
-      def permissions(workbook_id:, user_id:, capabilities:)
-        request = Builder::XmlMarkup.new.tsRequest do |ts|
-          ts.permissions do |p|
-            p.workbook(id: workbook_id)
-            p.granteeCapabilities do |gc|
-              gc.user(id: user_id)
-              gc.capabilities do |c|
-                capabilities.each do |k, v|
-                  k = k.to_s
-                  raise "invalid capability #{k}" unless CAPABILITIES.include? k
-                  c.capability(name: k, mode: v ? 'Allow' : 'Deny')
-                end
-              end
-            end
+      CAPABILITY_MODES = %w(ALLOW DENY).freeze
+
+      def permissions(workbook_id:)
+        res = @client.connection.api_get("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/permissions")
+
+        raise TableauError, res if res.code != 200
+        permissions = HTTParty::Parser.new(res.body, :xml).parse['tsResponse']['permissions']['granteeCapabilities']
+        return [] if permissions.nil?
+
+        permissions = [permissions] unless permissions.is_a? Array
+        permissions.map do |p|
+          grantee_type = p['group'].nil? ? 'user' : 'group'
+
+          capabilities = {}
+          capabilities_list = p['capabilities']['capability']
+          capabilities_list = [capabilities_list] unless capabilities_list.is_a? Array
+
+          capabilities_list.each do |c|
+            capabilities[c['name'].to_sym] = c['mode'] == 'Allow'
           end
+
+          {
+            grantee_type: grantee_type,
+            grantee_id: p[grantee_type]['id'],
+            capabilities: capabilities
+          }
         end
+      end
+
+      # capabilities is a hash of symbol keys to booleans { Read: true, ChangePermissions: false }
+      def add_permissions(workbook_id:, user_id: nil, group_id: nil, capabilities:)
+        validate_user_group_exclusivity(user_id, group_id)
 
+        request = permissions_request(workbook_id, user_id, group_id, capabilities)
         res = @client.connection.api_put("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/permissions", body: request)
 
         res.code == 200
       end
 
+      def delete_permissions(workbook_id:, user_id: nil, group_id: nil, capability:, capability_mode:)
+        validate_user_group_exclusivity(user_id, group_id)
+        raise 'invalid capability' unless CAPABILITIES.include? capability.to_s
+        raise 'invalid mode' unless CAPABILITY_MODES.include? capability_mode.to_s
+
+        subpath = user_id ? "users/#{user_id}" : "groups/#{group_id}"
+        subpath += "/#{capability}/#{capability_mode}"
+        res = @client.connection.api_delete("sites/#{@client.auth.site_id}/workbooks/#{workbook_id}/permissions/#{subpath}")
+
+        res.code == 204
+      end
+
       def update(workbook_id:, owner_user_id:)
         request = Builder::XmlMarkup.new.tsRequest do |ts|
           ts.workbook(id: workbook_id) do |w|
@@ -102,6 +130,32 @@ module TableauApi
         url = "sites/#{@client.auth.site_id}/users/#{@client.auth.user_id}/workbooks"
         @client.connection.api_get_collection(url, 'workbooks.workbook')
       end
+
+      private
+
+      def permissions_request(workbook_id, user_id, group_id, capabilities)
+        Builder::XmlMarkup.new.tsRequest do |ts|
+          ts.permissions do |p|
+            p.workbook(id: workbook_id)
+            p.granteeCapabilities do |gc|
+              gc.user(id: user_id) if user_id
+              gc.group(id: group_id) if group_id
+              gc.capabilities do |c|
+                capabilities.each do |k, v|
+                  k = k.to_s
+                  raise "invalid capability #{k}" unless CAPABILITIES.include? k
+                  c.capability(name: k, mode: v ? 'Allow' : 'Deny')
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def validate_user_group_exclusivity(user_id, group_id)
+        raise 'cannot specify user_id and group_id simultaneously' if user_id && group_id
+        raise 'must specify user_id or group_id' unless user_id || group_id
+      end
     end
   end
 end

data/lib/tableau_api/version.rb

@@ -1,3 +1,3 @@
 module TableauApi
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/tableau_api.gemspec

@@ -6,7 +6,8 @@ require 'tableau_api/version'
 Gem::Specification.new do |spec|
   spec.name          = 'tableau_api'
   spec.version       = TableauApi::VERSION
-  spec.authors       = ['Christopher Manning']
+  spec.authors       = ['Christopher Manning', 'Matt Brennan',
+                        'Jonathan Cobian']
   spec.email         = ['opensource@civisanalytics.com']
 
   spec.summary       = 'Ruby interface to the Tableau 9.0 API.'
@@ -26,10 +27,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 11.0'
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 1.24'
+  spec.add_development_dependency 'webmock', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'rubocop', '~> 0.46.0'
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: tableau_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Christopher Manning
+- Matt Brennan
+- Jonathan Cobian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -100,14 +102,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +130,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +172,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: 0.46.0
 description: 
 email:
 - opensource@civisanalytics.com
@@ -204,6 +206,7 @@ files:
 - lib/tableau_api/error.rb
 - lib/tableau_api/resources/auth.rb
 - lib/tableau_api/resources/base.rb
+- lib/tableau_api/resources/groups.rb
 - lib/tableau_api/resources/projects.rb
 - lib/tableau_api/resources/sites.rb
 - lib/tableau_api/resources/users.rb
@@ -230,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the Tableau 9.0 API.