google-ads-common 0.6.4 → 0.7.0

data/ChangeLog

@@ -1,3 +1,7 @@
+0.7.0:
+  - Cleaned up unused features.
+  - Now require HTTPI 0.9.7 (fixes issue #61).
+
 0.6.4:
   - Fixed issue #66 (extra fields in OAuth header).
   - Fixed issue #69 (string names converted to Date).

data/README

@@ -18,7 +18,7 @@ Install it using the gem install command.
 
 The following gem libraries are required:
  - savon v0.9.9 or greater;
- - httpi v0.9.3 or greater;
+ - httpi v0.9.7 or greater;
  - httpclient v2.2.3 or greater;
  - oauth v0.4.5 or greater.
 

data/lib/ads_common/api.rb

@@ -52,8 +52,8 @@ module AdsCommon
     end
 
     # Getter for the API service configurations.
-    def api_config
-      AdsCommon::ApiConfig
+    def api_config()
+      return AdsCommon::ApiConfig
     end
 
     # Obtain an API service, given a version and its name.
@@ -68,31 +68,10 @@ module AdsCommon
     def service(name, version = nil)
       name = name.to_sym
       version = (version.nil?) ? api_config.default_version : version.to_sym
-
-      # Check if version exists.
-      if !api_config.versions.include?(version)
-        raise AdsCommon::Errors::Error, "Unknown version '%s'" % version
-      end
-
-      # Check if the current environment supports the requested version.
       environment = @config.read('service.environment')
 
-      if !api_config.environments.include?(environment)
-        raise AdsCommon::Errors::Error,
-            "Unknown or unspecified environment: '%s'" % environment
-      end
-
-      if !api_config.environment_has_version(environment, version)
-        raise AdsCommon::Errors::Error,
-            "Environment '%s' does not support version '%s'" %
-            [environment, version]
-      end
-
-      # Check if the specified version has the requested service.
-      if !api_config.version_has_service(version, name)
-        raise AdsCommon::Errors::Error,
-            "Version '%s' does not contain service '%s'" % [version, name]
-      end
+      # Check if the combination is available.
+      validate_service_request(environment, version, name)
 
       # Try to re-use the service for this version if it was requested before.
       wrapper = if @wrappers.include?(version) && @wrappers[version][name]
@@ -121,12 +100,15 @@ module AdsCommon
       parameters.each_pair do |key, value|
         @credential_handler.set_credential(key, value)
       end
-      @auth_handler = get_auth_handler(@config.read('service.environment'))
 
-      # Token might still be valid, if not ask for a new one.
-      token = @auth_handler.get_token() ||
+      auth_handler = get_auth_handler()
+      token = auth_handler.get_token()
+
+      # If token is invalid ask for a new one.
+      if token.nil?
         begin
-          @auth_handler.get_token(@credential_handler.credentials)
+          credentials = @credential_handler.credentials
+          token = @auth_handler.get_token(credentials)
         rescue AdsCommon::Errors::OAuthVerificationRequired => e
           verification_code = (block_given?) ? yield(e.oauth_url) : nil
           # Retry with verification code if one provided.
@@ -138,63 +120,78 @@ module AdsCommon
             raise e
           end
         end
+      end
       return token
     end
 
+    # Auxiliary method to get an authentication handler. Creates a new one if
+    # the handler has not been initialized yet.
+    #
+    # Returns:
+    # - auth handler
+    #
+    def get_auth_handler()
+      @auth_handler ||= create_auth_handler()
+      return @auth_handler
+    end
+
     private
 
-    # Retrieve the SOAP header handlers to plug into the drivers. Needs to
-    # be implemented on the specific API, because of the different types of
-    # SOAP headers (optional parameter specifying API version).
+    # Auxiliary method to test parameters correctness for the service request.
+    def validate_service_request(environment, version, service)
+      # Check if the current environment supports the requested version.
+      unless api_config.environment_has_version(environment, version)
+        raise AdsCommon::Errors::Error,
+            "Environment '%s' does not support version '%s'" %
+            [environment.to_s, version.to_s]
+      end
+
+      # Check if the specified version has the requested service.
+      unless api_config.version_has_service(version, service)
+        raise AdsCommon::Errors::Error,
+            "Version '%s' does not contain service '%s'" %
+            [version.to_s, name.to_s]
+      end
+    end
+
+    # Retrieve the SOAP header handler to generate headers based on the
+    # configuration. Needs to be implemented on the specific API, because of
+    # the different types of SOAP headers.
     #
     # Args:
     # - auth_handler: instance of an AdsCommon::Auth::BaseHandler subclass to
     #   handle authentication
-    # - header_list: the list of headers to be handled
     # - version: intended API version
     # - wrapper: wrapper object for the service being handled
     #
     # Returns:
     # - a list of SOAP header handlers; one per provided header
     #
-    def soap_header_handlers(auth_handler, header_list, version, wrapper)
-      raise NotImplementedError, 'soap_header_handlers not overridden.'
-    end
-
-    # Auxiliary method to get an authentication handler. Creates a new one if
-    # the handler has not been initialized yet.
-    #
-    # Args:
-    # - environment: the current working environment (production, sandbox, etc.)
-    # - version: intended API version, must be a symbol, optional
-    #
-    # Returns:
-    # - auth handler
-    #
-    def get_auth_handler(environment, version = nil)
-      @auth_handler ||= create_auth_handler(environment, version)
-      return @auth_handler
+    def soap_header_handler(auth_handler, version, wrapper)
+      raise NotImplementedError, 'soap_header_handler not overridden.'
     end
 
     # Auxiliary method to create an authentication handler.
     #
-    # Args:
-    # - environment: the current working environment (production, sandbox, etc.)
-    # - version: intended API version, must be a symbol, optional
-    #
     # Returns:
     # - auth handler
     #
-    def create_auth_handler(environment, version = nil)
+    def create_auth_handler()
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
       return case auth_method
         when :CLIENTLOGIN
-          auth_server = api_config.auth_server(environment)
-          AdsCommon::Auth::ClientLoginHandler.new(config, auth_server,
-              api_config.headers_config[:LOGIN_SERVICE_NAME])
+          AdsCommon::Auth::ClientLoginHandler.new(
+              @config,
+              api_config.client_login_config(:AUTH_SERVER),
+              api_config.client_login_config(:LOGIN_SERVICE_NAME)
+          )
         when :OAUTH
-          scope = api_config.environment_config()[environment][:oauth_scope]
-          AdsCommon::Auth::OAuthHandler.new(config, scope)
+          environment = @config.read('service.environment',
+              api_config.default_environment())
+          AdsCommon::Auth::OAuthHandler.new(
+              @config,
+              api_config.environment_config(environment, :oauth_scope)
+          )
         else
           raise AdsCommon::Errors::Error,
               "Unknown authentication method '%s'" % auth_method
@@ -202,33 +199,26 @@ module AdsCommon
     end
 
     # Handle loading of a single service.
-    # Creates the driver, sets up handlers, declares the appropriate wrapper
-    # class and creates an instance of it.
+    # Creates the wrapper, sets up handlers and creates an instance of it.
     #
     # Args:
     # - version: intended API version, must be a symbol
     # - service: name for the intended service
     #
     # Returns:
-    # - a simplified wrapper generated for the driver
+    # - a simplified wrapper generated for the service
     #
     def prepare_wrapper(version, service)
       environment = config.read('service.environment')
       api_config.do_require(version, service)
       endpoint = api_config.endpoint(environment, version, service)
       interface_class_name = api_config.interface_name(version, service)
-      endpoint_url = endpoint.nil? ? nil : endpoint + service.to_s
-      wrapper = class_for_path(interface_class_name).new(self, endpoint_url)
-
-      auth_handler = get_auth_handler(environment, version)
-      header_list =
-          auth_handler.header_list(@credential_handler.credentials(version))
 
-      soap_handlers = soap_header_handlers(auth_handler, header_list,
-                                           version, wrapper.namespace)
-      soap_handlers.each do |handler|
-        wrapper.headerhandler << handler
-      end
+      wrapper = class_for_path(interface_class_name).new(@config, endpoint)
+      auth_handler = get_auth_handler()
+      soap_handler =
+          soap_header_handler(auth_handler, version, wrapper.namespace)
+      wrapper.header_handler = soap_handler
 
       return wrapper
     end
@@ -237,7 +227,7 @@ module AdsCommon
     def create_default_logger()
       logger = Logger.new(STDOUT)
       logger.level = get_log_level_for_string(
-          @config.read('library.log_level', Logger::INFO))
+          @config.read('library.log_level', 'INFO'))
       return logger
     end
 
@@ -274,17 +264,7 @@ module AdsCommon
 
     # Converts log level string (from config) to Logger value.
     def get_log_level_for_string(log_level)
-      result = log_level
-      if log_level.is_a?(String)
-        result = case log_level.upcase
-          when 'FATAL' then Logger::FATAL
-          when 'ERROR' then Logger::ERROR
-          when 'WARN' then Logger::WARN
-          when 'INFO' then Logger::INFO
-          when 'DEBUG' then Logger::DEBUG
-        end
-      end
-      return result
+      return Logger.const_get(log_level)
     end
 
     # Converts complete class path into class object.

data/lib/ads_common/api_config.rb

@@ -24,14 +24,13 @@
 require 'ads_common/version.rb'
 
 module AdsCommon
-
   # Contains helper methods for loading and managing the available services.
   # This module is meant to be imported into API-specific modules.
   module ApiConfig
     # Get the available API versions.
     #
     # Returns:
-    # List of versions available (as integers)
+    # List of versions available
     #
     def versions
       service_config.keys
@@ -40,7 +39,7 @@ module AdsCommon
     # Get the latest API version.
     #
     # Returns:
-    # Latest version (as an integer)
+    # Latest version
     #
     def latest_version
       service_config.keys.select { |service| service.is_a? Integer }.max
@@ -53,8 +52,7 @@ module AdsCommon
     # given version
     #
     def environment_has_version(environment, version)
-      return environment_config.include?(environment) &&
-          environment_config[environment].include?(version)
+      return !environment_config(environment, version).nil?
     end
 
     # Does the given version exist and contain the given service?
@@ -71,7 +69,7 @@ module AdsCommon
     # Get the default API version.
     #
     # Returns:
-    # Default version (as an integer)
+    # Default version
     #
     def default_version
       nil
@@ -83,21 +81,12 @@ module AdsCommon
     # - version: the API version (as an integer)
     #
     # Returns:
-    # List of names of services (as strings) available for given version
+    # List of names of services available for given version
     #
     def services(version)
       service_config[version]
     end
 
-    # Get the available environments.
-    #
-    # Returns:
-    # List of available environments (as strings)
-    #
-    def environments
-      environment_config.keys
-    end
-
     # Get the API name.
     def api_name
       raise NotImplementedError, 'api_name not overriden.'
@@ -111,7 +100,7 @@ module AdsCommon
     # Get the default environment.
     #
     # Returns:
-    # Default environment (as a string)
+    # Default environment
     #
     def default_environment
       raise NotImplementedError, 'default_environment not overriden.'
@@ -125,32 +114,34 @@ module AdsCommon
     # Get the endpoint for a service on a given environment and API version.
     #
     # Args:
-    # - environment: the service environment to be used (as a string)
-    # - version: the API version (as an integer)
-    # - service: the name of the API service (as a string)
+    # - environment: the service environment to be used
+    # - version: the API version
+    # - service: the name of the API service
     #
     # Returns:
-    # The endpoint URL (as a string)
+    # The endpoint URL
     #
     def endpoint(environment, version, service)
       base = get_wsdl_base(environment, version)
+      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.7.0.
       if !subdir_config().nil?
         base = base.to_s + subdir_config()[[version, service]].to_s
       end
-      return base.to_s + version.to_s + '/'
+      return base.to_s + version.to_s + '/' + service.to_s
     end
 
     # Get the subdirectory for a service, for a given API version.
     #
     # Args:
-    # - version: the API version (as an integer)
-    # - service: the name of the API service (as a string)
+    # - version: the API version
+    # - service: the name of the API service
     #
     # Returns:
-    # The endpoint URL (as a string)
+    # The subdir infix
     #
     def subdir(version, service)
       return nil if subdir_config().nil?
+      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.7.0.
       subdir_config()[[version, service]]
     end
 
@@ -158,30 +149,26 @@ module AdsCommon
     # override the auth URL via environmental variable.
     #
     # Args:
-    # - environment: the service environment to be used (as a string)
+    # - environment: the service environment to be used
     #
     # Returns:
-    # The full URL for the auth server.
+    # The full URL for the auth server
     #
     def auth_server(environment)
-      auth_server_url =
-          ENV['ADSAPI_AUTH_URL'] ||
-          auth_server_config[environment]
-      return auth_server_url
+      return ENV['ADSAPI_AUTH_URL'] || auth_server_config[environment]
     end
 
     # Perform the loading of the necessary source files for a version.
     #
     # Args:
-    # - version: the API version (as a symbol)
-    # - service: service name (as a symbol)
+    # - version: the API version
+    # - service: service name
     #
     # Returns:
-    # The filename that was loaded.
+    # The filename that was loaded
     #
     def do_require(version, service)
-      filename = "%s/%s/%s" %
-          [api_path, version.to_s, service.to_s.snakecase]
+      filename = [api_path, version.to_s, service.to_s.snakecase].join('/')
       require filename
       return filename
     end
@@ -189,41 +176,27 @@ module AdsCommon
     # Returns the full module name for a given service.
     #
     # Args:
-    # - version: the API version (as a symbol)
-    # - service: the service name (as a symbol)
+    # - version: the API version
+    # - service: the service name
     #
     # Returns:
-    # The full module name for the given service (as a string).
+    # The full module name for the given service
     #
     def module_name(version, service)
-      return "%s::%s::%s" %
-          [api_name, version.to_s.upcase, service.to_s]
+      return [api_name, version.to_s.upcase, service.to_s].join('::')
     end
 
     # Returns the full interface class name for a given service.
     #
     # Args:
-    # - version: the API version (as an integer)
-    # - service: the service name (as a string)
+    # - version: the API version
+    # - service: the service name
     #
     # Returns:
-    # The full interface class name for the given service (as a string)
+    # The full interface class name for the given service
     #
     def interface_name(version, service)
-      return module_name(version, service) + "::" + service.to_s
-    end
-
-    # Returns the full wrapper class name for a given service
-    #
-    # Args:
-    # - version: the API version (as an integer)
-    # - service: the service name (as a string)
-    #
-    # Returns:
-    # The full wrapper class name for the given service (as a string)
-    #
-    def wrapper_name(version, service)
-      return module_name(version, service) + "::#{service}Wrapper"
+      return [module_name(version, service), service.to_s].join('::')
     end
 
     # Generates an array of WSDL URLs based on defined Services and version
@@ -234,7 +207,7 @@ module AdsCommon
     #   - version: the API version.
     #
     # Returns
-    #   hash of pairs Service => WSDL URL.
+    #   hash of pairs Service => WSDL URL
     #
     def get_wsdls(version)
       res = {}
@@ -256,14 +229,14 @@ module AdsCommon
     #
     # Args:
     #   - environment: environment to use like :SANDBOX or :PRODUCTION
-    #   - version: the API version.
+    #   - version: the API version
     #
     # Returns:
-    #   String containing base URL.
+    #   String containing base URL
+    #
     def get_wsdl_base(environment, version)
-      wsdl_base = ENV['ADSAPI_BASE_URL'] ||
-          wsdl_base = environment_config[environment][version]
-      return wsdl_base
+      return ENV['ADSAPI_BASE_URL'] ||
+          environment_config(environment, version)
     end
   end
 end