google-ads-common 0.9.9 → 0.10.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmEwMDIzYWQwNzlmYjA4ZjE0OTMzZmMwZjg4YjQ4ZDIxNGRlMDdjOA==
+    ODExZjI0NTAwNDdmOWY2NzcxNGMwZmJlNDc1ZTg4YmRkYWVmM2VlMg==
   data.tar.gz: !binary |-
-    ZTg0NmJiYmFlOWJkYjA4NDhjYTRiNzVhOTNjYmNhZWQ0Mjk0NjYzMg==
+    YzdhOWY3OGMxMjYxMzJjYTZhY2YwNTMyY2YwZmU4YmVkZjAxMzM5OA==
 SHA512:
   metadata.gz: !binary |-
-    MGZkMGUwMWQ2ZjkyNzk2MGMyMjU4YzFkMDEyYzAxMDY1ZGQ0NTdjZDRhMTMy
-    OGJkY2Q0NmU2NTZhYmZiYzEzODY4ZGZkN2EwMjVkNDY3NzAxZDBkYjcwM2E5
-    N2I2ZjFjMzAxNGQ1MzhjMjFjMWU0MmE4NmY2YmZlZWI5MjkxNzY=
+    MTllZWU2NDdhOWU1YzExNTYxM2ZjNTI5MzA1OTY5NzgwNDBiYzRmMTFiNDQ0
+    NmVhMWQ0NmJiNjY0MjFlNzFmYmRiNjNlYzdhNjgyMjIxN2E5Njc1Zjk3NTVl
+    MTdiMjhkZWQ1YTJjMmQzOTU5YWUwN2U0YjAzNGY5MmYxOWE1N2U=
   data.tar.gz: !binary |-
-    OGEwNmUyZTVkYWE5Yzg1ODcxNWYyYjQ3ZTI0YWRhYjcxZDhiYmMyNDlkMTRj
-    OGM5OTM5NTRlODlmNTU4ZTdmYTZmZmM1ODk2NzM2M2M3Mjg1ZDJhYjYzM2Yw
-    Mzc3MDk0MGI2ZjRlMTA0YzU2NTg2OThkNDA2ZDA3OTM1ZGI3Y2Q=
+    MjZkNTA3MWE0ZTJlY2U2ODM0OGM2MTg2NGIyYzY5ZDE4MDM3NWEzYjM3Yjk5
+    MmM0ODQ3NDdhNjI5MjE2YWQ1ZGFjMDI0NDViMmEwNzdhY2UxOTIwOTNiZjc0
+    ZTIwNjFmOGQ1YWExNTM2OWM4NjAyNmE2MzY1YTI4YWI4NTM3OTc=

data/ChangeLog

@@ -1,3 +1,6 @@
+0.10.0:
+  - Renamed all references of OAUTH2 JWT to OAUTH2 Service Account.
+
 0.9.9:
   - Fixing minor issue where signet doesn't handle String-based times.
 

data/lib/ads_common/api.rb

@@ -25,7 +25,7 @@ require 'ads_common/config'
 require 'ads_common/errors'
 require 'ads_common/utils'
 require 'ads_common/auth/oauth2_handler'
-require 'ads_common/auth/oauth2_jwt_handler'
+require 'ads_common/auth/oauth2_service_account_handler'
 
 module AdsCommon
   class Api
@@ -201,10 +201,10 @@ module AdsCommon
               @config,
               api_config.environment_config(environment, :oauth_scope)
           )
-        when :OAUTH2_JWT
+        when :OAUTH2_SERVICE_ACCOUNT_
           environment = @config.read('service.environment',
               api_config.default_environment())
-          AdsCommon::Auth::OAuth2JwtHandler.new(
+          AdsCommon::Auth::OAuth2ServiceAccountHandler.new(
               @config,
               api_config.environment_config(environment, :oauth_scope)
           )

data/lib/ads_common/auth/{oauth2_jwt_handler.rb → oauth2_service_account_handler.rb}

@@ -17,7 +17,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This module manages OAuth2.0 JWT authentication.
+# This module manages OAuth2.0 service account authentication.
 
 require 'faraday'
 require 'signet/oauth_2/client'
@@ -29,7 +29,7 @@ module AdsCommon
   module Auth
 
     # Credentials class to handle OAuth2.0 authentication.
-    class OAuth2JwtHandler < AdsCommon::Auth::BaseHandler
+    class OAuth2ServiceAccountHandler < AdsCommon::Auth::BaseHandler
 
       OAUTH2_CONFIG = {
         :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
@@ -60,7 +60,8 @@ module AdsCommon
         raise error
       end
 
-      # Generates auth string for OAuth2.0 JWT method of authentication.
+      # Generates auth string for OAuth2.0 service account method of
+      # authentication.
       #
       # Args:
       # - credentials: credentials set for authorization
@@ -91,7 +92,8 @@ module AdsCommon
 
       private
 
-      # Auxiliary method to validate the credentials for JWT authentication.
+      # Auxiliary method to validate the credentials for service account
+      # authentication.
       #
       # Args:
       # - credentials: a hash with the credentials for the account being
@@ -121,18 +123,18 @@ module AdsCommon
 
         if credentials[:oauth2_key].nil? && credentials[:oauth2_keyfile].nil?
           raise AdsCommon::Errors::AuthError,
-              'Either key or key file must be provided for OAuth2 JWT.'
+              'Either key or key file must be provided for OAuth2 service account.'
         end
 
         if credentials[:oauth2_key] && credentials[:oauth2_keyfile]
           raise AdsCommon::Errors::AuthError,
-              'Both JWT key and key file provided, only one can be used.'
+              'Both service account 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.'
+              'OAuth2 service account key provided must be of type OpenSSL::PKey::RSA.'
         end
 
         if credentials[:oauth2_keyfile] &&
@@ -167,7 +169,7 @@ module AdsCommon
 
       # Creates a Signet client based on credentials.
       def create_client(credentials)
-        credentials = load_oauth2_jwt_credentials(credentials)
+        credentials = load_oauth2_service_account_credentials(credentials)
         oauth_options = OAUTH2_CONFIG.merge({
             :issuer => credentials[:oauth2_issuer],
             :signing_key => credentials[:oauth2_key],
@@ -177,8 +179,8 @@ module AdsCommon
         return Signet::OAuth2::Client.new(oauth_options)
       end
 
-      # Loads JWT key if configured with a filename.
-      def load_oauth2_jwt_credentials(credentials)
+      # Loads service account key if configured with a filename.
+      def load_oauth2_service_account_credentials(credentials)
         return credentials unless credentials.include?(:oauth2_keyfile)
         key_file = File.read(credentials[:oauth2_keyfile])
         key_secret = credentials[:oauth2_secret]

data/lib/ads_common/version.rb

@@ -21,6 +21,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.9.9'
+    CLIENT_LIB_VERSION = '0.10.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.10.0
 platform: ruby
 authors:
 - Sergio Gomes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -66,9 +66,8 @@ files:
 - lib/ads_common/api.rb
 - lib/ads_common/api_config.rb
 - lib/ads_common/auth/base_handler.rb
-- lib/ads_common/auth/client_login_handler.rb
 - lib/ads_common/auth/oauth2_handler.rb
-- lib/ads_common/auth/oauth2_jwt_handler.rb
+- lib/ads_common/auth/oauth2_service_account_handler.rb
 - lib/ads_common/build/savon_abstract_generator.rb
 - lib/ads_common/build/savon_generator.rb
 - lib/ads_common/build/savon_registry.rb

data/lib/ads_common/auth/client_login_handler.rb

@@ -1,198 +0,0 @@
-# Encoding: utf-8
-#
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2010, 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 ClientLogin authentication. It either uses a user-provided
-# auth token, or automatically connects to Google's ClientLogin service and
-# generates an auth token that can be used to login to an API.
-
-require 'cgi'
-require 'ads_common/http'
-require 'ads_common/auth/base_handler'
-require 'ads_common/errors'
-
-module AdsCommon
-  module Auth
-
-    # Credentials class to handle ClientLogin authentication.
-    class ClientLoginHandler < AdsCommon::Auth::BaseHandler
-      ACCOUNT_TYPE = 'GOOGLE'
-      AUTH_PATH = '/accounts/ClientLogin'
-      AUTH_PREFIX = 'GoogleLogin auth='
-      CAPTCHA_PATH = '/accounts/'
-
-      # Initializes the ClientLoginHandler with all the necessary details.
-      def initialize(config, auth_server, service_name)
-        super(config)
-        @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 [: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 authorization string.
-      def auth_string(credentials)
-        return [AUTH_PREFIX, get_token(credentials)].join
-      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 credentials.nil?
-          raise AdsCommon::Errors::AuthError, 'No credentials supplied.'
-        end
-
-        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
-
-      # Auxiliary method to generate an authentication token for login in via
-      # the ClientLogin API.
-      #
-      # Args:
-      # - credentials: a hash with the credentials for the account being
-      #   accessed
-      #
-      # Returns:
-      # - The auth token for the account
-      #
-      # Raises:
-      # - AdsCommon::Errors::AuthError if authentication fails
-      #
-      def create_token(credentials)
-        token = credentials.include?(:auth_token) ?
-            create_token_from_string(credentials[:auth_token]) :
-            generate_token(credentials)
-        return token
-      end
-
-      # 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])
-        service_name = @service_name
-        data = "accountType=%s&Email=%s&Passwd=%s&service=%s" %
-            [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)
-        results = parse_token_text(response.body)
-
-        if response.code == 200 and results.include?('Auth')
-          return results['Auth']
-        else
-          handle_login_error(credentials, response, results)
-        end
-      end
-
-      # Raises relevant error based on response and parsed results.
-      def handle_login_error(credentials, response, results)
-        # Handling for known errors.
-        if 'CaptchaRequired'.eql?(results['Error'])
-          captcha_url = @server + CAPTCHA_PATH + results['CaptchaUrl']
-          raise AdsCommon::Errors::CaptchaRequiredError.new(results['Error'],
-              results['CaptchaToken'], captcha_url, results['Url'])
-        end
-        # For other errors throwing a generic error.
-        error_message = "ClientLogin failed for email '%s': HTTP code %d." %
-            [credentials[:email], response.code]
-        error_str = results['Error'] || response.body
-        error_message += " Error: %s." % error_str if error_str
-        if results.include?('Info')
-          error_message += " Info: %s." % results['Info']
-        end
-        raise AdsCommon::Errors::AuthError.new(error_message, error_str,
-            results['Info'])
-      end
-
-      # Extracts key-value pairs from ClientLogin server response.
-      #
-      # Args:
-      # - text: server response string
-      #
-      # Returns:
-      #   Hash of key-value pairs
-      #
-      def parse_token_text(text)
-        return text.split("\n").inject({}) do |result, line|
-          key, *values = line.split('=')
-          result[key] = values.join('=')
-          result
-        end
-      end
-    end
-  end
-end