google-ads-common 0.7.2 → 0.7.3

data/ChangeLog

@@ -1,3 +1,9 @@
+0.7.3:
+  - Compatibility with Savon -> 1.0.0 (not backward-compatible).
+  - Now require HTTPI ~> 1.0.0.
+  - HttpClient is no longer explicitely required.
+  - Support for OAuth2.0 authorization method.
+
 0.7.2:
   - Compatibility with savon-0.9.10 (not backward-compatible).
 

data/README

@@ -4,9 +4,6 @@ This gem is a dependency for the new generation of Ruby Google Ads client
 libraries. It contains common code shared among all of these libraries, such as
 authentication, SOAP stub generation, error handling, logging, etc.
 
-This is an early preview release, so a lot of things are still missing!
-
-
 = Docs for Users
 
 == 1 - Installation:
@@ -14,13 +11,12 @@ This is an early preview release, so a lot of things are still missing!
 google-ads-common is a Ruby gem.  See http://docs.rubygems.org/read/book/1
 
 Install it using the gem install command.
-   $ gem install --local google-ads-common-VERSION.gem
+   $ gem install google-ads-common
 
 The following gem libraries are required:
- - savon v0.9.9 or greater;
- - httpi v0.9.7 or greater;
- - httpclient v2.2.3 or greater;
- - oauth v0.4.5 or greater.
+ - savon
+ - httpi
+ - oauth
 
 = Docs for Developers
 

data/lib/ads_common/api.rb

@@ -26,6 +26,7 @@ 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'
 
 module AdsCommon
   class Api
@@ -110,12 +111,15 @@ module AdsCommon
         begin
           credentials = @credential_handler.credentials
           token = @auth_handler.get_token(credentials)
-        rescue AdsCommon::Errors::OAuthVerificationRequired => e
+        rescue AdsCommon::Errors::OAuthVerificationRequired,
+            AdsCommon::Errors::OAuth2VerificationRequired => e
           verification_code = (block_given?) ? yield(e.oauth_url) : nil
           # Retry with verification code if one provided.
           if verification_code
-            @credential_handler.set_credential(
-                :oauth_verification_code, verification_code)
+            code_symbol =
+                e.kind_of?(AdsCommon::Errors::OAuthVerificationRequired) ?
+                :oauth_verification_code : :oauth2_verification_code
+            @credential_handler.set_credential(code_symbol, verification_code)
             retry
           else
             raise e
@@ -193,6 +197,13 @@ module AdsCommon
               @config,
               api_config.environment_config(environment, :oauth_scope)
           )
+        when :OAUTH2
+          environment = @config.read('service.environment',
+              api_config.default_environment())
+          AdsCommon::Auth::OAuth2Handler.new(
+              @config,
+              api_config.environment_config(environment, :oauth_scope)
+          )
         else
           raise AdsCommon::Errors::Error,
               "Unknown authentication method '%s'" % auth_method

data/lib/ads_common/auth/oauth2_handler.rb

@@ -0,0 +1,219 @@
+# 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 authentication.
+
+require 'oauth2'
+
+require 'ads_common/auth/base_handler'
+require 'ads_common/errors'
+
+module AdsCommon
+  module Auth
+
+    # 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'
+      }
+      OAUTH2_HEADER = 'Bearer %s'
+      DEFAULT_CALLBACK = 'urn:ietf:wg:oauth:2.0:oob'
+
+      # 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 = scope
+      end
+
+      # Invalidates the stored token if the required credential has changed.
+      def property_changed(prop, value)
+        oauth2_keys = [:oauth2_client_id, :oauth2_client_secret, :oauth2_token]
+        if oauth2_keys.include?(prop)
+          @token, @client = 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 = nil)
+        return generate_oauth2_parameters_string(credentials)
+      end
+
+      # Overrides base get_token method to account for the token expiration.
+      def get_token(credentials = nil)
+        refresh_token! if !@token.nil? && @token.expired?
+        return super(credentials)
+      end
+
+      # Refreshes access token from refresh token.
+      def refresh_token!()
+        return nil if @token.nil? or @token.refresh_token.nil?
+        @token = @token.refresh!
+        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.token
+      end
+
+      # 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[:oauth2_client_id].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Client id is not included in the credentials.'
+        end
+
+        if credentials[:oauth2_client_secret].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Client secret is not included in the credentials.'
+        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)
+        return create_token_from_credentials(credentials, @client) ||
+            generate_access_token(credentials, @client)
+      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
+      end
+
+      # Creates access token based on data from credentials.
+      #
+      # Args:
+      # - credentials: a hash with the credentials for the account being
+      #   accessed. Has to include :oauth2_token key with a hash value that
+      #   represents a stored OAuth2 access token
+      # - client: OAuth2 client for the current configuration
+      #
+      # Returns:
+      # - 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)
+          access_token = OAuth2::AccessToken.new(
+              client, {:access_token => oauth2_token_hash})
+        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
+      # - client: OAuth2 client for the current configuration
+      #
+      # Returns:
+      # - The auth token for the account (as an AccessToken)
+      #
+      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]
+            }.reject {|k, v| v.nil?}
+            auth_url = client.auth_code.authorize_url(auth_options)
+            raise AdsCommon::Errors::OAuth2VerificationRequired.new(auth_url)
+          else
+            token = @client.auth_code.get_token(verification_code,
+                                                {:redirect_uri => callback})
+          end
+        rescue OAuth::Unauthorized => e
+          raise AdsCommon::Errors::AuthError,
+              'Authorization error occured: %s' % e
+        end
+        return token
+      end
+    end
+  end
+end

data/lib/ads_common/auth/oauth_handler.rb

@@ -17,7 +17,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This module manages OAuth authentication.
+# This module manages OAuth1.0a authentication.
 
 require 'oauth'
 
@@ -63,11 +63,6 @@ module AdsCommon
         raise error
       end
 
-      # Returns OAuth-specific Consumer object.
-      def get_oauth_consumer()
-        return @consumer
-      end
-
       # Returns authorization string.
       def auth_string(credentials, request)
         if request.nil?
@@ -257,23 +252,6 @@ module AdsCommon
             oauth_url, request_token)
         raise error
       end
-
-      # Extracts key-value pairs from OAuth server response.
-      #
-      # Args:
-      # - text: server response string
-      #
-      # Returns:
-      # - Hash of key-value pairs
-      #
-      def parse_token_text(text)
-        result = {}
-        text.split('&').each do |line|
-          key, value = line.split("=")
-          result[key.to_sym] = value
-        end
-        return result
-      end
     end
   end
 end

data/lib/ads_common/build/savon_registry.rb

@@ -23,6 +23,8 @@
 require 'savon'
 require 'rexml/document'
 
+require 'ads_common/utils'
+
 module AdsCommon
   module Build
     # Contains the methods that extracts WSDL data.

data/lib/ads_common/credential_handler.rb

@@ -19,6 +19,8 @@
 #
 # Generic class to handle credentials across client libraries.
 
+require 'ads_common/api_config'
+
 module AdsCommon
   class CredentialHandler
 
@@ -84,7 +86,7 @@ module AdsCommon
       agent_app ||= $0
       agent_data = extra_ids
       agent_data << "Common-Ruby/%s" % AdsCommon::ApiConfig::CLIENT_LIB_VERSION
-      agent_data << "Savon/%s" % Savon::Version
+      agent_data << "Savon/%s" % Savon::VERSION
       ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
       agent_data << [ruby_engine, RUBY_VERSION].join('/')
       agent_data << "HTTPI/%s" % HTTPI::VERSION

data/lib/ads_common/errors.rb

@@ -39,7 +39,7 @@ module AdsCommon
       end
     end
 
-    # Raised when OAuth access token is required.
+    # Raised when OAuth1.0a access token is required.
     class OAuthVerificationRequired < AuthError
       attr_reader :oauth_url, :request_token
       def initialize(oauth_url, request_token)
@@ -48,6 +48,15 @@ module AdsCommon
       end
     end
 
+    # Raised when OAuth2.0 access token is required.
+    class OAuth2VerificationRequired < AuthError
+      attr_reader :oauth_url
+      def initialize(oauth_url)
+        super()
+        @oauth_url = oauth_url
+      end
+    end
+
     # Raised when ClientLogin Captcha challenge occurs.
     class CaptchaRequiredError < AuthError
       attr_reader :error, :captcha_token

data/lib/ads_common/version.rb

@@ -21,6 +21,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.7.2'
+    CLIENT_LIB_VERSION = '0.7.3'
   end
 end

data/test/test_credential_handler.rb

@@ -52,4 +52,11 @@ class TestCredentialHandler < Test::Unit::TestCase
     assert_equal(42, credentials[:client_customer_id])
     assert_equal('bar', credentials[:foo])
   end
+
+  def test_generate_user_agent_simple()
+    result1 = @handler.generate_http_user_agent()
+    assert_kind_of(String, result1)
+    result2 = @handler.generate_soap_user_agent()
+    assert_kind_of(String, result2)
+  end
 end

metadata

@@ -1,88 +1,97 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: google-ads-common
-version: !ruby/object:Gem::Version
-  version: 0.7.2
+version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 3
+  version: 0.7.3
 platform: ruby
-authors:
+authors: 
 - Sergio Gomes
 - Danial Klimkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-06-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: savon
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.3
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: httpi
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.7
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.7
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: oauth
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 4
+        - 5
         version: 0.4.5
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: oauth2
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.5
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id004
 description: Essential utilities shared by all Ads Ruby client libraries
-email:
+email: 
 - api.dklimkin@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/ads_common/api.rb
 - lib/ads_common/utils.rb
 - lib/ads_common/version.rb
@@ -90,6 +99,7 @@ files:
 - lib/ads_common/savon_service.rb
 - 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/http.rb
@@ -120,29 +130,40 @@ files:
 - ChangeLog
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: google-ads-common
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common code for Google Ads APIs
-test_files:
+test_files: 
 - test/test_savon_service.rb
 - test/test_results_extractor.rb
 - test/test_credential_handler.rb