google-ads-common 0.12.0 → 0.12.1

data/ChangeLog

@@ -1,3 +1,6 @@
+0.12.1:
+  - Adding support for JSON keyfiles for service accounts.
+
 0.12.0:
   - Require Ruby version 2.0 or higher from now on. It is recommended to use
     Ruby version 2.1 or higher.
@@ -62,7 +65,7 @@
 
 0.9.0:
   - Switched to Signet OAuth implementation.
-  - Removed deprecated OAuth1.0a scheme, please use OAuth2.0 instead.
+  - Removed deprecated OAuth1.0a scheme, please use OAuth2 instead.
   - Support for JWT authorization (OAuth2 service accounts).
 
 0.8.2:
@@ -78,7 +81,7 @@
   - 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.
+  - Support for OAuth2 authorization method.
 
 0.7.2:
   - Compatibility with savon-0.9.10 (not backward-compatible).

data/lib/ads_common/auth/oauth2_handler.rb

@@ -15,7 +15,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This module manages OAuth2.0 authentication.
+# This module manages OAuth2 authentication.
 
 require 'time'
 
@@ -28,7 +28,7 @@ require 'ads_common/errors'
 module AdsCommon
   module Auth
 
-    # Credentials class to handle OAuth2.0 authentication.
+    # Credentials class to handle OAuth2 authentication.
     class OAuth2Handler < AdsCommon::Auth::BaseHandler
       OAUTH2_CONFIG = {
           :authorization_uri =>
@@ -67,7 +67,7 @@ module AdsCommon
         raise error
       end
 
-      # Generates auth string for OAuth2.0 method of authentication.
+      # Generates auth string for OAuth2 method of authentication.
       #
       # Args:
       # - credentials: credentials set for authorization
@@ -142,7 +142,7 @@ module AdsCommon
       end
 
       # Auxiliary method to generate an authentication token for logging via
-      # the OAuth2.0 API.
+      # the OAuth2 API.
       #
       # Args:
       # - credentials: a hash with the credentials for the account being

data/lib/ads_common/auth/oauth2_service_account_handler.rb

@@ -15,10 +15,11 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This module manages OAuth2.0 service account authentication.
+# This module manages OAuth2 service account authentication.
 
 require 'faraday'
 require 'signet/oauth_2/client'
+require 'json'
 
 require 'ads_common/auth/base_handler'
 require 'ads_common/errors'
@@ -26,7 +27,7 @@ require 'ads_common/errors'
 module AdsCommon
   module Auth
 
-    # Credentials class to handle OAuth2.0 authentication.
+    # Credentials class to handle OAuth2 authentication.
     class OAuth2ServiceAccountHandler < AdsCommon::Auth::BaseHandler
 
       OAUTH2_CONFIG = {
@@ -62,7 +63,7 @@ module AdsCommon
         raise error
       end
 
-      # Generates auth string for OAuth2.0 service account method of
+      # Generates auth string for OAuth2 service account method of
       # authentication.
       #
       # Args:
@@ -113,24 +114,40 @@ module AdsCommon
           raise AdsCommon::Errors::AuthError, 'No credentials supplied.'
         end
 
-        if credentials[:oauth2_issuer].nil?
+        if credentials[:oauth2_key].nil? && credentials[:oauth2_keyfile].nil?
           raise AdsCommon::Errors::AuthError,
-              'Issuer is not included in the credentials.'
+              'Either key or key file must be provided for OAuth2 service account.'
         end
 
-        if credentials[:oauth2_secret].nil?
+        if credentials[:oauth2_key] && credentials[:oauth2_keyfile]
           raise AdsCommon::Errors::AuthError,
-              'Key secret is not included in the credentials.'
+              'Both service account key and key file provided, only one can be used.'
         end
 
-        if credentials[:oauth2_key].nil? && credentials[:oauth2_keyfile].nil?
+        p12 = true
+        if credentials[:oauth2_keyfile]
+          file_name = credentials[:oauth2_keyfile]
+          if File.file?(file_name)
+            unless file_name.end_with?('.p12') || file_name.end_with?('.json')
+              raise AdsCommon::Errors::AuthError,
+                  "Key file '%s' must be either a .p12 or .json file." %
+                  file_name
+            end
+            p12 = false if file_name.end_with?('.json')
+          else
+            raise AdsCommon::Errors::AuthError,
+                "Key file '%s' does not exist or not a file." % file_name
+          end
+        end
+
+        if credentials[:oauth2_issuer].nil? && p12
           raise AdsCommon::Errors::AuthError,
-              'Either key or key file must be provided for OAuth2 service account.'
+              'Issuer is not included in the credentials.'
         end
 
-        if credentials[:oauth2_key] && credentials[:oauth2_keyfile]
+        if credentials[:oauth2_secret].nil? && p12
           raise AdsCommon::Errors::AuthError,
-              'Both service account key and key file provided, only one can be used.'
+              'Key secret is not included in the credentials.'
         end
 
         if credentials[:oauth2_key] &&
@@ -138,17 +155,10 @@ module AdsCommon
           raise AdsCommon::Errors::AuthError,
               'OAuth2 service account 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." %
-              credentials[:oauth2_keyfile]
-        end
       end
 
       # Auxiliary method to generate an authentication token for logging via
-      # the OAuth2.0 API.
+      # the OAuth2 API.
       #
       # Args:
       # - credentials: a hash with the credentials for the account being
@@ -185,9 +195,18 @@ module AdsCommon
       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]
-        key = OpenSSL::PKCS12.new(key_file, key_secret).key
+        key = nil
+        issuer = nil
+        if credentials[:oauth2_keyfile].end_with?('.p12')
+          key_secret = credentials[:oauth2_secret]
+          key = OpenSSL::PKCS12.new(key_file, key_secret).key
+        else
+          key_file_hash = JSON.parse(key_file, :symbolize_names => true)
+          key = OpenSSL::PKey::RSA.new(key_file_hash[:private_key])
+          issuer = key_file_hash[:client_email]
+        end
         result = credentials.merge({:oauth2_key => key})
+        result[:oauth2_issuer] = issuer unless issuer.nil?
         result.delete(:oauth2_keyfile)
         return result
       end

data/lib/ads_common/env_check.rb

@@ -19,10 +19,10 @@
 
 require 'ads_common/errors'
 
-MIN_RUBY_VERSION = Gem::Version.new(2.0)
-MIN_RUBY_RECOMMENDED_VERSION = Gem::Version.new(2.1)
+MIN_RUBY_VERSION = Gem::Version.new('2.0')
+MIN_RUBY_RECOMMENDED_VERSION = Gem::Version.new('2.1')
 
-if Gem::Version.new(RUBY_VERSION) < MIN_RUBY_VERSION
+if Gem::Version.new(RUBY_VERSION.dup()) < MIN_RUBY_VERSION
   raise AdsCommon::Errors::VersionError,
       'Unsupported Ruby version %s. Upgrade to version %s or later' %
       [RUBY_VERSION, MIN_RUBY_RECOMMENDED_VERSION]

data/lib/ads_common/errors.rb

@@ -37,7 +37,7 @@ module AdsCommon
       end
     end
 
-    # Raised when OAuth2.0 access token is required.
+    # Raised when OAuth2 access token is required.
     class OAuth2VerificationRequired < AuthError
       attr_reader :oauth_url
       def initialize(oauth_url)

data/lib/ads_common/version.rb

@@ -19,6 +19,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.12.0'
+    CLIENT_LIB_VERSION = '0.12.1'
   end
 end

data/test/test_oauth2_service_account_handler.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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.
+#
+# Test OAuth2 service account authentication.
+
+require 'tempfile'
+
+require 'ads_common/auth/oauth2_service_account_handler'
+require 'ads_common/config'
+
+module AdsCommon
+  module Auth
+    class OAuth2ServiceAccountHandler
+      public :validate_credentials
+    end
+  end
+end
+
+class TestOAuthServiceAccount < Test::Unit::TestCase
+  def test_file_extension_check()
+    assert_nothing_raised do
+      validate_credentials(["test", ".json"])
+    end
+    assert_nothing_raised do
+      validate_credentials(["test", ".p12"])
+    end
+    assert_raise do
+      validate_credentials(["test", ".other"])
+    end
+  end
+
+  def validate_credentials(filename)
+    file = Tempfile.new(filename)
+    credentials = {
+      :method => 'OAUTH2_SERVICE_ACCOUNT',
+      :oauth2_keyfile => file.path,
+      :oauth2_issuer => 'issuer',
+      :oauth2_secret => 'secret'
+    }
+    handler = AdsCommon::Auth::OAuth2ServiceAccountHandler.new(
+        AdsCommon::Config.new(), 'https://www.googleapis.com/auth/adwords')
+    handler.validate_credentials(credentials)
+    file.close
+    file.unlink
+  end
+end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
+  prerelease: 
 platform: ruby
 authors:
 - Sergio Gomes
@@ -10,76 +11,86 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-savon
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: httpi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: signet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.4.2
 description: Essential utilities shared by all Ads Ruby client libraries
@@ -89,72 +100,75 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- COPYING
-- ChangeLog
-- README.md
 - lib/ads_common/api.rb
-- lib/ads_common/api_config.rb
+- lib/ads_common/version.rb
+- lib/ads_common/errors.rb
+- lib/ads_common/env_check.rb
 - lib/ads_common/auth/base_handler.rb
-- lib/ads_common/auth/oauth2_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/auth/oauth2_handler.rb
+- lib/ads_common/credential_handler.rb
+- lib/ads_common/api_config.rb
+- lib/ads_common/utils.rb
+- lib/ads_common/build/savon_service_generator.rb
 - lib/ads_common/build/savon_registry.rb
 - lib/ads_common/build/savon_registry_generator.rb
-- lib/ads_common/build/savon_service_generator.rb
+- lib/ads_common/build/savon_abstract_generator.rb
+- lib/ads_common/build/savon_generator.rb
 - lib/ads_common/config.rb
-- lib/ads_common/credential_handler.rb
-- lib/ads_common/env_check.rb
-- lib/ads_common/errors.rb
-- lib/ads_common/http.rb
 - lib/ads_common/parameters_validator.rb
-- lib/ads_common/results_extractor.rb
 - lib/ads_common/savon_headers/base_header_handler.rb
 - lib/ads_common/savon_headers/oauth_header_handler.rb
+- lib/ads_common/results_extractor.rb
+- lib/ads_common/http.rb
 - lib/ads_common/savon_service.rb
-- lib/ads_common/utils.rb
-- lib/ads_common/version.rb
-- test/coverage.rb
+- test/test_env.rb
 - test/suite_unittests.rb
+- test/coverage.rb
+- test/test_results_extractor.rb
 - test/test_config.rb
-- test/test_config.yml
+- test/test_utils.rb
 - test/test_credential_handler.rb
-- test/test_env.rb
 - test/test_oauth2_handler.rb
-- test/test_parameters_validator.rb
-- test/test_results_extractor.rb
 - test/test_savon_service.rb
-- test/test_utils.rb
+- test/test_config.yml
+- test/test_parameters_validator.rb
+- test/test_oauth2_service_account_handler.rb
+- COPYING
+- README.md
+- ChangeLog
 homepage: https://github.com/googleads/google-api-ads-ruby
 licenses:
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: google-ads-common
-rubygems_version: 2.4.8
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Common code for Google Ads APIs
 test_files:
-- test/test_savon_service.rb
+- test/test_env.rb
+- test/test_results_extractor.rb
 - test/test_config.rb
-- test/test_credential_handler.rb
 - test/test_utils.rb
-- test/test_parameters_validator.rb
+- test/test_credential_handler.rb
 - test/test_oauth2_handler.rb
-- test/test_env.rb
-- test/test_results_extractor.rb
+- test/test_savon_service.rb
+- test/test_parameters_validator.rb
+- test/test_oauth2_service_account_handler.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 92e8a7a26a88631f6109cecd9748a25907193e88
-  data.tar.gz: 115bedb52bd5a55003ffa3ed598ff4a72554df5f
-SHA512:
-  metadata.gz: 0b78cdce163e1910a6e8152b3f7b323421d82a3e6b2c2c9200ead0cf43282cdd91ce3e9ba1b3535417399d4dde394bdcf0ce6d9aa4fae9cc453ad98ecacbba26
-  data.tar.gz: 5b104c82f29bd4f2031103b1e8897f2e408a5f7a20b03066e677c6787a5232a9d6c82d6c320b77e5481abe0b5a41a1331175f1b0b11d0dda1031fb30707ac75b