tableau_api 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a147139944855ed7147760ceae5d65bcd5f6fb1c
-  data.tar.gz: ea08dc0b70183fc30620959fa255e041e6c318ea
+SHA256:
+  metadata.gz: 43cac99596054f87a1077b820a3b461fd8eda987d3ae4c785b50bfade19c9543
+  data.tar.gz: b1a031c5fb30bb1d59e5065ec0f044e8696784ddb673d106aa7f86442d783647
 SHA512:
-  metadata.gz: b60cbc7aec82d7a36868faadbe38f775786a67b84c809c2803e384424c877d6c22116b1da652d0634f57d731b0d99a2b3e69123d746499390e7e2a2c34d71a63
-  data.tar.gz: f36628abb279e8ca26aee9747a9fafb0ab29e41268b6787e2da9a90d2d4a116d3f18fd7d7ca6557481340a72aaf6a6306cb95f5ce6caf83a4ab274b2df17b994
+  metadata.gz: 4386b22e40f004915e66b4051c8de0ce50e6aa0a052f0471429d67a588b2c6d3effe85e5555675685ec2059e256297042a8773bbcf4c141827c7b5f8dd2770e1
+  data.tar.gz: 4afa373753b3647d72b755e5864e10ba7ddb0de4d2bb55637c3ed4bcc89c64728827285e3661c8e46fb36b4291cde2173c29ec30ab9ab763638c8d534a6bf437

data/.rubocop.yml

@@ -1,24 +1,25 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
-ClassLength:
-  Max: 200
+Gemspec/RequiredRubyVersion:
+  Enabled: false 
+
+Layout/LineLength:
+  Max: 170
 
 Style/Documentation:
   Enabled: false
 
-LineLength:
-  Max: 170
-
-MethodLength:
-  Max: 20
+Metrics/ClassLength:
+  Max: 200
 
 Metrics/AbcSize:
   Max: 40
 
-MethodLength:
+Metrics/MethodLength:
   Max: 30
 
 Metrics/BlockLength:

data/.ruby-version

@@ -1 +1 @@
-2.4.10
+3.2.1

data/.travis.yml

@@ -4,6 +4,6 @@ branches:
     - master
 language: ruby
 rvm:
-  - 2.6.6
-  - 2.5.8
-  - 2.4.10
+  - 3.2.1
+  - 3.1.3
+  - 2.7.0

data/CHANGELOG.md

@@ -7,6 +7,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+## [5.0.0] - 2023-03-23
+
+- Added support for Ruby 3
+- Bumped dev Ruby version to 3.2.1
+- Bumped minimum required Ruby version to 2.7.0
+- Bumped Rake version for development to 12.3.3
+- Bumped Rubocop version for development to 1.48.1
+- Bumped vcr version for development to 6.0
+- Bumped Travis matrix Ruby versions to 3.2.1, 3.0.5, and 2.7.0
+- Added Rubygems MFA requirement
+
 ## [4.1.0] - 2022-04-13
 
 - Specify major version number of ruby in Docker testing command in README

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tableau_api.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'tableau_api'

data/lib/tableau_api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   class Client
     attr_reader :host, :username, :password, :site_id, :site_name
@@ -6,12 +8,15 @@ module TableauApi
       @resources = {}
 
       raise 'host is required' if host.to_s.empty?
+
       @host = host
 
       raise 'site_name is required' if site_name.to_s.empty?
+
       @site_name = site_name
 
       raise 'username is required' if username.to_s.empty?
+
       @username = username
 
       @password = password

data/lib/tableau_api/connection.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module TableauApi
   class Connection
-    API_VERSION = '3.1'.freeze
+    API_VERSION = '3.1'
 
     include HTTParty
     headers 'User-Agent' => "tableau_api/#{::TableauApi::VERSION} Ruby/#{RUBY_VERSION}"
@@ -16,6 +18,7 @@ module TableauApi
     # if the result is paginated, it will fetch subsequent pages
     # collection can be delimited with a period to do nested hash lookups
     # e.g. objects.object
+    # rubocop:disable Metrics/CyclomaticComplexity
     def api_get_collection(path, collection, page_number: 1, page_size: 100, **kwargs)
       Enumerator.new do |enum|
         loop do
@@ -39,6 +42,7 @@ module TableauApi
         end
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def api_get(path, **kwargs)
       api_method(:get, path, kwargs)
@@ -75,9 +79,7 @@ module TableauApi
 
     def api_method(method, path, kwargs)
       # do not attach auth headers or attempt to signin if we're signing in
-      unless path == 'auth/signin'
-        new_headers = auth_headers(kwargs.fetch(:headers, {}))
-      end
+      new_headers = auth_headers(kwargs.fetch(:headers, {})) unless path == 'auth/signin'
       self.class.public_send(method, url_for(path), kwargs.merge(headers: new_headers))
     end
 

data/lib/tableau_api/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   class TableauError < StandardError
     attr_reader :http_response_code, :error_code, :summary, :detail

data/lib/tableau_api/resources/auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Auth < Base

data/lib/tableau_api/resources/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Base

data/lib/tableau_api/resources/datasources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Datasources < Base

data/lib/tableau_api/resources/groups.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Groups < Base

data/lib/tableau_api/resources/jobs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Jobs < Base

data/lib/tableau_api/resources/projects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Projects < Base

data/lib/tableau_api/resources/sites.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Sites < Base
@@ -23,12 +25,14 @@ module TableauApi
         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

data/lib/tableau_api/resources/users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
   module Resources
     class Users < Base
@@ -35,6 +37,7 @@ module TableauApi
         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|

data/lib/tableau_api/resources/workbooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zip'
 
 module TableauApi
@@ -55,10 +57,12 @@ module TableauApi
 
       CAPABILITY_MODES = %w[ALLOW DENY].freeze
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       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?
 
@@ -81,9 +85,10 @@ module TableauApi
           }
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # 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:)
+      def add_permissions(workbook_id:, capabilities:, user_id: nil, group_id: nil)
         validate_user_group_exclusivity(user_id, group_id)
 
         request = permissions_request(workbook_id, user_id, group_id, capabilities)
@@ -92,7 +97,7 @@ module TableauApi
         res.code == 200
       end
 
-      def delete_permissions(workbook_id:, user_id: nil, group_id: nil, capability:, capability_mode:)
+      def delete_permissions(workbook_id:, capability:, capability_mode:, user_id: nil, group_id: nil)
         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
@@ -155,6 +160,7 @@ module TableauApi
                 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

data/lib/tableau_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TableauApi
-  VERSION = '4.1.0'.freeze
+  VERSION = '5.0.0'
 end

data/lib/tableau_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'builder'
 require 'net/http/post/multipart'
@@ -19,8 +21,8 @@ require 'tableau_api/resources/jobs'
 
 module TableauApi
   class << self
-    def new(options = {})
-      Client.new(options)
+    def new(**options)
+      Client.new(**options)
     end
   end
 end

data/tableau_api.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tableau_api/version'
 
@@ -19,19 +19,20 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_dependency 'httparty', '~> 0.13'
   spec.add_dependency 'builder', '~> 3.2'
+  spec.add_dependency 'httparty', '~> 0.13'
   spec.add_dependency 'multipart-post', '~> 2.0'
   spec.add_dependency 'rubyzip', '~> 1.0'
 
-  spec.add_development_dependency 'rake', '~> 11.0'
-  spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'chunky_png', '~> 1.3.11'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
-  spec.add_development_dependency 'chunky_png', '~> 1.3.11'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 1.48.1'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: tableau_api
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Christopher Manning
 - Matt Brennan
 - Jonathan Cobian
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -69,118 +69,118 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 1.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: 1.3.11
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.48.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: chunky_png
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.11
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.11
-description: 
+        version: '3.0'
+description:
 email:
 - opensource@civisanalytics.com
 executables: []
@@ -219,25 +219,25 @@ files:
 homepage: https://github.com/civisanalytics/tableau_api
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Ruby interface to the Tableau API.
 test_files: []