google-ads-common 0.5.3 → 0.5.4

data/ChangeLog

@@ -1,3 +1,7 @@
+0.5.4:
+  - Improved support for OAuth.
+  - Cleanups and better wsdl compatibility.
+
 0.5.3:
   - Ruby 1.9 compatibility hotfix.
 

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.5.3'
+    ADS_COMMON_VERSION = '0.5.4'
 
     # Get the available API versions.
     #
@@ -98,13 +98,18 @@ module AdsCommon
       environment_config.keys
     end
 
+    # Get the API name.
+    def api_name
+      raise NotImplementedError, 'api_name not overriden.'
+    end
+
     # Get the default environment.
     #
     # Returns:
     # Default environment (as a string)
     #
     def default_environment
-      nil
+      raise NotImplementedError, 'default_environment not overriden.'
     end
 
     # Get the default filename for the config file.
@@ -160,29 +165,37 @@ module AdsCommon
       return auth_server_url
     end
 
-    # Perform the loading of the necessary source files for a version
+    # Perform the loading of the necessary source files for a version.
     #
     # Args:
-    # - version: the API version (as an integer)
+    # - version: the API version (as a symbol)
+    # - service: service name (as a symbol)
+    #
+    # Returns:
+    # The filename that was loaded.
     #
     def do_require(version, service)
-      eval("require '#{api_path}/#{version}/#{service}Wrapper.rb'")
+      filename = "%s/%s/%s" %
+          [api_name.to_s.snakecase, version.to_s, service.to_s.snakecase]
+      require filename
+      return filename
     end
 
-    # Returns the full module name for a given service
+    # Returns the full module name for a given service.
     #
     # Args:
-    # - version: the API version (as an integer)
-    # - service: the service name (as a string)
+    # - version: the API version (as a symbol)
+    # - service: the service name (as a symbol)
     #
     # Returns:
-    # The full module name for the given service (as a string)
+    # The full module name for the given service (as a string).
     #
     def module_name(version, service)
-      return "#{api_name}::#{version.to_s.upcase}::#{service}"
+      return "%s::%s::%s" %
+          [api_name, version.to_s.upcase, service.to_s]
     end
 
-    # Returns the full interface class name for a given service
+    # Returns the full interface class name for a given service.
     #
     # Args:
     # - version: the API version (as an integer)
@@ -192,7 +205,7 @@ module AdsCommon
     # The full interface class name for the given service (as a string)
     #
     def interface_name(version, service)
-      return module_name(version, service) + "::#{service}Interface"
+      return module_name(version, service) + "::" + service.to_s
     end
 
     # Returns the full wrapper class name for a given service
@@ -237,7 +250,7 @@ module AdsCommon
     # the base URL via environmental variable.
     #
     # Args:
-    #   - environment: environment to use like SANDBOX or PRODUCTION
+    #   - environment: environment to use like :SANDBOX or :PRODUCTION
     #   - version: the API version.
     #
     # Returns:

data/lib/ads_common/auth/base_handler.rb

@@ -63,9 +63,14 @@ module AdsCommon
         return @token
       end
 
-      # Creates authorization token. Needs to be overriden.
+      # Creates authorization token. Needs to be overridden.
       def create_token(credentials)
-        raise NotImplementedError, 'create_token not overriden.'
+        raise NotImplementedError, 'create_token not overridden.'
+      end
+
+      # Returns authorization string. Needs to be overridden.
+      def auth_string(credentials, request)
+        raise NotImplementedError, 'auth_string not overridden.'
       end
     end
   end

data/lib/ads_common/auth/client_login_handler.rb

@@ -76,6 +76,11 @@ module AdsCommon
         return result
       end
 
+      # Returns authorization string.
+      def auth_string(credentials, request)
+        return ("GoogleLogin auth=%s" % get_token(credentials))
+      end
+
       private
 
       # Auxiliary method to validate the credentials for token generation.

data/lib/ads_common/auth/oauth_handler.rb

@@ -98,6 +98,31 @@ module AdsCommon
         return @consumer
       end
 
+      # Returns authorization string.
+      def auth_string(credentials, request)
+        if request.nil?
+          raise AdsCommon::Errors::AuthError,
+              'Request is required for OAuth generator.'
+        end
+        return generate_oauth_parameters_string(credentials, request)
+      end
+
+      # Generates auth string for OAuth method of authentication.
+      #
+      # Args:
+      # - credentials: credentials set for authorization
+      # - request: a HTTPI Request to generate headers for
+      #
+      # Returns:
+      # - Authentication string
+      #
+      def generate_oauth_parameters_string(credentials, request)
+        oauth_params = {:consumer => @consumer,
+                        :token => get_token(credentials)}
+        oauth_helper = OAuth::Client::Helper.new(request, oauth_params)
+        return oauth_helper.header
+      end
+
       private
 
       # Auxiliary method to validate the credentials for token generation.

data/lib/ads_common/savon_headers/base_header_handler.rb

@@ -84,11 +84,11 @@ module AdsCommon
 
       # Generates User-Agent text for HTTP request.
       def generate_user_agent_string()
-        credentials = @credential_handler.credentials
-        app_name = credentials[:user_agent]
+        credentials = @credential_handler.credentials(@version)
+        app_name = credentials[:userAgent] || credentials[:useragent]
         # We don't know the library version here. A breaking change needs to be
         # introduced. This is scheduled for 0.6.0, using Common version for now.
-        lib_version = '0.5.3'
+        lib_version = '0.5.4'
         soap_user_agent = "Common-Ruby-%s; %s" % [lib_version, app_name]
         return "Savon/%s (%s)" % [Savon::Version, soap_user_agent]
       end

data/lib/ads_common/savon_headers/oauth_header_handler.rb

@@ -19,8 +19,6 @@
 #
 # Handles SOAP headers and namespaces definition for OAuth type header.
 
-require 'oauth'
-
 require 'ads_common/savon_headers/base_header_handler'
 require 'ads_common/savon_headers/httpi_request_proxy'
 
@@ -57,11 +55,14 @@ module AdsCommon
       #  - Hash containing a header with filled in credentials
       #
       def generate_headers(request, soap)
-        headers = @auth_handler.headers(@credential_handler.credentials)
+        credentials = @credential_handler.credentials
+        headers = @auth_handler.headers(credentials)
         request_header = headers.inject({}) do |request_header, (header, value)|
           if header == :access_token
+            request.url = soap.endpoint
             request.headers['Authorization'] =
-                generate_oauth_parameters_string(request, value, soap.endpoint)
+                @auth_handler.generate_oauth_parameters_string(credentials,
+                    request)
           else
             request_header[prepend_namespace(header)] = value
           end
@@ -69,24 +70,6 @@ module AdsCommon
         end
         soap.header[prepend_namespace(@element_name)] = request_header
       end
-
-      # Generates auth string for OAuth method of authentication.
-      #
-      # Args:
-      # - request: a HTTPI::Request to sign
-      # - access_token: an initialized OAuth AccessToken
-      # - url: request URL to generate auth string for
-      #
-      # Returns:
-      # - Authentication string
-      #
-      def generate_oauth_parameters_string(request, access_token, url)
-        request.url = url
-        oauth_params = {:consumer => @auth_handler.get_oauth_consumer(),
-                        :token => access_token}
-        oauth_helper = OAuth::Client::Helper.new(request, oauth_params)
-        return oauth_helper.header
-      end
     end
   end
 end

data/lib/ads_common/savon_headers/simple_header_handler.rb

@@ -54,11 +54,9 @@ module AdsCommon
       #  - Hash containing a header with filled in credentials
       #
       def generate_request_header()
-        headers = @auth_handler.headers(@credential_handler.credentials)
-        return headers.inject({}) do |request_header, (header, value)|
-          request_header[prepend_namespace(header)] = value
-          request_header
-        end
+        headers = @auth_handler.headers(
+            @credential_handler.credentials(@version))
+        return headers[@element_name]
       end
     end
   end

data/lib/ads_common/savon_service.rb

@@ -319,7 +319,7 @@ module AdsCommon
     def normalize_output(output_data, method_definition)
       fields_list = method_definition[:output][:fields]
       result = normalize_output_field(output_data, fields_list, :rval)
-      return result[:rval]
+      return result[:rval] || result
     end
 
     # Normalizes one field of a given data recursively.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-ads-common
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 5
-  - 3
-  version: 0.5.3
+  - 4
+  version: 0.5.4
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-21 00:00:00 +04:00
+date: 2011-11-01 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency