google-ads-common 0.8.2 → 0.9.0

data/ChangeLog

@@ -1,3 +1,8 @@
+0.9.0:
+  - Switched to Signet OAuth implementation.
+  - Removed deprecated OAuth1.0a scheme, please use OAuth2.0 instead.
+  - Support for JWT authorization (OAuth2 service accounts).
+
 0.8.2:
   - Fixed issue #89.
 

data/README

@@ -16,8 +16,7 @@ Install it using the gem install command.
 The following gem libraries are required:
  - savon
  - httpi
- - oauth
- - oauth2
+ - signet
 
 = Docs for Developers
 

data/lib/ads_common/api.rb

@@ -25,8 +25,8 @@ require 'ads_common/config'
 require 'ads_common/errors'
 require 'ads_common/utils'
 require 'ads_common/auth/client_login_handler'
-require 'ads_common/auth/oauth_handler'
 require 'ads_common/auth/oauth2_handler'
+require 'ads_common/auth/oauth2_jwt_handler'
 
 module AdsCommon
   class Api
@@ -111,15 +111,12 @@ module AdsCommon
         begin
           credentials = @credential_handler.credentials
           token = @auth_handler.get_token(credentials)
-        rescue AdsCommon::Errors::OAuthVerificationRequired,
-            AdsCommon::Errors::OAuth2VerificationRequired => e
+        rescue AdsCommon::Errors::OAuth2VerificationRequired => e
           verification_code = (block_given?) ? yield(e.oauth_url) : nil
           # Retry with verification code if one provided.
           if verification_code
-            code_symbol =
-                e.kind_of?(AdsCommon::Errors::OAuthVerificationRequired) ?
-                :oauth_verification_code : :oauth2_verification_code
-            @credential_handler.set_credential(code_symbol, verification_code)
+            @credential_handler.set_credential(
+                :oauth2_verification_code, verification_code)
             retry
           else
             raise e
@@ -195,16 +192,19 @@ module AdsCommon
               api_config.client_login_config(:LOGIN_SERVICE_NAME)
           )
         when :OAUTH
+          raise AdsCommon::Errors::Error,
+              'OAuth authorization method is deprecated, use OAuth2 instead.'
+        when :OAUTH2
           environment = @config.read('service.environment',
               api_config.default_environment())
-          AdsCommon::Auth::OAuthHandler.new(
+          AdsCommon::Auth::OAuth2Handler.new(
               @config,
               api_config.environment_config(environment, :oauth_scope)
           )
-        when :OAUTH2
+        when :OAUTH2_JWT
           environment = @config.read('service.environment',
               api_config.default_environment())
-          AdsCommon::Auth::OAuth2Handler.new(
+          AdsCommon::Auth::OAuth2JwtHandler.new(
               @config,
               api_config.environment_config(environment, :oauth_scope)
           )

data/lib/ads_common/auth/base_handler.rb

@@ -52,7 +52,7 @@ module AdsCommon
       end
 
       # Returns authorization string. Needs to be overridden.
-      def auth_string(credentials, request)
+      def auth_string(credentials)
         raise NotImplementedError, 'auth_string not overridden.'
       end
 

data/lib/ads_common/auth/client_login_handler.rb

@@ -63,7 +63,7 @@ module AdsCommon
       end
 
       # Returns authorization string.
-      def auth_string(credentials, request)
+      def auth_string(credentials)
         return [AUTH_PREFIX, get_token(credentials)].join
       end
 

data/lib/ads_common/auth/oauth2_handler.rb

@@ -19,7 +19,8 @@
 #
 # This module manages OAuth2.0 authentication.
 
-require 'oauth2'
+require 'faraday'
+require 'signet/oauth_2/client'
 
 require 'ads_common/auth/base_handler'
 require 'ads_common/errors'
@@ -30,11 +31,11 @@ module AdsCommon
     # Credentials class to handle OAuth2.0 authentication.
     class OAuth2Handler < AdsCommon::Auth::BaseHandler
       OAUTH2_CONFIG = {
-          :site => 'https://accounts.google.com',
-          :authorize_url => '/o/oauth2/auth',
-          :token_url => '/o/oauth2/token'
+          :authorization_uri =>
+            'https://accounts.google.com/o/oauth2/auth',
+          :token_credential_uri =>
+            'https://accounts.google.com/o/oauth2/token'
       }
-      OAUTH2_HEADER = 'Bearer %s'
       DEFAULT_CALLBACK = 'urn:ietf:wg:oauth:2.0:oob'
 
       # Initializes the OAuthHandler2 with all the necessary details.
@@ -45,7 +46,7 @@ module AdsCommon
       #
       def initialize(config, scope)
         super(config)
-        @scope = scope
+        @scope, @client = scope, nil
       end
 
       # Invalidates the stored token if the required credential has changed.
@@ -62,40 +63,37 @@ module AdsCommon
         raise error
       end
 
-      # Returns authorization string.
-      def auth_string(credentials, request = nil)
-        return generate_oauth2_parameters_string(credentials)
+      # Generates auth string for OAuth2.0 method of authentication.
+      #
+      # Args:
+      # - credentials: credentials set for authorization
+      #
+      # Returns:
+      # - Authentication string
+      #
+      def auth_string(credentials)
+        token = get_token(credentials)
+        return ::Signet::OAuth2.generate_bearer_authorization_header(
+            token[:access_token])
       end
 
       # Overrides base get_token method to account for the token expiration.
       def get_token(credentials = nil)
         token = super(credentials)
-        token = refresh_token! if !token.nil? && token.expired?
-        return oauth_token_to_hash(token)
+        token = refresh_token! if !@client.nil? && @client.expired?
+        return token
       end
 
       # Refreshes access token from refresh token.
       def refresh_token!()
-        return nil if @token.nil? or @token.refresh_token.nil?
-        @token = @token.refresh!
+        return nil if @token.nil? or @token[:refresh_token].nil?
+        @client.refresh!
+        @token = token_from_client(@client)
         return @token
       end
 
       private
 
-      # Generates auth string for OAuth2.0 method of authentication.
-      #
-      # Args:
-      # - credentials: credentials set for authorization
-      #
-      # Returns:
-      # - Authentication string
-      #
-      def generate_oauth2_parameters_string(credentials)
-        token = get_token(credentials)
-        return OAUTH2_HEADER % token[:access_token]
-      end
-
       # Auxiliary method to validate the credentials for token generation.
       #
       # Args:
@@ -154,15 +152,14 @@ module AdsCommon
       end
 
       def create_client(credentials)
-        oauth2_config = OAUTH2_CONFIG.dup()
-        proxy = @config.read('connection.proxy')
-        unless proxy.nil?
-          oauth2_config.merge!({:connection_opts => {:proxy => proxy}})
-        end
-        client = OAuth2::Client.new(credentials[:oauth2_client_id],
-                                    credentials[:oauth2_client_secret],
-                                    oauth2_config)
-        return client
+        oauth_options = OAUTH2_CONFIG.merge({
+            :client_id => credentials[:oauth2_client_id],
+            :client_secret => credentials[:oauth2_client_secret],
+            :scope => @scope,
+            :redirect_uri => credentials[:oauth2_callback] || DEFAULT_CALLBACK,
+            :state => credentials[:oauth2_state]
+        }).reject {|k, v| v.nil?}
+        return Signet::OAuth2::Client.new(oauth_options)
       end
 
       # Creates access token based on data from credentials.
@@ -177,13 +174,12 @@ module AdsCommon
       # - The auth token for the account (as an AccessToken)
       #
       def create_token_from_credentials(credentials, client)
-        access_token = nil
         oauth2_token_hash = credentials[:oauth2_token]
         if !oauth2_token_hash.nil? && oauth2_token_hash.kind_of?(Hash)
-          token_data = oauth2_token_hash.dup()
-          access_token = OAuth2::AccessToken.from_hash(client, token_data)
+          token_data = AdsCommon::Utils.hash_keys_to_str(oauth2_token_hash)
+          client.update_token!(token_data)
         end
-        return access_token
+        return token_from_client(client)
       end
 
       # Generates new request tokens and authorizes it to get access token.
@@ -194,45 +190,43 @@ module AdsCommon
       # - client: OAuth2 client for the current configuration
       #
       # Returns:
-      # - The auth token for the account (as an AccessToken)
+      # - The auth token for the account (as Hash)
       #
       def generate_access_token(credentials, client)
         token = nil
         begin
-          callback = credentials[:oauth2_callback] || DEFAULT_CALLBACK
           verification_code = credentials[:oauth2_verification_code]
           if verification_code.nil? || verification_code.empty?
-            auth_options = {
-                :redirect_uri => callback,
-                :scope => @scope,
-                :state => credentials[:oauth2_state],
-                :access_type => credentials[:oauth2_access_type],
-                :approval_prompt => credentials[:oauth2_approval_prompt]
+            uri_options = {
+              :access_type => credentials[:oauth2_access_type],
+              :approval_prompt => credentials[:oauth2_approval_prompt]
             }.reject {|k, v| v.nil?}
-            auth_url = client.auth_code.authorize_url(auth_options)
-            raise AdsCommon::Errors::OAuth2VerificationRequired.new(auth_url)
+            oauth_url = client.authorization_uri(uri_options)
+            raise AdsCommon::Errors::OAuth2VerificationRequired.new(oauth_url)
           else
-            token = @client.auth_code.get_token(verification_code,
-                                                {:redirect_uri => callback})
+            client.code = verification_code
+            proxy = @config.read('connection.proxy')
+            connection = (proxy.nil?) ? nil : Faraday.new(:proxy => proxy)
+            token = AdsCommon::Utils.hash_keys_to_sym(
+                client.fetch_access_token!(:connection => connection))
           end
-        rescue OAuth::Unauthorized => e
+        rescue Signet::AuthorizationError => e
           raise AdsCommon::Errors::AuthError,
               'Authorization error occured: %s' % e
         end
         return token
       end
 
-      # Converts OAuth token object into hash structure.
-      def oauth_token_to_hash(token)
-        return token.nil? ? nil :
-            {
-              :access_token => token.token,
-              :refresh_token => token.refresh_token,
-              :expires_in => token.expires_in,
-              :expires_at => token.expires_at,
-              :params => token.params,
-              :options => token.options
-            }
+      # Create a token Hash from a client.
+      def token_from_client(client)
+        return nil if client.refresh_token.nil? && client.access_token.nil?
+        return {
+          :access_token => client.access_token,
+          :refresh_token => client.refresh_token,
+          :issued_at => client.issued_at,
+          :expires_in => client.expires_in,
+          :id_token => client.id_token
+        }
       end
     end
   end

data/lib/ads_common/auth/oauth2_jwt_handler.rb

@@ -0,0 +1,201 @@
+# Encoding: utf-8
+#
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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.
+#
+# This module manages OAuth2.0 JWT authentication.
+
+require 'faraday'
+require 'signet/oauth_2/client'
+
+require 'ads_common/auth/base_handler'
+require 'ads_common/errors'
+
+module AdsCommon
+  module Auth
+
+    # Credentials class to handle OAuth2.0 authentication.
+    class OAuth2JwtHandler < AdsCommon::Auth::BaseHandler
+
+      OAUTH2_CONFIG = {
+        :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
+        :audience => 'https://accounts.google.com/o/oauth2/token'
+      }
+
+      # Initializes the OAuthHandler2 with all the necessary details.
+      #
+      # Args:
+      # - config: Config object with library configuration
+      # - scope: OAuth authorization scope
+      #
+      def initialize(config, scope)
+        super(config)
+        @scope, @client = scope, nil
+      end
+
+      # Invalidates the stored token if the required credential has changed.
+      def property_changed(prop, value)
+        oauth2_keys =
+            [:oauth2_issuer, :oauth2_secret, :oauth2_keyfile, :oauth2_key]
+        @client = nil if oauth2_keys.include?(prop)
+      end
+
+      def handle_error(error)
+        # TODO: Add support.
+        get_logger().error(error)
+        raise error
+      end
+
+      # Generates auth string for OAuth2.0 JWT method of authentication.
+      #
+      # Args:
+      # - credentials: credentials set for authorization
+      #
+      # Returns:
+      # - Authentication string
+      #
+      def auth_string(credentials)
+        token = get_token(credentials)
+        return ::Signet::OAuth2.generate_bearer_authorization_header(
+                    token[:access_token])
+      end
+
+      # Overrides base get_token method to account for the token expiration.
+      def get_token(credentials = nil)
+        token = super(credentials)
+        token = refresh_token! if !@client.nil? && @client.expired?
+        return token
+      end
+
+      # Refreshes access token from refresh token.
+      def refresh_token!()
+        return nil if @token.nil? or @token[:refresh_token].nil?
+        @client.refresh!
+        @token = token_from_client(@client)
+        return @token
+      end
+
+      private
+
+      # Auxiliary method to validate the credentials for JWT authentication.
+      #
+      # Args:
+      # - credentials: a hash with the credentials for the account being
+      #   accessed
+      #
+      # Raises:
+      # - 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
+
+        if credentials[:oauth2_issuer].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Issuer is not included in the credentials.'
+        end
+
+        if credentials[:oauth2_secret].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Key secret is not included in the credentials.'
+        end
+
+        if credentials[:oauth2_key].nil? && credentials[:oauth2_keyfile].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Either key or key file must be provided for OAuth2 JWT.'
+        end
+
+        if credentials[:oauth2_key] && credentials[:oauth2_keyfile]
+          raise AdsCommon::Errors::AuthError,
+              'Both JWT key and key file provided, only one can be used.'
+        end
+
+        if credentials[:oauth2_key] &&
+            !credentials[:oauth2_key].kind_of?(OpenSSL::PKey::RSA)
+          raise AdsCommon::Errors::AuthError,
+              'OAuth2 JWT key provided must be of type OpenSSL::PKey::RSA.'
+        end
+
+        if credentials[:oauth2_keyfile] &&
+            !File.file?(credentials[:oauth2_keyfile])
+          raise AdsCommon::Errors::AuthError,
+              "Key file '%s' does not exist or not a file."
+        end
+      end
+
+      # Auxiliary method to generate an authentication token for logging via
+      # the OAuth2.0 API.
+      #
+      # Args:
+      # - credentials: a hash with the credentials for the account being
+      #   accessed
+      #
+      # Returns:
+      # - The auth token for the account (as an AccessToken)
+      #
+      # Raises:
+      # - AdsCommon::Errors::AuthError if authentication fails
+      # - AdsCommon::Errors::OAuthVerificationRequired if OAuth verification
+      #   code required
+      #
+      def create_token(credentials)
+        validate_credentials(credentials)
+        @client ||= create_client(credentials)
+        @client.fetch_access_token!()
+        return token_from_client(@client)
+      end
+
+      # Creates a Signet client based on credentials.
+      def create_client(credentials)
+        credentials = load_oauth2_jwt_credentials(credentials)
+        oauth_options = OAUTH2_CONFIG.merge({
+            :issuer => credentials[:oauth2_issuer],
+            :signing_key => credentials[:oauth2_key],
+            :scope => @scope,
+        })
+        return Signet::OAuth2::Client.new(oauth_options)
+      end
+
+      # Loads JWT key if configured with a filename.
+      def load_oauth2_jwt_credentials(credentials)
+        return credentials unless credentials.include?(:oauth2_keyfile)
+        key_file = File.read(credentials[:oauth2_keyfile])
+        key_secret = credentials[:oauth2_secret]
+        key = OpenSSL::PKCS12.new(key_file, key_secret).key
+        result = credentials.merge({:oauth2_key => key})
+        result.delete(:oauth2_keyfile)
+        return result
+      end
+
+      # Create a token Hash from a client.
+      def token_from_client(client)
+        return nil if client.access_token.nil?
+        return {
+          :access_token => client.access_token,
+          :issued_at => client.issued_at,
+          :expires_in => client.expires_in,
+          :id_token => client.id_token
+        }
+      end
+    end
+  end
+end

data/lib/ads_common/errors.rb

@@ -39,15 +39,6 @@ module AdsCommon
       end
     end
 
-    # Raised when OAuth1.0a access token is required.
-    class OAuthVerificationRequired < AuthError
-      attr_reader :oauth_url, :request_token
-      def initialize(oauth_url, request_token)
-        super()
-        @oauth_url, @request_token = oauth_url, request_token
-      end
-    end
-
     # Raised when OAuth2.0 access token is required.
     class OAuth2VerificationRequired < AuthError
       attr_reader :oauth_url

data/lib/ads_common/savon_headers/oauth_header_handler.rb

@@ -20,7 +20,6 @@
 # Handles SOAP headers and namespaces definition for OAuth type header.
 
 require 'ads_common/savon_headers/base_header_handler'
-require 'ads_common/savon_headers/httpi_request_proxy'
 
 module AdsCommon
   module SavonHeaders
@@ -43,7 +42,7 @@ module AdsCommon
         credentials = @credential_handler.credentials
         request.url = soap.endpoint
         request.headers['Authorization'] =
-            @auth_handler.auth_string(credentials, request)
+            @auth_handler.auth_string(credentials)
       end
     end
   end

data/lib/ads_common/utils.rb

@@ -31,6 +31,24 @@ module AdsCommon
         return result
       end
     end
+
+    # Converts all hash keys to strings.
+    def self.hash_keys_to_str(data)
+      return nil if data.nil?
+      return data.inject({}) do |result, (k, v)|
+        result[k.to_s] = v
+        result
+      end
+    end
+
+    # Converts all hash keys to symbols.
+    def self.hash_keys_to_sym(data)
+      return nil if data.nil?
+      return data.inject({}) do |result, (k, v)|
+        result[k.to_sym] = v
+        result
+      end
+    end
   end
 end
 

data/lib/ads_common/version.rb

@@ -21,6 +21,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.8.2'
+    CLIENT_LIB_VERSION = '0.9.0'
   end
 end

data/test/test_utils.rb

@@ -54,4 +54,25 @@ class TestUtils < Test::Unit::TestCase
     assert_not_same(str, result)
     assert_equal('str_snake', str)
   end
+
+  def test_hash_keys_to_str()
+    data = {:a => 'aa', :b5 => 43, 'xyz' => :abc}
+    result = AdsCommon::Utils.hash_keys_to_str(data)
+    assert_equal('aa', result['a'])
+    assert_equal(43, result['b5'])
+    assert_equal(:abc, result['xyz'])
+    assert_equal(3, result.size)
+    assert_not_same(result, data)
+  end
+
+  def test_hash_keys_to_sym()
+    data = {:a => 'aa', :b5 => 43, 'xyz' => :abc, 'f5' => :xyz}
+    result = AdsCommon::Utils.hash_keys_to_sym(data)
+    assert_equal('aa', result[:a])
+    assert_equal(43, result[:b5])
+    assert_equal(:abc, result[:xyz])
+    assert_equal(:xyz, result[:f5])
+    assert_equal(4, result.size)
+    assert_not_same(result, data)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -45,13 +45,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: signet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,23 +59,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.5
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.4.4
 description: Essential utilities shared by all Ads Ruby client libraries
 email:
 - api.dklimkin@gmail.com
@@ -91,14 +75,13 @@ files:
 - lib/ads_common/api_config.rb
 - lib/ads_common/auth/client_login_handler.rb
 - lib/ads_common/auth/oauth2_handler.rb
-- lib/ads_common/auth/oauth_handler.rb
 - lib/ads_common/auth/base_handler.rb
+- lib/ads_common/auth/oauth2_jwt_handler.rb
 - lib/ads_common/http.rb
 - lib/ads_common/errors.rb
 - lib/ads_common/parameters_validator.rb
 - lib/ads_common/savon_headers/oauth_header_handler.rb
 - lib/ads_common/savon_headers/base_header_handler.rb
-- lib/ads_common/savon_headers/httpi_request_proxy.rb
 - lib/ads_common/results_extractor.rb
 - lib/ads_common/build/savon_abstract_generator.rb
 - lib/ads_common/build/savon_service_generator.rb

data/lib/ads_common/auth/oauth_handler.rb

@@ -1,257 +0,0 @@
-# Encoding: utf-8
-#
-# Authors:: 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.
-#
-# This module manages OAuth1.0a authentication.
-
-require 'oauth'
-
-require 'ads_common/auth/base_handler'
-require 'ads_common/errors'
-
-module AdsCommon
-  module Auth
-
-    # Credentials class to handle OAuth authentication.
-    class OAuthHandler < AdsCommon::Auth::BaseHandler
-      OAUTH_CONFIG = {
-          :site => 'https://www.google.com',
-          :request_token_path => '/accounts/OAuthGetRequestToken',
-          :access_token_path => '/accounts/OAuthGetAccessToken',
-          :authorize_path => '/accounts/OAuthAuthorizeToken'
-      }
-
-      DEFAULT_CALLBACK = 'oob'
-      DEFAULT_METHOD = 'HMAC-SHA1'
-
-      # Initializes the OAuthHandler with all the necessary details.
-      #
-      # Args:
-      # - config: Config object with library configuration
-      # - scope: OAuth authorization scope
-      #
-      def initialize(config, scope)
-        super(config)
-        @scope = scope
-      end
-
-      # 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
-      end
-
-      def handle_error(error)
-        # TODO: Add support.
-        get_logger().error(error)
-        raise error
-      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
-
-      private
-
-      # 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)
-        # get_token() ensures @consumer is initialized.
-        token = get_token(credentials)
-        oauth_params = {
-            :consumer => @consumer,
-            :token => token
-        }
-        oauth_helper = OAuth::Client::Helper.new(request, oauth_params)
-        return oauth_helper.header
-      end
-
-      private
-
-      # Auxiliary method to validate the credentials for token generation.
-      #
-      # Args:
-      # - credentials: a hash with the credentials for the account being
-      #   accessed
-      #
-      # Raises:
-      # - 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
-
-        if credentials[:oauth_consumer_key].nil?
-          raise AdsCommon::Errors::AuthError,
-              'Consumer key not included in credentials.'
-        end
-
-        if credentials[:oauth_consumer_secret].nil?
-          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
-      # the OAuth API.
-      #
-      # Args:
-      # - credentials: a hash with the credentials for the account being
-      #   accessed
-      #
-      # Returns:
-      # - The auth token for the account (as an AccessToken)
-      #
-      # Raises:
-      # - AdsCommon::Errors::AuthError if authentication fails
-      # - AdsCommon::Errors::OAuthVerificationRequired if OAuth verification
-      #   code required
-      #
-      def create_token(credentials)
-        validate_credentials(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.
-      #
-      # 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, consumer)
-        token = credentials[:oauth_token]
-        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
-
-      # Generates new request tokens and authorizes it to get access token.
-      #
-      # 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, 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}
-                 )
-          end
-          verification_code = credentials[:oauth_verification_code]
-          if verification_code.nil? || verification_code.empty?
-            raise_oauth_verification_error(@request_token, callback)
-          else
-            token = @request_token.get_access_token(
-                {:oauth_verifier => verification_code})
-            @request_token = nil
-          end
-        rescue OAuth::Unauthorized => e
-          if @request_token
-            raise_oauth_verification_error(@request_token, callback)
-          else
-            raise AdsCommon::Errors::AuthError,
-                "Authorization error occured: %s" % e
-          end
-        end
-        return token
-      end
-
-      # Raises a OAuthVerificationRequired error with auth URL for given
-      # request token.
-      #
-      # Args:
-      # - request_token: an initialized OAuth request token
-      # - callback: OAuth callback URL
-      #
-      # Returns:
-      # - never returns
-      #
-      # Raises:
-      # - AdsCommon::Errors::OAuthVerificationRequired in all cases
-      #
-      def raise_oauth_verification_error(request_token, callback)
-        oauth_url = request_token.authorize_url({:oauth_callback => callback})
-        error = AdsCommon::Errors::OAuthVerificationRequired.new(
-            oauth_url, request_token)
-        raise error
-      end
-    end
-  end
-end

data/lib/ads_common/savon_headers/httpi_request_proxy.rb

@@ -1,51 +0,0 @@
-# Encoding: utf-8
-#
-# Authors:: 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.
-#
-# OAuth request proxy for HTTPI::Request.
-
-require 'oauth/request_proxy/base'
-require 'httpi/request'
-
-module OAuth
-  module RequestProxy
-    class HTTPIRequest < OAuth::RequestProxy::Base
-      proxies HTTPI::Request
-
-      # HTTP method to use.
-      def method
-        return 'POST'
-      end
-
-      # Request URL.
-      def uri
-        request.url.to_s
-      end
-
-      # Query parameters.
-      def parameters
-        options[:parameters]
-      end
-
-      # Request body.
-      def body
-        request.body
-      end
-    end
-  end
-end