google-ads-googleads 2.3.0 → 2.4.0

data/lib/google/ads/google_ads/google_ads_client.rb

@@ -52,18 +52,24 @@ require 'google/ads/google_ads/wrapper_util'
 require 'google/ads/google_ads/logging_interceptor'
 require 'google/ads/google_ads/factories'
 require 'google/ads/google_ads/errors'
-require 'google/ads/google_ads/patch_lro_headers'
+require 'google/ads/google_ads/service_lookup'
+require 'google/ads/google_ads/deprecation'
+require 'google/ads/google_ads/v1/services/google_ads_service_client'
 
 require 'google/gax'
 
 require 'logger'
+require 'json'
+require 'openssl'
+require 'signet/oauth_2/client'
 
 module Google
   module Ads
     module GoogleAds
       class GoogleAdsClient
 
-        DEFAULT_CONFIG_FILENAME = 'google_ads_config.rb'
+        DEFAULT_CONFIG_FILENAME = "google_ads_config.rb".freeze
+        SCOPE = "https://www.googleapis.com/auth/adwords".freeze
 
         attr_reader :logger
         # Allow setting the lookup_util manually for users who use it before creating the client.
@@ -116,80 +122,28 @@ module Google
         def service(name=nil, version = default_api_version)
           service_path = ENV['GOOGLEADS_SERVICE_PATH']
 
-          # We need a local reference to refer to from within the class block
-          # below.
-          logger = @logger
-
-          headers = {
-            :"developer-token" => @config.developer_token
-          }
-          if @config.login_customer_id
-            begin
-              login_customer_id = Integer(@config.login_customer_id)
-            rescue ArgumentError => e
-              if e.message.start_with?("invalid value for Integer")
-                raise ArgumentError.new("Invalid value for login_customer_id, must be integer")
-              end
-            end
-            if login_customer_id <= 0 || login_customer_id > 9_999_999_999
-              raise ArgumentError.new(
-                "Invalid login_customer_id. Must be an integer " \
-                "0 < x <= 9,999,999,999. Got #{login_customer_id}"
-              )
-            end
-            headers[:"login-customer-id"] = login_customer_id.to_s  # header values must be strings
-          end
-
-          if logger
-            logging_interceptor = Google::Ads::GoogleAds::LoggingInterceptor.new(logger)
-          end
-
-          if name.nil?
-            services = Factories.at_version(version).services.new(
-              service_path: service_path,
-              logging_interceptor: logging_interceptor,
-              credentials: get_updater_proc,
-              metadata: headers,
-              exception_transformer: ERROR_TRANSFORMER
-            )
-
-            patch_delegator = Class.new do
-              def initialize(services, headers, patch_callable)
-                @services = services
-                @headers = headers
-                @patch_callable = patch_callable
-              end
-
-              def respond_to_missing?(sym, include_private=false)
-                @services.respond_to?(sym, include_private)
-              end
-
-              def method_missing(name, *args)
-                @services.public_send(name, *args) do |cls|
-                  @patch_callable.call(cls, @headers)
-                  cls
-                end
-              end
-            end
-            patch_delegator.new(services, headers, method(:patch_lro_headers))
-          else
-            class_to_return = lookup_util.raw_service(name, version)
-            class_to_return = Class.new(class_to_return) do
-              unless service_path.nil? || service_path.empty?
-                const_set('SERVICE_ADDRESS', service_path.freeze)
-              end
+          ServiceLookup.new(
+            name,
+            version,
+            lookup_util,
+            service_path,
+            @logger,
+            @config,
+            make_channel,
+          ).call
+        end
 
-              const_set('GRPC_INTERCEPTORS', [logging_interceptor].compact)
-            end
+        def make_channel
+          default_target = "googleads.googleapis.com:443"
+          target = ENV.fetch('GOOGLEADS_SERVICE_PATH', default_target)
 
-            patch_lro_headers(class_to_return, headers)
+          channel_args = {
+            GRPC::Core::Channel::MAX_MESSAGE_LENGTH => 64*1000*1000
+          }
 
-            class_to_return.new(
-              credentials: get_updater_proc,
-              metadata: headers,
-              exception_transformer: ERROR_TRANSFORMER
-            )
-          end
+          call_creds = GRPC::Core::CallCredentials.new(get_credentials)
+          chan_creds = GRPC::Core::ChannelCredentials.new.compose(call_creds)
+          GRPC::Core::Channel.new(target, channel_args, chan_creds)
         end
 
         def patch_lro_headers(class_to_return, headers)
@@ -204,6 +158,7 @@ module Google
           if name.nil?
             Factories.at_version(version).resources
           else
+            deprecate("Calling `google_ads_client.resource(<ResourceType>)` is deprecated, please use `google_ads_client.service.<resource_type>` instead")
             lookup_util.resource(name, version)
           end
         end
@@ -216,6 +171,7 @@ module Google
           if name.nil?
             Factories.at_version(version).operations
           else
+            deprecate("Calling `google_ads_client.resource(<OperationType>)` is deprecated, please use `google_ads_client.service.<operation_type>` instead")
             lookup_util.operation(name, version)
           end
         end
@@ -229,6 +185,7 @@ module Google
           if name.nil?
             Factories.at_version(version).enums
           else
+            deprecate("Calling `google_ads_client.resource(<EnumType>)` is deprecated, please use `google_ads_client.service.<enum_type>` instead")
             lookup_util.enum(name, version)
           end
         end
@@ -292,9 +249,11 @@ module Google
           raise gax_error
         end
 
-        def get_credentials()
+        def get_credentials
           if @config.authentication
             @config.authentication
+          elsif @config.keyfile
+            get_service_account_credentials
           else
             get_updater_proc
           end
@@ -302,16 +261,34 @@ module Google
 
         # Provides the service a method by which to obtain an access token to
         # authenticate API requests.
-        def get_updater_proc()
-          return Signet::OAuth2::Client.new(
-            token_credential_uri: 'https://www.googleapis.com/oauth2/v3/token',
+        def get_updater_proc
+          Signet::OAuth2::Client.new(
+            token_credential_uri: "https://www.googleapis.com/oauth2/v3/token",
             client_id: @config.client_id,
             client_secret: @config.client_secret,
             refresh_token: @config.refresh_token,
-            scope: ['https://www.googleapis.com/auth/adwords']
+            scope: [SCOPE]
           ).updater_proc
         end
 
+        # Provides a Google::Auth::Credentials initialized with a keyfile
+        # specified in the config.
+        def get_service_account_credentials
+          raise 'config.impersonate required if keyfile specified' unless @config.impersonate
+          keyfile = File.read(@config.keyfile)
+          keyfile = JSON.parse(keyfile)
+          Google::Auth::Credentials.new(
+            Signet::OAuth2::Client.new(
+              token_credential_uri: "https://accounts.google.com/o/oauth2/token",
+              audience: "https://accounts.google.com/o/oauth2/token",
+              issuer: keyfile.fetch("client_email"),
+              signing_key: OpenSSL::PKey::RSA.new(keyfile.fetch("private_key")),
+              person: @config.impersonate,
+              scope: [SCOPE],
+            )
+          )
+        end
+
         # Create the default logger, useful if the user hasn't defined one.
         def create_default_logger()
           if @config.logger.nil?
@@ -330,6 +307,14 @@ module Google
         def default_api_version
           Google::Ads::GoogleAds.default_api_version
         end
+
+        def deprecate(deprecation)
+          @deprecation ||= Google::Ads::GoogleAds::Deprecation.new(
+            @config.treat_deprecation_warnings_as_errors,
+            @config.warn_on_all_deprecations,
+          )
+          @deprecation.deprecate(deprecation)
+        end
       end
     end
   end

data/lib/google/ads/google_ads/service_lookup.rb

@@ -0,0 +1,154 @@
+require 'google/ads/google_ads/patch_lro_headers'
+
+module Google
+  module Ads
+    module GoogleAds
+      class ServiceLookup
+        def initialize(name, version, lookup_util, service_path, logger, config, credentials_or_channel)
+          @name = name
+          @version = version
+          @lookup_util = lookup_util
+          @service_path = service_path
+          @logger = logger
+          @config = config
+          @credentials_or_channel = credentials_or_channel
+        end
+
+        def call
+          if logger
+            logging_interceptor = Google::Ads::GoogleAds::LoggingInterceptor.new(logger)
+          end
+
+          if name.nil?
+            services = Factories.at_version(version).services.new(**{
+              service_path: service_path,
+              logging_interceptor: logging_interceptor,
+            }.merge(gax_service_params))
+            apply_patch_delegator(services)
+          else
+            class_to_return = lookup_util.raw_service(name, version)
+            setup_service_class(class_to_return)
+            class_to_return.new(
+              **gax_service_params
+            )
+          end
+        end
+
+        private
+
+        def gax_service_params
+          {
+            credentials: credentials_or_channel,
+            metadata: headers,
+            exception_transformer: ERROR_TRANSFORMER
+          }
+        end
+
+        def setup_service_class(service_class)
+          service_path = @service_path
+          logging_interceptor = @logging_interceptor
+          class_to_return = Class.new(service_class) do
+            unless service_path.nil? || service_path.empty?
+              const_set('SERVICE_ADDRESS', service_path.freeze)
+            end
+
+            const_set('GRPC_INTERCEPTORS', [logging_interceptor].compact)
+          end
+
+          patch_lro_headers(class_to_return)
+        end
+
+        def apply_patch_delegator(services)
+          patch_delegator = Class.new do
+            def initialize(services, patch_callable)
+              @services = services
+              @patch_callable = patch_callable
+            end
+
+            def respond_to_missing?(sym, include_private=false)
+              @services.respond_to?(sym, include_private)
+            end
+
+            def method_missing(name, *args)
+              @services.public_send(name, *args) do |cls|
+                @patch_callable.call(cls)
+                cls
+              end
+            end
+          end
+          patch_delegator.new(services, method(:patch_lro_headers))
+        end
+
+        def headers
+          headers = {
+            :"developer-token" => config.developer_token
+          }
+
+          if config.login_customer_id
+            validate_login_customer_id
+            headers[:"login-customer-id"] = config.login_customer_id.to_s  # header values must be strings
+          end
+
+          headers
+        end
+
+        def patch_lro_headers(class_to_return)
+          PatchLROHeaders.new(class_to_return, headers).call
+        end
+
+        def validate_login_customer_id
+          begin
+            login_customer_id = Integer(config.login_customer_id)
+          rescue ArgumentError => e
+            if e.message.start_with?("invalid value for Integer")
+              raise ArgumentError.new("Invalid value for login_customer_id, must be integer")
+            end
+          end
+          if login_customer_id <= 0 || login_customer_id > 9_999_999_999
+            raise ArgumentError.new(
+              "Invalid login_customer_id. Must be an integer " \
+              "0 < x <= 9,999,999,999. Got #{login_customer_id}"
+            )
+          end
+        end
+
+        ERROR_TRANSFORMER = Proc.new do |gax_error|
+          begin
+            gax_error.status_details.each do |detail|
+              # If there is an underlying GoogleAdsFailure, throw that one.
+              if detail.is_a?(
+                  Google::Ads::GoogleAds::V1::Errors::GoogleAdsFailure)
+                raise Google::Ads::GoogleAds::Errors::GoogleAdsError.new(
+                    detail)
+              end
+              if detail.is_a?(Google::Protobuf::Any)
+                type = Google::Protobuf::DescriptorPool.generated_pool.lookup(
+                    detail.type_name).msgclass
+                failure = detail.unpack(type)
+                raise Google::Ads::GoogleAds::Errors::GoogleAdsError.new(
+                    failure)
+              end
+            end
+          rescue Google::Ads::GoogleAds::Errors::GoogleAdsError
+            # If we raised this, bubble it out.
+            raise
+          rescue NoMethodError
+            # Sometimes status_details is just a String; in that case, we should
+            # just raise the original exception.
+          end
+          # If we don't find an error of the correct type, or if we run into an
+          # error while processing, just throw the original.
+          raise gax_error
+        end
+
+        attr_reader :name
+        attr_reader :version
+        attr_reader :service_path
+        attr_reader :logger
+        attr_reader :config
+        attr_reader :credentials_or_channel
+        attr_reader :lookup_util
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v1/services/account_budget_proposal_service_client_config.json

@@ -10,13 +10,13 @@
       },
       "retry_params": {
         "default": {
-          "initial_retry_delay_millis": 100,
+          "initial_retry_delay_millis": 5000,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
+          "initial_rpc_timeout_millis": 3600000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
         }
       },
       "methods": {

data/lib/google/ads/google_ads/v1/services/account_budget_service_client_config.json

@@ -10,13 +10,13 @@
       },
       "retry_params": {
         "default": {
-          "initial_retry_delay_millis": 100,
+          "initial_retry_delay_millis": 5000,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
+          "initial_rpc_timeout_millis": 3600000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
         }
       },
       "methods": {

data/lib/google/ads/google_ads/v1/services/ad_group_ad_label_service_client_config.json

@@ -10,13 +10,13 @@
       },
       "retry_params": {
         "default": {
-          "initial_retry_delay_millis": 100,
+          "initial_retry_delay_millis": 5000,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
+          "initial_rpc_timeout_millis": 3600000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
         }
       },
       "methods": {

data/lib/google/ads/google_ads/v1/services/ad_group_ad_service_client_config.json

@@ -10,13 +10,13 @@
       },
       "retry_params": {
         "default": {
-          "initial_retry_delay_millis": 100,
+          "initial_retry_delay_millis": 5000,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
+          "initial_rpc_timeout_millis": 3600000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
         }
       },
       "methods": {

data/lib/google/ads/google_ads/v1/services/ad_group_audience_view_service_client_config.json

@@ -10,13 +10,13 @@
       },
       "retry_params": {
         "default": {
-          "initial_retry_delay_millis": 100,
+          "initial_retry_delay_millis": 5000,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
+          "initial_rpc_timeout_millis": 3600000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
         }
       },
       "methods": {