google-ads-common 0.6.4 → 0.7.0

data/lib/ads_common/auth/base_handler.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
 #
@@ -24,10 +24,10 @@
 module AdsCommon
   module Auth
     class BaseHandler
+
       # Default initializer.
       def initialize(config)
         @config = config
-        @logger = @config.read('library.logger')
         @token = nil
       end
 
@@ -44,18 +44,6 @@ module AdsCommon
         raise error
       end
 
-      # This method returns the set of fields to be included in the header.
-      # The generic method simply returns everything passed to it.
-      def header_list(credentials)
-        return credentials.keys.dup()
-      end
-
-      # This method returns the key value pairs to be included in the header.
-      # The generic method simply returns everything passed to it.
-      def headers(credentials)
-        return credentials.dup()
-      end
-
       # Returns authorization token of some kind. Attempts to create a new one
       # if the token has not yet been created and credentials present.
       def get_token(credentials = nil)
@@ -63,15 +51,17 @@ module AdsCommon
         return @token
       end
 
-      # Creates authorization token. Needs to be overridden.
-      def create_token(credentials)
-        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
+
+      private
+
+      # Creates authorization token. Needs to be overridden.
+      def create_token(credentials)
+        raise NotImplementedError, 'create_token not overridden.'
+      end
     end
   end
 end

data/lib/ads_common/auth/client_login_handler.rb

@@ -33,53 +33,38 @@ module AdsCommon
     class ClientLoginHandler < AdsCommon::Auth::BaseHandler
       ACCOUNT_TYPE = 'GOOGLE'
       AUTH_PATH = '/accounts/ClientLogin'
+      AUTH_PREFIX = 'GoogleLogin auth='
       CAPTCHA_PATH = '/accounts/'
-      IGNORED_FIELDS = [:email, :password, :auth_token]
 
       # Initializes the ClientLoginHandler with all the necessary details.
-      def initialize(config, server, service_name)
+      def initialize(config, auth_server, service_name)
         super(config)
-        @server = server
+        @server = auth_server
         @service_name = service_name
       end
 
       # Invalidates the stored token if the email, password or provided auth
       # token have changed.
       def property_changed(prop, value)
-        if [:auth_token, :email, :password].include?(prop)
+        if [:email, :password].include?(prop)
           @token = nil
         end
+        if :auth_token.eql?(prop)
+          @token = create_token_from_string(value)
+        end
       end
 
       # Handle specific ClientLogin errors.
       def handle_error(error)
         # TODO: Add support for automatically regenerating auth tokens when they
         # expire.
+        get_logger().error(error)
         raise error
       end
 
-      # Returns all of the fields that this auth handler will fill.
-      def header_list(credentials)
-        result = credentials.keys.map.reject do |field|
-          IGNORED_FIELDS.include?(field)
-        end
-        result << :authToken
-        return result
-      end
-
-      # Returns all of the credentials received from the CredentialHandler,
-      # except for ignored fields.
-      def headers(credentials)
-        result = credentials.reject do |field, value|
-          IGNORED_FIELDS.include?(field)
-        end
-        result[:authToken] = get_token(credentials)
-        return result
-      end
-
       # Returns authorization string.
       def auth_string(credentials, request)
-        return ("GoogleLogin auth=%s" % get_token(credentials))
+        return [AUTH_PREFIX, get_token(credentials)].join
       end
 
       private
@@ -95,18 +80,23 @@ module AdsCommon
       #
       def validate_credentials(credentials)
         if credentials.nil?
-          raise AdsCommon::Errors::AuthError,
-              'No credentials supplied.'
-        end
-
-        if credentials[:email].nil?
-          raise AdsCommon::Errors::AuthError,
-              'Email address not included in credentials.'
+          raise AdsCommon::Errors::AuthError, 'No credentials supplied.'
         end
 
-        if credentials[:password].nil?
-          raise AdsCommon::Errors::AuthError,
-              'Password not included in credentials.'
+        if credentials[:auth_token].nil?
+          if credentials[:email].nil?
+            raise AdsCommon::Errors::AuthError,
+                'Email address not included in credentials.'
+          end
+          if credentials[:password].nil?
+            raise AdsCommon::Errors::AuthError,
+                'Password not included in credentials.'
+          end
+        else
+          if credentials[:email] and credentials[:password]
+            get_logger().warn('Both auth_token and login credentials present' +
+                ', preferring auth_token.')
+          end
         end
       end
 
@@ -118,35 +108,44 @@ module AdsCommon
       #   accessed
       #
       # Returns:
-      # - The auth token for the account (as a string)
+      # - The auth token for the account
       #
       # Raises:
       # - AdsCommon::Errors::AuthError if authentication fails
       #
       def create_token(credentials)
-        token = @config.read('authentication.auth_token') ||
+        token = credentials.include?(:auth_token) ?
+            create_token_from_string(credentials[:auth_token]) :
             generate_token(credentials)
         return token
       end
 
-      # Generates new client login token based on credentials.
-      def generate_token(credentials)
-        validate_credentials(credentials)
+      # Creates token for provided auth string. Trivial for this handler.
+      def create_token_from_string(token_string)
+        return token_string
+      end
 
+      # Prepares POST data for ClientLogin request.
+      def get_login_data(credentials)
         email = CGI.escape(credentials[:email])
         password = CGI.escape(credentials[:password])
-
-        url = @server + AUTH_PATH
-
+        service_name = @service_name
         data = "accountType=%s&Email=%s&Passwd=%s&service=%s" %
-            [ACCOUNT_TYPE, email, password, @service_name]
-
+            [ACCOUNT_TYPE, email, password, service_name]
         if credentials[:logintoken] and credentials[:logincaptcha]
           data += "&logintoken=%s&logincaptcha=%s" %
             [CGI.escape(credentials[:logintoken]),
              CGI.escape(credentials[:logincaptcha])]
         end
+        return data
+      end
+
+      # Generates new client login token based on credentials.
+      def generate_token(credentials)
+        validate_credentials(credentials)
 
+        url = @server + AUTH_PATH
+        data = get_login_data(credentials)
         headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
 
         response = AdsCommon::Http.post_response(url, data, @config, headers)

data/lib/ads_common/auth/oauth_handler.rb

@@ -29,17 +29,11 @@ module AdsCommon
 
     # Credentials class to handle OAuth authentication.
     class OAuthHandler < AdsCommon::Auth::BaseHandler
-      IGNORED_FIELDS = [
-          :email, :password, :auth_token,
-          :oauth_verification_code, :oauth_consumer_secret, :oauth_consumer_key,
-          :oauth_token_secret, :oauth_token
-      ]
-
       OAUTH_CONFIG = {
-          :site => "https://www.google.com",
-          :request_token_path => "/accounts/OAuthGetRequestToken",
-          :access_token_path => "/accounts/OAuthGetAccessToken",
-          :authorize_path => "/accounts/OAuthAuthorizeToken"
+          :site => 'https://www.google.com',
+          :request_token_path => '/accounts/OAuthGetRequestToken',
+          :access_token_path => '/accounts/OAuthGetAccessToken',
+          :authorize_path => '/accounts/OAuthAuthorizeToken'
       }
 
       DEFAULT_CALLBACK = 'oob'
@@ -56,42 +50,17 @@ module AdsCommon
         @scope = scope
       end
 
-      def handle_error(error)
-        # TODO: Add support.
-        raise error
-      end
-
-      # Returns all of the fields that this auth handler will fill.
-      #
-      # Args:
-      # - credentials: request credentials
-      #
-      # Returns:
-      # - array with header names
-      #
-      def header_list(credentials)
-        result = credentials.keys.map.reject do |field|
-          IGNORED_FIELDS.include?(field)
+      # Invalidates the stored token if the required credential has changed.
+      def property_changed(prop, value)
+        if [:oauth_consumer_key, :oauth_consumer_secret].include?(prop)
+          @consumer, @token, @request_token = nil, nil, nil
         end
-        result << :access_token
-        return result
       end
 
-      # Returns all of the credentials received from the CredentialHandler,
-      # except for ignored fields.
-      #
-      # Args:
-      # - credentials: request credentials
-      #
-      # Returns:
-      # - hash with header names and values
-      #
-      def headers(credentials)
-        result = credentials.reject do |field, value|
-          IGNORED_FIELDS.include?(field)
-        end
-        result[:access_token] = get_token(credentials)
-        return result
+      def handle_error(error)
+        # TODO: Add support.
+        get_logger().error(error)
+        raise error
       end
 
       # Returns OAuth-specific Consumer object.
@@ -108,6 +77,8 @@ module AdsCommon
         return generate_oauth_parameters_string(credentials, request)
       end
 
+      private
+
       # Generates auth string for OAuth method of authentication.
       #
       # Args:
@@ -118,10 +89,11 @@ module AdsCommon
       # - Authentication string
       #
       def generate_oauth_parameters_string(credentials, request)
+        # get_token() ensures @consumer is initialized.
+        token = get_token(credentials)
         oauth_params = {
-            # get_token() ensures @consumer is initialized.
-            :token => get_token(credentials),
-            :consumer => @consumer
+            :consumer => @consumer,
+            :token => token
         }
         oauth_helper = OAuth::Client::Helper.new(request, oauth_params)
         return oauth_helper.header
@@ -139,6 +111,10 @@ module AdsCommon
       # - AdsCommon::Errors::AuthError if validation fails
       #
       def validate_credentials(credentials)
+        if @scope.nil?
+          raise AdsCommon::Errors::AuthError, 'Scope is not specified.'
+        end
+
         if credentials.nil?
           raise AdsCommon::Errors::AuthError, 'No credentials supplied.'
         end
@@ -152,6 +128,8 @@ module AdsCommon
           raise AdsCommon::Errors::AuthError,
               'Consumer secret not included in credentials.'
         end
+
+        # TODO: add checks for both methods.
       end
 
       # Auxiliary method to generate an authentication token for logging via
@@ -171,15 +149,19 @@ module AdsCommon
       #
       def create_token(credentials)
         validate_credentials(credentials)
-        if @consumer.nil?
-          oauth_config = OAUTH_CONFIG.merge({:scope => @scope})
-          proxy = @config.read('connection.proxy')
-          oauth_config[:proxy] = proxy if !proxy.nil?
-          @consumer = OAuth::Consumer.new(credentials[:oauth_consumer_key],
-              credentials[:oauth_consumer_secret], oauth_config)
-        end
-        return create_token_from_credentials(credentials) ||
-            generate_access_token(credentials)
+        @consumer ||= create_consumer(credentials)
+        return create_token_from_credentials(credentials, @consumer) ||
+            generate_access_token(credentials, @consumer)
+      end
+
+      def create_consumer(credentials)
+        oauth_config = OAUTH_CONFIG.merge({:scope => @scope})
+        proxy = @config.read('connection.proxy')
+        oauth_config[:proxy] = proxy unless proxy.nil?
+        return OAuth::Consumer.new(
+            credentials[:oauth_consumer_key],
+            credentials[:oauth_consumer_secret],
+            oauth_config)
       end
 
       # Creates access token based on data from credentials.
@@ -187,30 +169,31 @@ module AdsCommon
       # Args:
       # - credentials: a hash with the credentials for the account being
       #   accessed
+      # - consumer: OAuth consumer for the current configuration
       #
       # Returns:
       # - The auth token for the account (as an AccessToken)
       #
-      def create_token_from_credentials(credentials)
-        access_token = nil
-
+      def create_token_from_credentials(credentials, consumer)
         token = credentials[:oauth_token]
-        if !token.nil? and !token.empty?
-          method = credentials[:oauth_method] || DEFAULT_METHOD
-          access_token = case method
-            when 'RSA-SHA1'
-              OAuth::AccessToken.from_hash(@consumer, {:oauth_token => token})
-            when 'HMAC-SHA1'
-              token_secret = credentials[:oauth_token_secret]
-              if token_secret.nil? or token_secret.empty?
-                @logger.warn(("The 'token' specified for method %s but " +
-                    "'token secret' is not available, ignoring token") % method)
-                nil
-              else
-                OAuth::AccessToken.from_hash(@consumer, {
-                    :oauth_token => token, :oauth_token_secret => token_secret})
-              end
-          end
+        if token.nil? or token.empty?
+          return nil
+        end
+
+        method = credentials[:oauth_method] || DEFAULT_METHOD
+        access_token = case method
+          when 'RSA-SHA1'
+            OAuth::AccessToken.from_hash(consumer, {:oauth_token => token})
+          when 'HMAC-SHA1'
+            token_secret = credentials[:oauth_token_secret]
+            if token_secret.nil? or token_secret.empty?
+              get_logger().warn(("The 'token' specified for method %s but " +
+                  "'token secret' is not available, ignoring token") % method)
+              nil
+            else
+              OAuth::AccessToken.from_hash(consumer, {
+                  :oauth_token => token, :oauth_token_secret => token_secret})
+            end
         end
         return access_token
       end
@@ -220,18 +203,21 @@ module AdsCommon
       # Args:
       # - credentials: a hash with the credentials for the account being
       #   accessed
+      # - consumer: OAuth consumer for the current configuration
       #
       # Returns:
       # - The auth token for the account (as an AccessToken)
       #
-      def generate_access_token(credentials)
+      def generate_access_token(credentials, consumer)
         token = nil
         callback = credentials[:oauth_callback] || DEFAULT_CALLBACK
         begin
           if @request_token.nil?
             @request_token = credentials[:oauth_request_token] ||
-                 @consumer.get_request_token({:oauth_callback => callback},
-                     {:scope => @scope})
+                 consumer.get_request_token(
+                     {:oauth_callback => callback},
+                     {:scope => @scope}
+                 )
           end
           verification_code = credentials[:oauth_verification_code]
           if verification_code.nil? || verification_code.empty?

data/lib/ads_common/build/savon_generator.rb

@@ -41,13 +41,10 @@ module AdsCommon
       # - 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 = [])
+      def initialize(wsdl_url, code_path, api_name, version, service_name)
         @wsdl_url = wsdl_url
         @code_path = code_path
-        @extensions = extensions
         @generator_args = {
             :api_name => api_name,
             :version => version,
@@ -112,7 +109,6 @@ module AdsCommon
         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