google-ads-common 0.2.0 → 0.2.1

data/COPYING

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2010 Google Inc.
+
+   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.

data/ChangeLog

@@ -0,0 +1,14 @@
+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.
+  - use_ruby_names now defaults to true.
+
+0.2.0:
+  - Now using httpi instead of net/http.
+
+0.1.0:
+  - Full soap4r code generation for client libraries.
+  - Experimental savon code generation for client libraries (in development).
+  - Full ClientLogin authentication support.
+  - Minimal documentation generation support.
+  - The very beginnings of a testing framework.

data/README

@@ -18,8 +18,9 @@ Install it using the gem install command.
 
 The following gem libraries are required:
  - soap4r v1.5.8 (only for soap4r-based libraries);
- - savon v0.8.5 or greater (only for savon-enabled libraries);
- - httpclient v2.1.2 or greater.
+ - savon v0.9.1 or greater (for savon-enabled libraries);
+ - httpi v0.9.2 or greater;
+ - httpclient v2.1.6 or greater.
 
 = Docs for Developers
 
@@ -47,7 +48,7 @@ to run unit tests on the library
 
 = Copyright/License Info
 
-Copyright 2010, Google Inc. All Rights Reserved.
+Copyright 2011, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -44,7 +44,7 @@ $GEM_DESCRIPTION = "#{$PROJECT_NAME} provides essential utilities shared by " +
     "all Ads Ruby client libraries."
 $GEM_AUTHORS = ['Sergio Gomes', 'Danial Klimkin']
 $GEM_EMAIL = 'api.sgomes@gmail.com'
-$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-adwords-ruby/'
+$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-ads-ruby/'
 
 # ====================================================================
 # Default task - call package
@@ -80,11 +80,9 @@ end
 # Create a task that will package the Rake software into distributable
 # gem files.
 PKG_FILES = FileList[
-  '*.*',
   'Rakefile',
   "#{$LIBDIR}/**/*.rb",
-  "#{$DOCDIR}/**/*.*",
-  "#{$TESTDIR}/**/*.*"
+  "#{$DOCDIR}/**/*.*"
 ]
 
 PKG_FILES.exclude(/\._/)
@@ -104,12 +102,13 @@ else
     s.files = PKG_FILES.to_a
     s.require_path = $LIBDIR
     s.add_dependency('soap4r', '= 1.5.8')
-    s.add_dependency('httpclient', '>= 2.1.5.2')
-    s.add_dependency('httpi', '~>0.7.9')
+    s.add_dependency('savon', '~> 0.9.1')
+    s.add_dependency('httpclient', '>= 2.1.6')
+    s.add_dependency('httpi', '~> 0.9.2')
 
     # RDoc information
     s.has_rdoc = true
-    s.extra_rdoc_files = ['README']
+    s.extra_rdoc_files = ['README', 'ChangeLog', 'COPYING']
     s.rdoc_options << '--main' << 'README'
 
     # Metadata
@@ -118,8 +117,9 @@ else
     s.homepage = $GEM_HOMEPAGE
     s.rubyforge_project = $GEM_NAME
     s.requirements << 'soap4r v1.5.8'
-    s.requirements << 'httpclient v2.1.5.2 or greater'
-    s.requirements << 'httpi v0.7.9 or greater'
+    s.requirements << 'savon v0.9.1 or greater'
+    s.requirements << 'httpclient v2.1.6 or greater'
+    s.requirements << 'httpi v0.9.2 or greater'
   end
 
   Rake::GemPackageTask.new(spec) do |t|

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.0'
+    ADS_COMMON_VERSION = '0.2.1'
 
     # Get the available API versions.
     #
@@ -256,7 +256,7 @@ module AdsCommon
         path = wsdl_base
         if (!subdir_config().nil?)
           subdir_name = subdir(version, service);
-          path = path + subdir_name if !subdir_name.empty?()
+          path = path + subdir_name if subdir_name and !subdir_name.empty?
         end
         path = path + version.to_s + '/' + service.to_s + '?wsdl'
         res[service.to_s] = path

data/lib/ads_common/build/savon_abstract_generator.rb

@@ -41,7 +41,7 @@ module AdsCommon
 
       def generate_code()
         code = ERB.new(get_code_template(), 0, '%<>')
-        code.result(binding)
+        return remove_lines_with_blanks_only(code.result(binding))
       end
 
       def get_code_template()
@@ -54,6 +54,10 @@ module AdsCommon
         @modules_close_string = 'end; ' * modules_count
         @modules_close_string += 'end'
       end
+
+      def remove_lines_with_blanks_only(text)
+        return text.gsub(/\n\ +$/, '')
+      end
     end
   end
 end

data/lib/ads_common/build/savon_generator.rb

@@ -20,7 +20,7 @@
 # Generates the wrappers for API services. Only used during the
 # 'rake generate' step of library setup.
 
-gem 'savon', '~>0.8.5'
+gem 'savon', '~>0.9.1'
 require 'savon'
 
 require 'ads_common/build/savon_service_generator'
@@ -61,7 +61,7 @@ module AdsCommon
       # Returns:
       #   none
       def process_wsdl()
-        client = Savon::Client.new {|wsdl| wsdl.document = @wsdl_url }
+        client = Savon::Client.new(@wsdl_url)
         begin
           @generator_args[:namespace] = client.wsdl.namespace
           do_process_wsdl_client(client)

data/lib/ads_common/build/savon_registry.rb

@@ -44,26 +44,37 @@ module AdsCommon
 
       # Generate code for given Savon client.
       def do_process_wsdl(wsdl)
+        @soap_exceptions = []
+        @soap_types = []
+        @soap_methods = []
+
         doc = REXML::Document.new(wsdl.to_xml)
-        @raw_types = []
-        @soap_exceptions = extract_exceptions(doc)
+        process_types(doc)
+        process_methods(doc)
         sort_exceptions()
-        @soap_methods = extract_methods(doc)
-        @soap_types = extract_types(doc)
-      end
-
-      # Extracts exceptions list with basic properties from ComplexTypes list.
-      def extract_exceptions(doc)
-        exceptions = []
-        ctypes = get_complex_types(doc)
-        raw_exceptions = exceptions_from_ctypes(ctypes)
-        raw_exceptions.each do |raw_exception|
-          exceptions << {:name => raw_exception.attributes['name'],
-              :doc => get_element_doc(raw_exception),
-              :base => get_element_base(raw_exception),
-              :fields => get_element_fields(raw_exception)}
+      end
+
+      # 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.
+            # TODO: log we ignore it at proper log level.
+          else
+            @soap_types << extract_type(ctype)
+          end
+        end
+      end
+
+      # Extracts SOAP actions as methods.
+      def process_methods(doc)
+        iface = REXML::XPath.first(doc, 'descendant::wsdl:portType')
+        REXML::XPath.each(iface, 'descendant::wsdl:operation') do |operation|
+          @soap_methods << extract_method(operation, doc)
         end
-        return exceptions
       end
 
       # Extracts ComplexTypes from XML into an array.
@@ -75,72 +86,73 @@ module AdsCommon
         return complex_types
       end
 
-      # Helper function to find Exceptions (by name) from all types.
-      def exceptions_from_ctypes(ctypes)
-        exceptions = []
-        ctypes.each do |ctype|
-          if ctype.attributes['name'].match('.+Exception$')
-            exceptions << ctype
-          end
-        end
-        return exceptions
+      # Extracts exception parameters from ComplexTypes element.
+      def extract_exception(exception_element)
+        return {:name => get_element_name(exception_element),
+                :doc => get_element_doc(exception_element),
+                :base => get_element_base(exception_element),
+                :fields => get_element_fields(exception_element)}
       end
 
-      # Extracts methods and parameters from XML.
-      def extract_methods(doc)
-        methods = []
-        iface = REXML::XPath.first(doc, 'descendant::wsdl:portType')
-        REXML::XPath.each(iface, 'descendant::wsdl:operation') do |operation|
-          methods << {:name => operation.attributes['name'].to_s.snakecase,
-              :input => extract_input_parameters(operation, doc),
-              :output => extract_output_parameters(operation, doc)}
-          # This could be used to include documentation from wsdl.
-          #    :doc => get_element_doc(operation, 'wsdl')}
+      # 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')}
+      end
+
+      # Extracts definition of all types. If a non standard undefined type is
+      # found it process it recursively.
+      def extract_type(type_element)
+        type = {:name => get_element_name(type_element), :fields => []}
+        if attribute_to_boolean(type_element.attribute('abstract'))
+          type[:abstract] = true
         end
-        return methods
+        base_type = get_element_base(type_element)
+        type[:base] = base_type if base_type
+        REXML::XPath.each(type_element,
+            'sequence | complexContent/extension/sequence') do |seq_node|
+          type[:fields] += get_element_fields(seq_node)
+        end
+        return type
       end
 
       # Extracts input parameters of given method as an array.
       def extract_input_parameters(op_node, doc)
-        result = []
-        op_name = op_node.attributes['name'].to_s
-        doc.each_element_with_attribute('name', op_name, 0,
-            '//schema/element') do |method_node|
-          seq_node = REXML::XPath.first(method_node, 'complexType/sequence')
-          result = get_element_fields(seq_node)
-          process_method_field_types(result)
-        end
-        return result
+        op_name = get_element_name(op_node)
+        return find_sequence_fields(op_name, doc)
       end
 
       # Extracts output parameter name and fields.
       def extract_output_parameters(op_node, doc)
         output_element = REXML::XPath.first(op_node, 'descendant::wsdl:output')
-        output_name = (output_element.nil?) ? nil :
-            output_element.attribute('name').to_s
-        output_fields = []
-        doc.each_element_with_attribute('name', output_name, 0,
-            '//schema/element') do |response_node|
-          seq_node = REXML::XPath.first(response_node, 'complexType/sequence')
-          output_fields = get_element_fields(seq_node)
-          process_method_field_types(output_fields)
+        output_name = get_element_name(output_element)
+        output_fields = find_sequence_fields(output_name, doc)
+        return {:name => output_name.snakecase, :fields => output_fields}
+      end
+
+      # Finds sequence fields for the element of given name.
+      def find_sequence_fields(name, doc)
+        result = []
+        doc.each_element_with_attribute('name', name, 0,
+            '//schema/element') do |element_node|
+          REXML::XPath.each(element_node, 'complexType/sequence') do |seq_node|
+            result += get_element_fields(seq_node)
+          end
         end
-        result = {:name => output_name.snakecase, :fields => output_fields}
         return result
       end
 
-      # Checks all fields are of standard type or included in raw_types.
-      def process_method_field_types(fields)
-        fields.each do |field|
-          field_type = field[:type]
-          next if STANDARD_TYPES.include?(field_type)
-          @raw_types << field_type unless @raw_types.include?(field_type)
-        end
+      # Gets element name defined as its attribute.
+      def get_element_name(element)
+        return element.attribute('name').to_s
       end
 
       # Gets element base defined as an attribute in sibling.
-      def get_element_base(root)
-        base_element = REXML::XPath.first(root, 'complexContent/extension')
+      def get_element_base(element)
+        base_element = REXML::XPath.first(element, 'complexContent/extension')
         base = (base_element.nil?) ? nil :
             base_element.attribute('base').to_s.gsub(/^.+:/, '')
         return base
@@ -157,53 +169,27 @@ module AdsCommon
       end
 
       # Gets subfields defined as elements under given root.
-      def get_element_fields(root)
+      def get_element_fields(element)
         fields = []
-        REXML::XPath.each(root, 'descendant::element') do |element|
-          fields << {:name => element.attribute('name').to_s.snakecase,
-              :type => element.attribute('type').to_s.gsub(/^.+:/, ''),
-              :min_occurs => attribute_to_int(element.attribute('minOccurs')),
-              :max_occurs => attribute_to_int(element.attribute('maxOccurs'))}
+        REXML::XPath.each(element, 'descendant::element') do |item|
+          fields << {: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'))}
         end
         return fields
       end
 
-      # Extracts definition of all types. If a non standard undefined type is
-      # found it process it recursively.
-      # Special case for extensions - types with a base class.
-      def extract_types(doc)
-        types = []
-        @raw_types.each do |raw_type|
-          doc.each_element_with_attribute('name', raw_type, 0,
-              '//schema/complexType') do |type_node|
-            type = {:name => raw_type, :fields => []}
-            ext_node = REXML::XPath.first(type_node, 'complexContent/extension')
-            if ext_node
-              base_type = ext_node.attribute('base').to_s.gsub(/^.+:/, '')
-              type[:base] = base_type
-              @raw_types << base_type unless @raw_types.include?(base_type)
-              seq_node = REXML::XPath.first(ext_node, 'sequence')
-              fields = get_element_fields(seq_node)
-              process_method_field_types(fields)
-              type[:fields] += fields
-            end
-            seq_node = REXML::XPath.first(type_node, 'sequence')
-            if seq_node
-              fields = get_element_fields(seq_node)
-              process_method_field_types(fields)
-              type[:fields] += fields
-            end
-            types << type
-          end
-        end
-        return types
-      end
-
       # Simple converter for int values.
       def attribute_to_int(attribute)
         return attribute.value.eql?('unbounded') ? nil : attribute.value.to_i
       end
 
+      # Simple converter for boolean values.
+      def attribute_to_boolean(attribute)
+        return (attribute.nil?) ? nil : attribute.value.eql?('true')
+      end
+
       # Reorders exceptions so that base ones always come before derived.
       def sort_exceptions()
         @ordered_exceptions = []