googleauth 0.13.1 → 0.16.1

data/.rubocop.yml

@@ -15,5 +15,3 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Exclude:
     - "googleauth.gemspec"
-Style/SafeNavigation:
-  Enabled: false

data/.toys/.toys.rb

@@ -0,0 +1,45 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+expand :clean, paths: :gitignore
+
+expand :rspec do |t|
+  t.libs = ["lib", "spec"]
+  t.use_bundler
+end
+
+expand :minitest do |t|
+  t.libs = ["lib", "test"]
+  t.use_bundler
+  t.files = "test/**/*_test.rb"
+end
+
+expand :minitest do |t|
+  t.name = "integration"
+  t.libs = ["lib", "integration"]
+  t.use_bundler
+  t.files = "integration/**/*_test.rb"
+end
+
+expand :rubocop, bundler: true
+
+expand :yardoc do |t|
+  t.generate_output_flag = true
+  # t.fail_on_warning = true
+  t.use_bundler
+end
+
+expand :gem_build
+
+expand :gem_build, name: "install", install_gem: true

data/.toys/ci.rb

@@ -0,0 +1,43 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+desc "Run CI checks"
+
+TESTS = ["test", "integration", "spec", "rubocop", "yardoc", "build", "linkinator"]
+
+flag :only
+TESTS.each do |name|
+  flag "include_#{name}".to_sym, "--[no-]include-#{name}"
+end
+
+include :exec, result_callback: :handle_result
+include :terminal
+
+def handle_result result
+  if result.success?
+    puts "** #{result.name} passed\n\n", :green, :bold
+  else
+    puts "** CI terminated: #{result.name} failed!", :red, :bold
+    exit 1
+  end
+end
+
+def run
+  ::Dir.chdir context_directory
+  TESTS.each do |name|
+    setting = get "include_#{name}".to_sym
+    setting = !only if setting.nil?
+    exec ["toys", name], name: name.capitalize if setting
+  end
+end

data/.toys/kokoro/.toys.rb

@@ -0,0 +1,66 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+mixin "kokoro-tools" do
+  def load_env
+    return if defined? @loaded_env
+
+    service_account = "#{::ENV['KOKORO_GFILE_DIR']}/service-account.json"
+    raise "#{service_account} is not a file" unless ::File.file? service_account
+    ::ENV["GOOGLE_APPLICATION_CREDENTIALS"] = service_account
+
+    filename = "#{::ENV['KOKORO_GFILE_DIR']}/ruby_env_vars.json"
+    raise "#{filename} is not a file" unless ::File.file? filename
+    env_vars = ::JSON.parse ::File.read filename
+    env_vars.each { |k, v| ::ENV[k] = v }
+
+    ::ENV["DOCS_CREDENTIALS"] ||= "#{::ENV['KOKORO_KEYSTORE_DIR']}/73713_docuploader_service_account"
+    ::ENV["GITHUB_TOKEN"] ||= "#{::ENV['KOKORO_KEYSTORE_DIR']}/73713_yoshi-automation-github-key"
+
+    @loaded_env = true
+  end
+
+  def package_name
+    @package_name ||=
+      ::ENV["RELEASE_PACKAGE"] || ::ENV["PACKAGE"] || begin
+        files = ::Dir.glob("*.gemspec")
+        raise "Unable to determine package" unless files.length == 1
+        ::File.basename files.first, ".gemspec"
+      end
+  end
+
+  def package_directory
+    @package_directory ||= begin
+      if ::File.file? "#{package_name}.gemspec"
+        ::File.expand_path "."
+      elsif ::File.file? "#{package_name}/#{package_name}.gemspec"
+        ::File.expand_path package_name
+      else
+        raise "Unable to determine package directory"
+      end
+    end
+  end
+
+  def package_gemspec_path
+    @package_gemspec_path ||= ::File.join package_directory, "#{package_name}.gemspec"
+  end
+
+  def package_gemspec
+    @package_gemspec ||= eval ::File.read package_gemspec_path
+  end
+
+  def package_version
+    @package_version ||= package_gemspec.version
+  end
+end

data/.toys/kokoro/publish-docs.rb

@@ -0,0 +1,67 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "json"
+
+include "kokoro-tools"
+include :exec, e: true
+include :fileutils
+
+flag :credentials, "--credentials=PATH"
+flag :bucket, "--bucket=NAME"
+flag :dry_run, default: ["true", "docs"].include?(::ENV["RELEASE_DRY_RUN"].to_s)
+
+def run
+  ::Dir.chdir package_directory
+  load_env
+  build_docs
+  write_metadata
+  if dry_run
+    puts "DRY RUN: Skipping doc uploading for #{package_name}"
+  else
+    upload_docs
+  end
+end
+
+def build_docs
+  rm_rf "doc"
+  exec ["toys", "yardoc"]
+end
+
+def write_metadata
+  allowed_fields = [
+    "name", "version", "language", "distribution-name",
+    "product-page", "github-repository", "issue-tracker"
+  ]
+  metadata = ::JSON.parse ::File.read ".repo-metadata.json"
+  metadata.transform_keys! { |k| k.tr "_", "-" }
+  metadata.keep_if { |k, _v| allowed_fields.include? k }
+  metadata["version"] = package_version
+  metadata["name"] = metadata["distribution-name"]
+  args = metadata.transform_keys { |k| "--#{k}" }.to_a.flatten
+  cmd = ["python3", "-m", "docuploader", "create-metadata"] + args
+  exec cmd, chdir: "doc"
+end
+
+def upload_docs
+  creds = credentials || "#{::ENV['KOKORO_KEYSTORE_DIR']}/73713_docuploader_service_account"
+  buck = bucket || ::ENV["STAGING_BUCKET"] || "docs-staging"
+  cmd = [
+    "python3", "-m", "docuploader", "upload", ".",
+    "--credentials=#{creds}",
+    "--staging-bucket=#{buck}",
+    "--metadata-file=./docs.metadata"
+  ]
+  exec cmd, chdir: "doc"
+end

data/.toys/kokoro/publish-gem.rb

@@ -0,0 +1,53 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+include "kokoro-tools"
+include :exec, e: true
+include :fileutils
+include :gems
+
+flag :rubygems_token, "--rubygems-token=TOKEN"
+flag :dry_run, default: ["true", "gem"].include?(::ENV["RELEASE_DRY_RUN"].to_s)
+
+def run
+  gem "gems", "~> 1.2"
+  require "gems"
+  ::Dir.chdir package_directory
+  load_env
+  configure_gems
+  gem_path = build_gem
+  if dry_run
+    puts "DRY RUN: Skipping Rubygems push of #{gem_path}"
+  else
+    push_gem gem_path
+  end
+end
+
+def configure_gems
+  token = rubygems_token || ::ENV["RUBYGEMS_API_TOKEN"]
+  ::Gems.configure { |config| config.key = token } if token
+end
+
+def build_gem
+  gem_path = "pkg/#{package_name}-#{package_version}.gem"
+  rm_rf gem_path
+  exec ["toys", "build"]
+  gem_path
+end
+
+def push_gem gem_path
+  response = ::Gems.push ::File.new gem_path
+  puts response
+  raise "Gem push didn't report success" unless response.include? "Successfully registered gem:"
+end

data/.toys/linkinator.rb

@@ -0,0 +1,43 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+desc "Run Link checks"
+
+flag :install, desc: "Install linkinator instead of running checks"
+
+include :exec, e: true
+include :terminal
+
+def run
+  ::Dir.chdir context_directory
+  if install
+    Kernel.exec "npm install linkinator"
+  else
+    exec_tool ["yardoc"]
+    check_links
+  end
+end
+
+def check_links
+  result = exec ["npx", "linkinator", "./doc"], out: :capture
+  puts result.captured_out
+  checked_links = result.captured_out.split "\n"
+  checked_links.select! { |link| link =~ /^\[(\d+)\]/ && ::Regexp.last_match[1] != "200" }
+  unless checked_links.empty?
+    checked_links.each do |link|
+      puts link, :yellow
+    end
+    exit 1
+  end
+end

data/.trampolinerc

@@ -0,0 +1,48 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Add required env vars here.
+required_envvars+=(
+)
+
+# Add env vars which are passed down into the container here.
+pass_down_envvars+=(
+    "AUTORELEASE_PR" "RELEASE_DRY_RUN"
+)
+
+# Prevent unintentional override on the default image.
+if [[ "${TRAMPOLINE_IMAGE_UPLOAD:-false}" == "true" ]] && [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
+    echo "Please set TRAMPOLINE_IMAGE if you want to upload the Docker image."
+    exit 1
+fi
+
+# Define the default value if it makes sense.
+if [[ -z "${TRAMPOLINE_IMAGE_UPLOAD:-}" ]]; then
+    TRAMPOLINE_IMAGE_UPLOAD=""
+fi
+
+if [[ -z "${TRAMPOLINE_IMAGE:-}" ]]; then
+    TRAMPOLINE_IMAGE=""
+fi
+
+if [[ -z "${TRAMPOLINE_DOCKERFILE:-}" ]]; then
+    TRAMPOLINE_DOCKERFILE=""
+fi
+
+if [[ -z "${TRAMPOLINE_BUILD_FILE:-}" ]]; then
+    TRAMPOLINE_BUILD_FILE=""
+fi
+
+# Secret Manager secrets.
+source ${PROJECT_ROOT}/.kokoro/populate-secrets.sh

data/CHANGELOG.md

@@ -1,25 +1,65 @@
 # Release History
 
-### 0.13.1 / 2020-07-30
+### [0.16.1](https://www.github.com/googleapis/google-auth-library-ruby/compare/google-auth-library-ruby/v0.16.0...google-auth-library-ruby/v0.16.1) (2021-04-01)
+
+
+### Bug Fixes
+
+* Accept application/text content-type for plain idtoken response ([4948ebb](https://www.github.com/googleapis/google-auth-library-ruby/commit/4948ebb3ca151e9f0433585a41bad6f415416b2d))
+
+## [0.16.0](https://www.github.com/googleapis/google-auth-library-ruby/compare/v0.15.1...v0.16.0) (2021-03-04)
+
+
+### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0 ([6644806](https://www.github.com/googleapis/google-auth-library-ruby/commit/6644806ab47cea6d08e1901c2ed808e53a579bc3))
+
+## [0.15.1](https://www.github.com/googleapis/google-auth-library-ruby/compare/v0.15.0...v0.15.1) (2021-02-08)
+
+
+### Bug Fixes
+
+* Fix crash when using a client credential without any paths or env_vars set ([#296](https://www.github.com/googleapis/google-auth-library-ruby/issues/296)) ([c971c1a](https://www.github.com/googleapis/google-auth-library-ruby/commit/c971c1ad2d7730c0f5b389d533a972be32fbaf49))
+
+## [0.15.0](https://www.github.com/googleapis/google-auth-library-ruby/compare/v0.14.0...v0.15.0) (2021-01-26)
+
+
+### Features
+
+* Credential parameters inherit from superclasses ([4fa4720](https://www.github.com/googleapis/google-auth-library-ruby/commit/4fa47206dbd62f8bbdd1b9d3721f6baee9fd1d62))
+* Service accounts apply a self-signed JWT if scopes are marked as default ([d22acb8](https://www.github.com/googleapis/google-auth-library-ruby/commit/d22acb8a510e6711b5674545c31a4816e5a9168f))
+
+
+### Bug Fixes
+
+* Retry fetch_access_token when GCE metadata server returns unexpected errors ([cd9b012](https://www.github.com/googleapis/google-auth-library-ruby/commit/cd9b0126d3419b9953982f71edc9e6ba3f640e3c))
+* Support correct service account and user refresh behavior for custom credential env variables ([d2dffe5](https://www.github.com/googleapis/google-auth-library-ruby/commit/d2dffe592112b45006291ad9a57f56e00fb208c3))
+
+## 0.14.0 / 2020-10-09
+
+* Honor GCE_METADATA_HOST environment variable
+* Fix errors in some environments when requesting an access token for multiple scopes
+
+## 0.13.1 / 2020-07-30
 
 * Support scopes when using GCE Metadata Server authentication ([@ball-hayden][])
 
-### 0.13.0 / 2020-06-17
+## 0.13.0 / 2020-06-17
 
 * Support for validating ID tokens.
 * Fixed header application of ID tokens from service accounts.
 
-### 0.12.0 / 2020-04-08
+## 0.12.0 / 2020-04-08
 
 * Support for ID token credentials.
 * Support reading quota_id_project from service account credentials.
 
-### 0.11.0 / 2020-02-24
+## 0.11.0 / 2020-02-24
 
 * Support Faraday 1.x.
 * Allow special "postmessage" value for redirect_uri.
 
-### 0.10.0 / 2019-10-09
+## 0.10.0 / 2019-10-09
 
 Note: This release now requires Ruby 2.4 or later
 
@@ -29,7 +69,7 @@ Note: This release now requires Ruby 2.4 or later
 * Set instance variables at initialization to avoid spamming warnings
 * Pass "Metadata-Flavor" header to metadata server when checking for GCE
 
-### 0.9.0 / 2019-08-05
+## 0.9.0 / 2019-08-05
 
 * Restore compatibility with Ruby 2.0. This is the last release that will work on end-of-lifed versions of Ruby. The 0.10 release will require Ruby 2.4 or later.
 * Update Credentials to use methods for values that are intended to be changed by users, replacing constants.
@@ -38,79 +78,79 @@ Note: This release now requires Ruby 2.4 or later
 * Add verbosity none to gcloud command
 * Make arity of WebUserAuthorizer#get_credentials compatible with the base class
 
-### 0.8.1 / 2019-03-27
+## 0.8.1 / 2019-03-27
 
 * Silence unnecessary gcloud warning
 * Treat empty credentials environment variables as unset
 
-### 0.8.0 / 2019-01-02
+## 0.8.0 / 2019-01-02
 
 * Support connection options :default_connection and :connection_builder when creating credentials that need to refresh OAuth tokens. This lets clients provide connection objects with custom settings, such as proxies, needed for the client environment.
 * Removed an unnecessary warning about project IDs.
 
-### 0.7.1 / 2018-10-25
+## 0.7.1 / 2018-10-25
 
 * Make load_gcloud_project_id module function.
 
-### 0.7.0 / 2018-10-24
+## 0.7.0 / 2018-10-24
 
 * Add project_id instance variable to UserRefreshCredentials, ServiceAccountCredentials, and Credentials.
 
-### 0.6.7 / 2018-10-16
+## 0.6.7 / 2018-10-16
 
 * Update memoist dependency to ~> 0.16.
 
-### 0.6.6 / 2018-08-22
+## 0.6.6 / 2018-08-22
 
 * Remove ruby version warnings.
 
-### 0.6.5 / 2018-08-16
+## 0.6.5 / 2018-08-16
 
 * Fix incorrect http verb when revoking credentials.
 * Warn on EOL ruby versions.
 
-### 0.6.4 / 2018-08-03
+## 0.6.4 / 2018-08-03
 
 * Resolve issue where DefaultCredentials constant was undefined.
 
-### 0.6.3 / 2018-08-02
+## 0.6.3 / 2018-08-02
 
 * Resolve issue where token_store was being written to twice
 
-### 0.6.2 / 2018-08-01
+## 0.6.2 / 2018-08-01
 
 * Add warning when using cloud sdk credentials
 
-### 0.6.1 / 2017-10-18
+## 0.6.1 / 2017-10-18
 
 * Fix file permissions
 
-### 0.6.0 / 2017-10-17
+## 0.6.0 / 2017-10-17
 
 * Support ruby-jwt 2.0
 * Add simple credentials class
 
-### 0.5.3 / 2017-07-21
+## 0.5.3 / 2017-07-21
 
 * Fix file permissions on the gem's `.rb` files.
 
-### 0.5.2 / 2017-07-19
+## 0.5.2 / 2017-07-19
 
 * Add retry mechanism when fetching access tokens in `GCECredentials` and `UserRefreshCredentials` classes.
 * Update Google API OAuth2 token credential URI to v4.
 
-### 0.5.1 / 2016-01-06
+## 0.5.1 / 2016-01-06
 
 * Change header name emitted by `Client#apply` from "Authorization" to "authorization" ([@murgatroid99][])
 * Fix ADC not working on some windows machines ([@vsubramani][])
 [#55](https://github.com/google/google-auth-library-ruby/issues/55)
 
-### 0.5.0 / 2015-10-12
+## 0.5.0 / 2015-10-12
 
 * Initial support for user credentials ([@sqrrrl][])
 * Update Signet to 0.7
 
-### 0.4.2 / 2015-08-05
+## 0.4.2 / 2015-08-05
 
 * Updated UserRefreshCredentials hash to use string keys ([@haabaato][])
 [#36](https://github.com/google/google-auth-library-ruby/issues/36)
@@ -127,16 +167,16 @@ Note: This release now requires Ruby 2.4 or later
 * Enables passing credentials via environment variables. ([@haabaato][])
 [#27](https://github.com/google/google-auth-library-ruby/issues/27)
 
-### 0.4.1 / 2015-04-25
+## 0.4.1 / 2015-04-25
 
 * Improves handling of --no-scopes GCE authorization ([@tbetbetbe][])
 * Refactoring and cleanup ([@joneslee85][])
 
-### 0.4.0 / 2015-03-25
+## 0.4.0 / 2015-03-25
 
 * Adds an implementation of JWT header auth ([@tbetbetbe][])
 
-### 0.3.0 / 2015-03-23
+## 0.3.0 / 2015-03-23
 
 * makes the scope parameter's optional in all APIs. ([@tbetbetbe][])
 * changes the scope parameter's position in various constructors. ([@tbetbetbe][])