google-ads-common 0.9.2 → 0.9.3

data/ChangeLog

@@ -1,3 +1,6 @@
+0.9.3:
+  - Added support for persisting OAuth2 token.
+
 0.9.2:
   - Fixed issue with boolean value not prefixed in a mixed namespaces case.
 

data/README

@@ -4,6 +4,7 @@ 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.
 
+
 = Docs for Users
 
 == 1 - Installation:
@@ -18,6 +19,7 @@ The following gem libraries are required:
  - httpi
  - signet
 
+
 = Docs for Developers
 
 == 1 - Directory Structure
@@ -31,6 +33,7 @@ The following gem libraries are required:
     requests.
 - +test/+: Contains the unit tests for the library.
 
+
 == 2 - Commands
 
  $ gem build google-ads-common.gemspec
@@ -40,9 +43,20 @@ to build the gem
 to run unit tests on the library
 
 
+== 3 - Resources
+
+Ruby client libraries code page:
+
+  http://code.google.com/p/google-api-ads-ruby/
+
+Google Ads Developers Plus page:
+
+  https://plus.google.com/+GoogleAdsDevelopers
+
+
 = Copyright/License Info
 
-Copyright 2010-2012, Google Inc. All Rights Reserved.
+Copyright 2010-2013, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/ads_common/api.rb

@@ -140,6 +140,13 @@ module AdsCommon
       return @auth_handler
     end
 
+    # Updates default configuration file to include OAuth2 token information.
+    def save_oauth2_token(token)
+      raise AdsCommon::Errors::Error, "Can't save nil token" if token.nil?
+      AdsCommon::Utils.save_oauth2_token(
+          File.join(ENV['HOME'], api_config.default_config_filename), token)
+    end
+
     private
 
     # Auxiliary method to test parameters correctness for the service request.
@@ -183,9 +190,13 @@ module AdsCommon
     # - auth handler
     #
     def create_auth_handler()
-      auth_method = @config.read('authentication.method', :CLIENTLOGIN)
+      auth_method = @config.read('authentication.method', :OAUTH2)
       return case auth_method
         when :CLIENTLOGIN
+          @logger.warn("ClientLogin authentication method is now deprecated" +
+              " and will be removed in the future. Consider migration to" +
+              " OAuth2. See 'https://developers.google.com/accounts/docs/" +
+              "AuthForInstalledApps' for more details.")
           AdsCommon::Auth::ClientLoginHandler.new(
               @config,
               api_config.client_login_config(:AUTH_SERVER),

data/lib/ads_common/build/savon_registry_generator.rb

@@ -31,7 +31,7 @@ module AdsCommon
       #
       # This is auto-generated code, changes will be overwritten.
       #
-      # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+      # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
       # License:: Licensed under the Apache License, Version 2.0.
       #
       # <%= @generator_stamp %>

data/lib/ads_common/build/savon_service_generator.rb

@@ -31,7 +31,7 @@ module AdsCommon
       #
       # This is auto-generated code, changes will be overwritten.
       #
-      # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+      # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
       # License:: Licensed under the Apache License, Version 2.0.
       #
       # <%= @generator_stamp %>

data/lib/ads_common/utils.rb

@@ -49,6 +49,30 @@ module AdsCommon
         result
       end
     end
+
+    # Updates file to include token details.
+    def self.save_oauth2_token(filename, token)
+      config_data = {}
+      if File.exist?(filename)
+        config_data = YAML::load_file(filename)
+        new_file_name = self.find_new_name(filename)
+        File.rename(filename, new_file_name)
+      end
+      config_data[:authentication][:oauth2_token] = token
+      File.open(filename, 'w') {|f| f.write(YAML::dump(config_data))}
+    end
+
+    private
+
+    # Returns an available filename for renaming a given file.
+    def self.find_new_name(old_name)
+      counter = 0
+      begin
+        filename = old_name + '.backup' + ((counter > 0) ? counter.to_s : '')
+        counter += 1
+      end while File.exist?(filename)
+      return filename
+    end
   end
 end
 

data/lib/ads_common/version.rb

@@ -21,6 +21,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.9.2'
+    CLIENT_LIB_VERSION = '0.9.3'
   end
 end

data/test/ads_devrel_ruby_ads_common.blueprint

@@ -0,0 +1,36 @@
+include "devtools/blueprint/ncl/blueprint_file.ncl";
+
+blueprint_file = ::blueprint::BlueprintFile(
+  buildable_units = [
+    ::blueprint::BuildableUnit(
+      build_patterns = [
+        "//third_party/ruby/ads_api/ads_common/...",
+      ],
+      test_patterns = [
+        "//third_party/ruby/ads_api/ads_common:rake-test",
+      ],
+      build_flags = ["--cpu=k8",
+                     "--java_cpu=k8"],
+      test_flags = [],
+      name = "ads_devrel.ruby.ads_api_clients",
+      coverage_instrumentation_filters = [
+        "third_party/ruby/ads_api/ads_common/",
+        "-third_party/ruby/ads_api/ads_common/test",
+        "-test_.*$",
+      ],
+      continuous_build_email = ::blueprint::ContinuousBuildEmailInfo(
+        build_cop_email_addrs = ["ads-client-libs+tap-ruby@google.com"],
+        summary_email_addrs = []),
+      enable_release = false,
+      enable_continuous_build = true,
+      tap_settings = tap::TapBuildableUnitSettings()
+    )
+  ],
+  owned_code_depotpaths = [
+    "//depot/google3/third_party/ruby/ads_api/ads_common/...",
+  ],
+  mpm_packages = [
+  ],
+  project_name = "ads_devrel.ruby.ads_api_clients",
+  mdb_groups = ["ads-api-devrel"]
+);

data/test/test_utils.rb

@@ -20,7 +20,9 @@
 #
 # Tests the utils.
 
+require 'tempfile'
 require 'test/unit'
+require 'yaml'
 
 require 'ads_common/utils'
 
@@ -75,4 +77,37 @@ class TestUtils < Test::Unit::TestCase
     assert_equal(4, result.size)
     assert_not_same(result, data)
   end
+
+  def test_save_oauth2_token()
+    config_stub = {:authentication => {:method => 'OAuth2'}}
+    token = {:token_key => 'token_value', :token_number => 42}
+    expected_result = {
+      :authentication => {
+        :method => 'OAuth2',
+        :oauth2_token => token.dup
+      }
+    }
+    tmp_file = Tempfile.new('ruby-tests')
+    tmp_file.write(YAML::dump(config_stub))
+    filename = tmp_file.path()
+    tmp_file.close()
+    AdsCommon::Utils.save_oauth2_token(filename, token)
+
+    assert(File.exist?(filename))
+    result = YAML::load_file(filename)
+    assert_equal(expected_result, result)
+    assert(File.exist?(filename + '.backup'))
+    File.unlink(filename + '.backup')
+  end
+
+  def test_find_new_name()
+    tmp_file = Tempfile.new('ruby-tests')
+    name1 = AdsCommon::Utils.find_new_name(tmp_file.path())
+    assert_equal(tmp_file.path() + '.backup', name1)
+    File.open(name1, 'w') do |file1|
+      name2 = AdsCommon::Utils.find_new_name(tmp_file.path())
+      assert_equal(tmp_file.path() + '.backup1', name2)
+    end
+    File.unlink(name1)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -95,6 +95,7 @@ files:
 - test/suite_unittests.rb
 - test/test_credential_handler.rb
 - test/test_client_login_handler.rb
+- test/ads_devrel_ruby_ads_common.blueprint
 - test/test_parameters_validator.rb
 - test/test_utils.rb
 - test/test_config.rb