google-ads-common 0.2.1 → 0.3.0

data/ChangeLog

@@ -1,3 +1,8 @@
+0.3.0:
+  - Fixes towards Ruby1.9 compatibility.
+  - Support for method names with CAPSed words (Savon),
+  - New single-Logger logging system.
+
 0.2.1:
   - Support for Savon 0.9.1 and later which is now a dependency.
   - Upgraded to httpi/0.9.2, httpclient/2.1.6.

data/lib/ads_common/api.rb

@@ -19,29 +19,19 @@
 #
 # Generic Api class, to be inherited from and extended by specific APIs.
 
+require 'logger'
+
 require 'ads_common/errors'
 require 'ads_common/auth/base_handler'
 require 'ads_common/auth/client_login_handler'
 require 'ads_common/soap4r_headers/nested_header_handler'
 require 'ads_common/soap4r_headers/single_header_handler'
 require 'ads_common/soap4r_response_handler'
+require 'ads_common/soap4r_logger'
 
 module AdsCommon
   class Api
 
-    # Auxiliary method to create a new Soap4rResponseHandler
-    # Should be redefined in inheriting classes, if planning to do specific
-    # logging.
-    def create_handler
-      AdsCommon::Soap4rResponseHandler.new(self)
-    end
-
-    # Logger object used for logging request info
-    attr_reader :request_logger
-
-    # Logger object used for logging SOAP XML
-    attr_reader :xml_logger
-
     # Methods that return the service configuration and the client library
     # configuration. They need to be redefined in subclasses.
     attr_reader :api_config, :config
@@ -52,6 +42,23 @@ module AdsCommon
     # The configuration for this Api object
     attr_reader :config
 
+    # The logger for this Api object.
+    attr_reader :logger
+
+    # Constructor for Api.
+    def initialize(provided_config = nil)
+      load_config(provided_config)
+      provided_logger = @config.read('library.logger')
+      self.logger = (provided_logger.nil?) ?
+          create_default_logger() : provided_logger
+    end
+
+    # Sets the logger to use.
+    def logger=(logger)
+      @logger = logger
+      @config.set('library.logger', @logger)
+    end
+
     # Obtain an API service, given a version and its name.
     #
     # Args:
@@ -124,7 +131,7 @@ module AdsCommon
     end
 
     # Handle loading of a single service.
-    # Creates the driver, sets up handlers and loggers, declares the appropriate
+    # Creates the driver, sets up handlers and logger, declares the appropriate
     # wrapper class and creates an instance of it.
     #
     # Args:
@@ -168,7 +175,7 @@ module AdsCommon
       # Add response handler to this driver for API unit usage processing.
       driver.callbackhandler = create_callback_handler
       # Plug the wiredump to our XML logger
-      driver.wiredump_dev = xml_logger
+      driver.wiredump_dev = AdsCommon::Soap4rLogger.new(@logger, Logger::DEBUG)
       driver.options['protocol.http.ssl_config.verify_mode'] = nil
       proxy = config.read('connection.proxy')
       if proxy
@@ -179,5 +186,41 @@ module AdsCommon
       @wrappers[[version, service]] = wrapper
       return driver, wrapper
     end
+
+    # Auxiliary method to create a default Logger.
+    def create_default_logger()
+      logger = Logger.new(STDOUT)
+      logger.level = get_log_level_for_string(
+          @config.read('library.log_level', Logger::INFO))
+      return logger
+    end
+
+    # Helper method to load the default configuration file or a given config.
+    def load_config(provided_config = nil)
+      @config = (provided_config.nil?) ?
+          AdsCommon::Config.new(
+              File.join(ENV['HOME'], default_config_filename)) :
+          AdsCommon::Config.new(provided_config)
+    end
+
+    # Gets the default config filename.
+    def default_config_filename()
+      return api_config.default_config_filename
+    end
+
+    # 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
+    end
   end
 end

data/lib/ads_common/api_config.rb

@@ -26,7 +26,7 @@ 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
-    ADS_COMMON_VERSION = '0.2.1'
+    ADS_COMMON_VERSION = '0.3.0'
 
     # Get the available API versions.
     #
@@ -111,6 +111,11 @@ module AdsCommon
       nil
     end
 
+    # Get the default filename for the config file.
+    def default_config_filename
+      raise NotImplementedError, 'default_config_filename not overriden.'
+    end
+
     # Get the endpoint for a service on a given environment and API version.
     #
     # Args:

data/lib/ads_common/build/rake_common.rb

@@ -47,7 +47,8 @@ $PKG_VERSION = ENV['REL'] ? ENV['REL'] : $CURRENT_VERSION
 
 SRC_RB = FileList["#{$LIBDIR}/**/*.rb"]
 
-logger = Logger.new(STDERR)
+logger = Logger.new(STDOUT)
+logger.level = Logger::INFO
 
 CLEAN.include($WSDLDIR)
 CLEAN.include($DOCDIR)
@@ -69,9 +70,11 @@ task :getwsdl do
   $API_CONFIG.versions.each do |version|
     urls = $API_CONFIG.get_wsdls(version)
     mkdir_p File.join($WSDLDIR, version.to_s)
+    config = Generator.config
+    config.set('library.logger', logger)
     urls.each do |service, url|
-      puts "getting #{url}"
-      save(AdsCommon::Http.get(url, Generator.config),
+      logger.info("Getting #{url}...")
+      save(AdsCommon::Http.get(url, config),
            get_wsdl_file_name(version.to_s, service.to_s))
     end
   end
@@ -146,7 +149,8 @@ task :soap4r_generate do
       File.open(wrapper_file, 'w') do |file|
         file.write(Generator.generate_wrapper_class(version, service))
       end
-      puts "Generated #{version} #{service_name} wrapper: #{wrapper_file}"
+      logger.info("Generated #{version} #{service_name} " +
+          "wrapper: #{wrapper_file}")
     end
   end
 end
@@ -297,7 +301,7 @@ PKG_FILES = FileList[
 PKG_FILES.exclude(/\._/)
 
 if ! defined?(Gem)
-  puts "Package Target requires RubyGems"
+  logger.fatal('Package Target requires RubyGems')
 else
   spec = Gem::Specification.new do |s|
 
@@ -320,7 +324,7 @@ else
 
     # RDoc information
     s.has_rdoc = true
-    s.extra_rdoc_files = ['README']
+    s.extra_rdoc_files = ['README', 'COPYING', 'ChangeLog']
     s.rdoc_options << '--main' << 'README'
 
     # Metadata

data/lib/ads_common/build/savon_abstract_generator.rb

@@ -33,6 +33,7 @@ module AdsCommon
         @service_name = args[:service_name]
         @module_name  = args[:module_name]
         @namespace = args[:namespace]
+        @logger = args[:logger]
         @generator_stamp = "Code generated by AdsCommon library %s on %s." %
             [AdsCommon::ApiConfig::ADS_COMMON_VERSION,
              Time.now.strftime("%Y-%m-%d %H:%M:%S")]

data/lib/ads_common/build/savon_generator.rb

@@ -45,11 +45,19 @@ module AdsCommon
         @wsdl_url = wsdl_url
         @code_path = code_path
         @service_name = service_name
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
         @generator_args = {
             :service_name => service_name,
             :module_name  => module_name,
-            :require_path => @code_path.sub(/^lib\//, '')
+            :require_path => @code_path.sub(/^lib\//, ''),
+            :logger => @logger
         }
+        Savon.configure do |config|
+          config.logger = @logger
+          config.log_level = :debug
+        end
+        HTTPI.logger = @logger
       end
 
       #
@@ -68,7 +76,6 @@ module AdsCommon
         rescue AdsCommon::Errors::Error => e
           error_msg = "An unrecoverable error occured during code generation"
           error_msg += " for service [%s]: %s" % [@wsdl_url, e]
-          # TODO log properly
           raise AdsCommon::Errors::BuildError, error_msg
         end
       end
@@ -121,7 +128,7 @@ module AdsCommon
       # Creates a new file on specified path, overwriting existing one if it
       # exists
       def create_new_file(file_name)
-        puts "Creating %s..." % [file_name]
+        @logger.info("Creating %s..." % [file_name])
         make_dir_for_path(file_name)
         new_file = File.new(file_name, File::WRONLY|File::TRUNC|File::CREAT)
       end

data/lib/ads_common/build/savon_registry.rb

@@ -62,7 +62,6 @@ module AdsCommon
             @soap_exceptions << extract_exception(ctype)
           elsif ctype_name.match('.+Error$')
             # We don't use it at the moment.
-            # TODO: log we ignore it at proper log level.
           else
             @soap_types << extract_type(ctype)
           end
@@ -96,11 +95,17 @@ module AdsCommon
 
       # Extracts method parameters from ComplexTypes element.
       def extract_method(method_element, doc)
-        return {:name => get_element_name(method_element).snakecase,
-                :input => extract_input_parameters(method_element, doc),
-                :output => extract_output_parameters(method_element, doc)}
-            #  This could be used to include documentation from wsdl.
-            #    :doc => get_element_doc(operation, 'wsdl')}
+        name = get_element_name(method_element)
+        method = {
+            :name => name.snakecase,
+            :input => extract_input_parameters(method_element, doc),
+            :output => extract_output_parameters(method_element, doc)
+            # This could be used to include documentation from wsdl.
+            #:doc => get_element_doc(operation, 'wsdl')
+        }
+        original_name = (name.snakecase.lower_camelcase == name)? nil : name
+        method[:original_name] = original_name unless original_name.nil?
+        return method
       end
 
       # Extracts definition of all types. If a non standard undefined type is

data/lib/ads_common/config.rb

@@ -31,8 +31,8 @@ module AdsCommon
     def initialize(param = nil)
       @config = Hash.new
       case param
-        when String: load(param)
-        when Hash: set_all(param)
+        when String then load(param)
+        when Hash then set_all(param)
       end
     end
 

data/lib/ads_common/http.rb

@@ -61,14 +61,15 @@ module AdsCommon
     # Defaulting to stricter :peer validation.
     def self.prepare_request(config, url, headers = nil, data = nil)
       request = HTTPI::Request.new(url)
-      proxy = config ? config.read('connection.proxy') : nil
+      proxy = config.read('connection.proxy', nil)
       request.proxy = proxy if proxy
       strict_ssl = config.nil? or
           !(config.read('connection.strict_ssl_verification') == 'false')
       request.auth.ssl.verify_mode = strict_ssl ? :peer : :none
       request.headers = headers if headers
       request.body = data if data
-      HTTPI.log = false # TODO remove after logger CL.
+      logger = config.read('library.logger')
+      HTTPI.logger = logger if logger
       return request
     end
   end

data/lib/ads_common/savon_service.rb

@@ -24,7 +24,7 @@ require 'savon'
 
 module AdsCommon
   class SavonService
-    attr_accessor :headerhandler, :wiredump_dev, :options
+    attr_accessor :headerhandler
 
     # Creates a new service.
     def initialize(endpoint, namespace)
@@ -32,8 +32,6 @@ module AdsCommon
         raise NoMethodError, "Tried to instantiate an abstract class"
       end
       @headerhandler = []
-      @wiredump_dev = nil
-      @options = {}
       @client = Savon::Client.new do |wsdl|
         wsdl.namespace = namespace
         wsdl.endpoint = endpoint
@@ -55,18 +53,27 @@ module AdsCommon
     # Executes SOAP action specified as a string with given arguments.
     def execute_action(action_name, args)
       args = validate_args(action_name, args)
-      response = @client.request(action_name.to_sym) do |soap|
-        set_headers(soap, args)
-      end
+      response = execute_soap_request(action_name.to_sym, args)
       handle_errors(response)
       return extract_result(response, action_name)
     end
 
+    # Executes the SOAP request with original SOAP name.
+    def execute_soap_request(action, args)
+      original_action_name =
+          get_service_registry.get_method_signature(action)[:original_name]
+      original_action_name = action if original_action_name.nil?
+      response = @client.request(original_action_name) do |soap|
+        set_headers(soap, args)
+      end
+      return response
+    end
+
     # Validates input parameters to:
     # - add parameter names;
     # - resolve xsi:type where required;
     # - convert some native types to xml.
-    def validate_args(action_name, *args)
+    def validate_args(action_name, args)
       validated_args = Hash.new
       in_params = get_service_registry.get_method_signature(action_name)[:input]
       in_params.each_with_index do |in_param, index|
@@ -82,9 +89,9 @@ module AdsCommon
     # Also handles some types that need special conversions.
     def validate_arg(arg, parent = nil, key = nil)
       result = case arg
-        when Hash: validate_hash_arg(arg, parent, key)
-        when Array: arg.map {|item| validate_arg(item, parent, key)}
-        when Time: time_to_xml_hash(arg)
+        when Hash then validate_hash_arg(arg, parent, key)
+        when Array then arg.map {|item| validate_arg(item, parent, key)}
+        when Time then time_to_xml_hash(arg)
         else arg
       end
       return result
@@ -216,12 +223,14 @@ module AdsCommon
     # Converts XML input string into a native format.
     def normalize_type(data, field)
       type_name = field[:type]
-      result = case type_name
-        when 'long', 'int': Integer(data)
-        when 'double': Float(data)
-        when 'boolean': data.kind_of?(String) ? data.casecmp('true') == 0 : data
-        else data
-      end
+      result = (data.nil?) ? data :
+          case type_name
+            when 'long', 'int' then Integer(data)
+            when 'double' then Float(data)
+            when 'boolean' then data.kind_of?(String) ?
+                data.casecmp('true') == 0 : data
+            else data
+          end
       # If field signature allows an array, forcing array structure even for one
       # item.
       if !field[:min_occurs].nil? and

data/lib/ads_common/soap4r_logger.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Wrapper class to handle Soap4r-specific logging to standard logger.
+
+require 'logger'
+
+module AdsCommon
+  class Soap4rLogger
+    # Constructor for Soap4rLogger.
+    #
+    # Args:
+    # - logger: a ruby logger to log to.
+    # - log_level: default log_level for streams, defaults to INFO.
+    #
+    def initialize(logger, log_level = Logger::INFO)
+      @logger = logger
+      @log_level = log_level
+    end
+
+    # Overload << operator to perform logging.
+    def << (text)
+      @logger.add(@log_level) {text.to_s}
+    end
+  end
+end

data/lib/ads_common/soap4r_response_handler.rb

@@ -2,7 +2,7 @@
 #
 # Authors:: api.sgomes@gmail.com (Sérgio Gomes)
 #
-# Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -50,19 +50,10 @@ module AdsCommon
     #
     def on_callback(method_name, endpoint, envelope, params, fault = false,
         fault_msg = nil)
-
-      host = URI.parse(endpoint).host
-
-      data = "host=#{host} method=#{method_name} "
-      data += "isFault=#{(!!fault).to_s} "
-
-      if fault_msg
-        data += "faultMessage=\"#{fault_msg}\""
-      else
-        data += "faultMessage=none"
-      end
-
-      @parent.request_logger << data
+      fault_text = fault_msg ? fault_msg.to_s : 'none'
+      data = "host=%s method=%s isFault=%s faultMessage=\"%s\"" %
+          [URI.parse(endpoint).host, method_name, fault.to_s, fault_text]
+      @parent.logger.info(data)
     end
 
     # Parses the value contained in a SOAP response header.

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 +04:00
+date: 2011-06-09 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,9 +105,9 @@ files:
 - lib/ads_common/credential_handler.rb
 - lib/ads_common/errors.rb
 - lib/ads_common/http.rb
-- lib/ads_common/logger.rb
 - lib/ads_common/savon_service.rb
 - lib/ads_common/soap4r_patches.rb
+- lib/ads_common/soap4r_logger.rb
 - README
 - ChangeLog
 - COPYING

data/lib/ads_common/logger.rb

@@ -1,68 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
-#
-# Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
-#
-# License:: 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.
-#
-# Wrapper class to handle logging to console and/or files.
-
-require 'logger'
-
-module AdsCommon
-
-  # Wrapper class to handle logging to console and/or files.
-  class Logger
-
-    # Constructor for AdsLogger.
-    #
-    # Args:
-    # - filename: the filename for the log file to be written (if log_to_file is
-    #   called)
-    # - log_to_console: boolean, indicates whether or not to log to the console
-    #
-    def initialize(filename, log_to_console=false)
-      @filename = filename
-      @loggers = []
-      if log_to_console
-        stderr_logger = ::Logger.new(STDERR)
-        stderr_logger.level = ::Logger::INFO
-        @loggers << stderr_logger
-      end
-    end
-
-    # Enables logging to a file.
-    # May be called several times to log to multiple files.
-    #
-    # Args:
-    # - path: where to write the file (defaults to current dir). Path only, do
-    #   not provide filename.
-    #
-    def log_to_file(path='.')
-      new_logger = ::Logger.new(File.join(path, @filename))
-      new_logger.level = ::Logger::INFO
-      @loggers << new_logger
-
-      return nil
-    end
-
-    # Overload << operator to perform logging.
-    def << (text)
-      @loggers.each do |logger|
-        logger.info text.to_s
-      end
-    end
-  end
-end