feat(core): Support for universe_domain (#17131)

Author: dazuma

google-apis-core/google-apis-core.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "retriable", ">= 2.0", "< 4.a"
   gem.add_runtime_dependency "addressable", "~> 2.5", ">= 2.5.1"
   gem.add_runtime_dependency "mini_mime", "~> 1.0"
-  gem.add_runtime_dependency "googleauth", ">= 0.16.2", "< 2.a"
+  gem.add_runtime_dependency "googleauth", "~> 1.9"
   gem.add_runtime_dependency "httpclient", ">= 2.8.1", "< 3.a"
   gem.add_runtime_dependency "rexml"
 end

google-apis-core/lib/google/apis/core/base_service.rb

@@ -93,11 +93,49 @@ def each
       # Base service for all APIs. Not to be used directly.
       #
       class BaseService
+        ##
+        # A substitution string for the universe domain in an endpoint template
+        # @return [String]
+        #
+        ENDPOINT_SUBSTITUTION = "$UNIVERSE_DOMAIN$".freeze
+
         include Logging
 
+        # Universe domain
+        # @return [String]
+        attr_reader :universe_domain
+
+        # Set the universe domain.
+        # If the root URL was set with a universe domain substitution, it is
+        # updated to reflect the new universe domain.
+        #
+        # @param new_ud [String,nil] The new universe domain, or nil to use the Google Default Universe
+        def universe_domain= new_ud
+          new_ud ||= ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] || "googleapis.com"
+          if @root_url_template
+            @root_url = @root_url_template.gsub ENDPOINT_SUBSTITUTION, new_ud
+          end
+          @universe_domain = new_ud
+        end
+
         # Root URL (host/port) for the API
         # @return [Addressable::URI]
-        attr_accessor :root_url
+        attr_reader :root_url
+
+        # Set the root URL.
+        # If the given url includes a universe domain substitution, it is
+        # resolved in the current universe domain
+        #
+        # @param url_or_template [String] The URL, which can include a universe domain substitution
+        def root_url= url_or_template
+          if url_or_template.include? ENDPOINT_SUBSTITUTION
+            @root_url_template = url_or_template
+            @root_url = url_or_template.gsub ENDPOINT_SUBSTITUTION, universe_domain
+          else
+            @root_url_template = nil
+            @root_url = url_or_template
+          end
+        end
 
         # Additional path prefix for all API methods
         # @return [Addressable::URI]
@@ -136,7 +174,9 @@ class BaseService
         # @param [String,Addressable::URI] base_path
         #   Additional path prefix for all API methods
         # @api private
-        def initialize(root_url, base_path, client_name: nil, client_version: nil)
+        def initialize(root_url, base_path, client_name: nil, client_version: nil, universe_domain: nil)
+          @root_url_template = nil
+          self.universe_domain = universe_domain
           self.root_url = root_url
           self.base_path = base_path
           self.client_name = client_name || 'google-api-ruby-client'

google-apis-core/spec/google/apis/core/service_spec.rb

@@ -22,6 +22,7 @@
 
   let(:client_version) { "1.2.3" }
   let(:service) { Google::Apis::Core::BaseService.new('https://www.googleapis.com/', '', client_version: client_version) }
+  let(:service_ud) { Google::Apis::Core::BaseService.new('https://www.$UNIVERSE_DOMAIN$/', '', client_version: client_version) }
   let(:service_with_base_path) { Google::Apis::Core::BaseService.new('https://www.googleapis.com/', 'my_service/v1/', client_version: client_version) }
   let(:x_goog_api_client_value) { "gl-ruby/#{RUBY_VERSION} gdcl/#{client_version}" }
 
@@ -477,4 +478,57 @@
       end
     end
   end
+
+  it "should default to the global universe domain" do
+    expect(service_ud.universe_domain).to eql "googleapis.com"
+  end
+
+  it "should default to a universe domain from the environment" do
+    ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] = "mydomain1.com"
+    expect(service_ud.universe_domain).to eql "mydomain1.com"
+  ensure
+    ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] = nil
+  end
+
+  it "should support setting universe domain" do
+    service_ud.universe_domain = "mydomain2.com"
+    expect(service_ud.universe_domain).to eql "mydomain2.com"
+  end
+
+  it "should support setting universe domain to nil" do
+    service_ud.universe_domain = "mydomain2.com"
+    service_ud.universe_domain = nil
+    expect(service_ud.universe_domain).to eql "googleapis.com"
+  end
+
+  it "should update root url when universe domain is set" do
+    service_ud.universe_domain = "mydomain3.com"
+    expect(service_ud.root_url).to eql "https://www.mydomain3.com/"
+  end
+
+  it "should initialize root url using the universe domain" do
+    ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] = "mydomain4.com"
+    expect(service_ud.root_url).to eql "https://www.mydomain4.com/"
+  ensure
+    ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] = nil
+  end
+
+  it "should initialize root url with a static value" do
+    expect(service.root_url).to eql "https://www.googleapis.com/"
+  end
+
+  it "should initialize root url with a dynamic value" do
+    expect(service_ud.root_url).to eql "https://www.googleapis.com/"
+  end
+
+  it "should suppport setting root url to a static value" do
+    service_ud.root_url = "https://endpoint1.mydomain5.com/"
+    expect(service_ud.root_url).to eql "https://endpoint1.mydomain5.com/"
+  end
+
+  it "should suppport setting root url to a dynamic value" do
+    service.universe_domain = "mydomain6.com"
+    service.root_url = "https://endpoint2.$UNIVERSE_DOMAIN$/"
+    expect(service.root_url).to eql "https://endpoint2.mydomain6.com/"
+  end
 end