google-ads-common 0.4.0 → 0.5.0

data/lib/ads_common/build/savon_abstract_generator.rb

@@ -30,14 +30,11 @@ module AdsCommon
           raise NoMethodError, "Tried to instantiate an abstract class"
         end
         @require_path = args[:require_path]
+        @api_name = args[:api_name]
+        @version = args[:version]
         @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")]
-        prepare_modules_string()
+        prepare_template_strings()
       end
 
       def generate_code()
@@ -49,11 +46,15 @@ module AdsCommon
         raise NotImplementedError
       end
 
-      def prepare_modules_string()
-        modules_count = @module_name.scan(/::/).length
-        @modules_open_string = 'module ' + @module_name.gsub(/::/, '; module ')
-        @modules_close_string = 'end; ' * modules_count
-        @modules_close_string += 'end'
+      private
+
+      def prepare_template_strings()
+        @generator_stamp = "Code generated by AdsCommon library %s on %s." %
+            [AdsCommon::ApiConfig::ADS_COMMON_VERSION,
+             Time.now.strftime("%Y-%m-%d %H:%M:%S")]
+        @modules_open_string = 'module ' +
+            [@api_name, @version.to_s.upcase, @service_name].join('; module ')
+        @modules_close_string = 'end; end; end'
       end
 
       def remove_lines_with_blanks_only(text)

data/lib/ads_common/build/savon_generator.rb

@@ -20,7 +20,6 @@
 # Generates the wrappers for API services. Only used during the
 # 'rake generate' step of library setup.
 
-gem 'savon', '~>0.9.1'
 require 'savon'
 
 require 'ads_common/build/savon_service_generator'
@@ -34,25 +33,29 @@ module AdsCommon
     # Contains the methods that handle wrapper code generation.
     class SavonGenerator
 
-      # Create a new generator for given WSDL
+      # Create a new generator for given WSDL.
       #
       # Args:
-      #   wsdl_url local or remote URL to pull WSDL data
-      #   code_path local path to store generated files
-      #   service_name a service name to generate stubs from
-      #   module_name a fully-qualified module name
-      def initialize(wsdl_url, code_path, service_name, module_name)
+      # - wsdl_url local or remote URL to pull WSDL data
+      # - code_path local path to store generated files
+      # - api_name an API name to generate for
+      # - version a version of the service
+      # - service_name a service name to generate stubs for
+      # - extensions an optional list of extensions to include
+      #
+      def initialize(wsdl_url, code_path, api_name, version, service_name,
+          extensions = [])
         @wsdl_url = wsdl_url
         @code_path = code_path
-        @service_name = service_name
-        @logger = Logger.new(STDOUT)
-        @logger.level = Logger::INFO
+        @extensions = extensions
         @generator_args = {
+            :api_name => api_name,
+            :version => version,
             :service_name => service_name,
-            :module_name  => module_name,
-            :require_path => @code_path.sub(/^lib\//, ''),
-            :logger => @logger
+            :require_path => @code_path.sub(/^lib\//, '')
         }
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
         Savon.configure do |config|
           config.logger = @logger
           config.log_level = :debug
@@ -61,13 +64,13 @@ module AdsCommon
       end
 
       #
-      # Pull, parse and generate wrapper for WSDL on given URL
+      # Pull, parse and generate wrapper for WSDL on given URL.
       #
       # Args:
-      #   none, instance variables are used.
+      # - none, instance variables are used
       #
       # Returns:
-      #   none
+      # - none
       def process_wsdl()
         client = Savon::Client.new(@wsdl_url)
         begin
@@ -82,13 +85,12 @@ module AdsCommon
 
       private
 
-      # Generate code for given Savon client
+      # Generate code for given Savon client.
       def do_process_wsdl_client(client)
-        service_file_name = @service_name.to_s.snakecase
-
         wsdl = client.wsdl
         check_service(wsdl)
 
+        service_file_name = @generator_args[:service_name].to_s.snakecase
         wrapper_file_name = "%s/%s.rb" % [@code_path, service_file_name]
         write_wrapper(wsdl, wrapper_file_name)
 
@@ -104,36 +106,38 @@ module AdsCommon
         end
       end
 
-      # Generates wrapper file
+      # Generates wrapper file.
       def write_wrapper(wsdl, file_name)
         wrapper_file = create_new_file(file_name)
         generator = SavonServiceGenerator.new(@generator_args)
         generator.add_actions(wsdl.soap_actions.dup)
+        generator.add_extensions(@extensions)
         wrapper_file.write(generator.generate_code())
         wrapper_file.close
       end
 
-      # Generates registry file
+      # Generates registry file.
       def write_registry(wsdl, file_name)
         registry_file = create_new_file(file_name)
         generator = SavonRegistryGenerator.new(@generator_args)
-        registry = SavonRegistry.new(wsdl)
-        generator.add_exceptions(registry.soap_exceptions.dup)
-        generator.add_methods(registry.soap_methods.dup)
-        generator.add_types(registry.soap_types.dup)
+        registry = SavonRegistry.new(wsdl, @generator_args)
+        generator.add_exceptions(registry.soap_exceptions)
+        generator.add_methods(registry.soap_methods)
+        generator.add_namespaces(registry.soap_namespaces)
+        generator.add_types(registry.soap_types)
         registry_file.write(generator.generate_code())
         registry_file.close
       end
 
       # Creates a new file on specified path, overwriting existing one if it
-      # exists
+      # exists.
       def create_new_file(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
 
-      # Creates a directory for the file path specified if not exists
+      # Creates a directory for the file path specified if not exists.
       def make_dir_for_path(path)
         dir_name = File.dirname(path)
         Dir.mkdir(dir_name) if !File.directory?(dir_name)

data/lib/ads_common/build/savon_registry.rb

@@ -25,18 +25,22 @@ require 'rexml/document'
 
 module AdsCommon
   module Build
-    STANDARD_TYPES = ['long', 'boolean', 'int', 'string', 'double']
-
     # Contains the methods that extracts WSDL data.
     class SavonRegistry
       attr_reader :soap_exceptions
       attr_reader :soap_methods
       attr_reader :soap_types
+      attr_reader :soap_namespaces
 
       # Initializes the instance.
+      #
       # Args:
-      #   wsdl - string containing wsdl to parse.
-      def initialize(wsdl)
+      # - wsdl: string containing wsdl to parse
+      # - options: variuos generation options
+      #
+      def initialize(wsdl, options = {})
+        @options = options
+        @default_namespace = options[:namespace]
         do_process_wsdl(wsdl)
       end
 
@@ -47,8 +51,9 @@ module AdsCommon
         @soap_exceptions = []
         @soap_types = []
         @soap_methods = []
+        @soap_namespaces = []
 
-        doc = REXML::Document.new(wsdl.to_xml)
+        doc = REXML::Document.new(wsdl.xml)
         process_types(doc)
         process_methods(doc)
         sort_exceptions()
@@ -56,18 +61,36 @@ module AdsCommon
 
       # Extracts different types from XML.
       def process_types(doc)
-        get_complex_types(doc).each do |ctype|
-          ctype_name = get_element_name(ctype)
-          if ctype_name.match('.+Exception$')
-            @soap_exceptions << extract_exception(ctype)
-          elsif ctype_name.match('.+Error$')
-            # We don't use it at the moment.
-          else
-            @soap_types << extract_type(ctype)
+        REXML::XPath.each(doc, '//schema') do |schema|
+          ns_index = process_namespace(schema)
+          get_complex_types(schema).each do |ctype|
+            ctype_name = get_element_name(ctype)
+            if ctype_name.match('.+Exception$')
+              @soap_exceptions << extract_exception(ctype)
+            elsif ctype_name.match('.+Error$')
+              # We don't use it at the moment.
+            else
+              @soap_types << extract_type(ctype, ns_index)
+            end
           end
         end
       end
 
+      # Returns index of namespace for given schema. Adds namespace to internal
+      # array if not yet present. Returns nil for service default namespace.
+      def process_namespace(schema)
+        namespace_url = schema.attribute('targetNamespace').value
+        unless namespace_url == @default_namespace
+          ns_index = @soap_namespaces.index(namespace_url)
+          if ns_index.nil?
+            ns_index = @soap_namespaces.length
+            @soap_namespaces << namespace_url
+          end
+          return ns_index
+        end
+        return nil
+      end
+
       # Extracts SOAP actions as methods.
       def process_methods(doc)
         iface = REXML::XPath.first(doc, 'descendant::wsdl:portType')
@@ -76,13 +99,9 @@ module AdsCommon
         end
       end
 
-      # Extracts ComplexTypes from XML into an array.
-      def get_complex_types(doc)
-        complex_types = []
-        REXML::XPath.each(doc, '//schema/complexType') do |ctype|
-          complex_types << ctype
-        end
-        return complex_types
+      # Extracts ComplexTypes from node into an array.
+      def get_complex_types(node)
+        return REXML::XPath.each(node, 'complexType').to_a
       end
 
       # Extracts exception parameters from ComplexTypes element.
@@ -110,13 +129,14 @@ module AdsCommon
 
       # Extracts definition of all types. If a non standard undefined type is
       # found it process it recursively.
-      def extract_type(type_element)
+      def extract_type(type_element, ns_index)
         type = {:name => get_element_name(type_element), :fields => []}
         if attribute_to_boolean(type_element.attribute('abstract'))
           type[:abstract] = true
         end
         base_type = get_element_base(type_element)
         type[:base] = base_type if base_type
+        type[:ns] = ns_index if ns_index
         REXML::XPath.each(type_element,
             'sequence | complexContent/extension/sequence') do |seq_node|
           type[:fields] += get_element_fields(seq_node)
@@ -177,17 +197,20 @@ module AdsCommon
       def get_element_fields(element)
         fields = []
         REXML::XPath.each(element, 'descendant::element') do |item|
-          fields << {:name => get_element_name(item).snakecase.to_sym,
+          field = {:name => get_element_name(item).snakecase.to_sym,
               :type => item.attribute('type').to_s.gsub(/^.+:/, ''),
               :min_occurs => attribute_to_int(item.attribute('minOccurs')),
               :max_occurs => attribute_to_int(item.attribute('maxOccurs'))}
+          fields << field.reject {|k, v| v.nil?}
         end
         return fields
       end
 
       # Simple converter for int values.
       def attribute_to_int(attribute)
-        return attribute.value.eql?('unbounded') ? nil : attribute.value.to_i
+        return nil if attribute.nil?
+        return attribute.value.eql?('unbounded') ?
+            :unbounded : attribute.value.to_i
       end
 
       # Simple converter for boolean values.

data/lib/ads_common/build/savon_registry_generator.rb

@@ -39,6 +39,7 @@ module AdsCommon
         class <%= @service_name %>Registry
           <%= @service_name.upcase %>_METHODS = <%= format_signature(@methods) %>
           <%= @service_name.upcase %>_TYPES = <%= format_signature(@types) %>
+          <%= @service_name.upcase %>_NAMESPACES = <%= format_array(@namespaces) %>
 
           def self.get_method_signature(method_name)
             return <%= @service_name.upcase %>_METHODS[method_name.to_sym]
@@ -47,6 +48,10 @@ module AdsCommon
           def self.get_type_signature(type_name)
             return <%= @service_name.upcase %>_TYPES[type_name.to_sym]
           end
+
+          def self.get_namespace(index)
+            return <%= @service_name.upcase %>_NAMESPACES[index]
+          end
         end
         <% @exceptions.each do |exception| %>
           <% array_fields = [] %>
@@ -59,11 +64,13 @@ module AdsCommon
         class <%= exception[:name] %> < <%= base_text  %>
           <% exception[:fields].each do |field| %>
           attr_reader :<%= field[:name] %>  # <%= field[:type] %>
-            <% array_fields << field[:name] if field[:max_occurs].nil? || (field[:max_occurs] > 1) %>
+            <% is_array_field = (field[:max_occurs].nil?) ? false :
+                   ((field[:max_occurs] == :unbounded) || (field[:max_occurs] > 1)) %>
+            <% array_fields << field[:name] if is_array_field %>
           <% end %>
           <% if !(array_fields.empty?) %>
           def initialize(exception_fault)
-            @array_fields = [] if !defined?(@array_fields)
+            @array_fields ||= []
             <% array_fields.each do |field| %>
             @array_fields << '<%= field.to_s %>'
             <% end %>
@@ -81,8 +88,8 @@ module AdsCommon
         @exceptions = []
         @methods = []
         @types = []
-        @default_exception_base = "%s::Errors::ApiException" %
-            @module_name.split('::').first
+        @namespaces = []
+        @default_exception_base = "%s::Errors::ApiException" % @api_name
       end
 
       def get_code_template()
@@ -101,6 +108,10 @@ module AdsCommon
         @types += types
       end
 
+      def add_namespaces(namespaces)
+        @namespaces += namespaces
+      end
+
       private
 
       # Multi-line documentation formatter. Used to format text extracted from
@@ -120,17 +131,19 @@ module AdsCommon
         return PP.singleline_pp(objects_hash, '')
       end
 
+      # Prepares string representing a simple array.
+      def format_array(objects_array)
+        return (objects_array.nil?) ? '[]' : PP.singleline_pp(objects_array, '')
+      end
+
       # Converts an array of hashes to a hash based on ":name" fields:
       # [{:name => 'foo', :data => 'bar'}] => {:foo => {:data => 'bar'}}
       def get_hash_for_names_array(input)
-        output = {}
-        input.each do |e|
+        return input.inject({}) do |output, e|
           key = e[:name].to_sym
-          value = e.dup
-          value.delete(:name)
-          output[key] = value
+          output[key] = e.reject {|k, v| k.equal?(:name)}
+          output
         end
-        return output
       end
     end
   end

data/lib/ads_common/build/savon_service_generator.rb

@@ -35,13 +35,16 @@ module AdsCommon
 
       require 'ads_common/savon_service'
       require '<%= @require_path %>/<%= @service_name.to_s.snakecase %>_registry'
+      <% unless @extensions.empty? %>
+      require '<%= @api_name.snakecase %>/extensions'
+      <% end %>
 
       <%= @modules_open_string %>
 
         class <%= @service_name %> < AdsCommon::SavonService
-          def initialize(endpoint)
+          def initialize(api, endpoint)
             namespace = '<%= @namespace %>'
-            super(endpoint, namespace)
+            super(api, endpoint, namespace, :<%= @version %>)
           end
           <% @actions.each do |action| %>
 
@@ -49,6 +52,12 @@ module AdsCommon
             return execute_action('<%= action %>', args)
           end
           <% end %>
+          <% @extensions.each do |extention| %>
+
+          def <%= extention %>(*args)
+            return <%= @api_name %>::Extensions.<%= extention %>(self, args)
+          end
+          <% end %>
 
           private
 
@@ -57,7 +66,7 @@ module AdsCommon
           end
 
           def get_module()
-            return <%= @module_name %>
+            return <%= [@api_name, @version.to_s.upcase, @service_name].join('::') %>
           end
         end
       <%= @modules_close_string %>
@@ -67,12 +76,17 @@ module AdsCommon
       def initialize(args)
         super(args)
         @actions = []
+        @extensions = []
       end
 
       def add_actions(actions)
         @actions += actions
       end
 
+      def add_extensions(extensions)
+        @extensions += extensions
+      end
+
       def get_code_template()
         SERVICE_TEMPLATE
       end

data/lib/ads_common/config.rb

@@ -29,7 +29,7 @@ module AdsCommon
     # Initialized the Config object with either the contents of a provided file
     # or a provided hash.
     def initialize(param = nil)
-      @config = Hash.new
+      @config = {}
       case param
         when String then load(param)
         when Hash then set_all(param)