google-adwords-api 0.2.1 → 0.4.0

data/ChangeLog

@@ -1,3 +1,7 @@
+0.4.0:
+  - First experimental Savon-based release.
+  - use_ruby_names is now deprecated and always true.
+
 0.2.1:
   - Changes for future OAuth support.
   - Require google-ads-common 0.5.0 or later from now on.

data/README

@@ -8,8 +8,7 @@ development.
 
 It contains full support for v13, v200909, v201003, v201008 and v201101, with
 full stubs, and a simplified programming interface that lets you handle
-everything in native Ruby collections, instead of forcing you to deal with SOAP
-library-generated objects.
+everything in native Ruby collections.
 
 
 = Docs for Users
@@ -28,7 +27,7 @@ Buyer client library examples. You need the AdWords library in order to use it
 which is installed automatically as a dependency.
 
 The following gem libraries are required:
-- soap4r v1.5.8
+- savon v0.9.6
 - httpclient v2.1.2 or greater
 - google-ads-common v0.5.0 or later.
 
@@ -106,13 +105,6 @@ values, you would do:
 Essentially, all you have to do is follow Ruby conventions, and the library will
 do the rest. All of the examples are written following this standard.
 
-If, however, you would prefer to use the names as provided in the AdWords
-documentation, please disable the 'use_ruby_names' option under the 'service'
-category in the config:
-   config[:service][:use_ruby_names] = false
-
-Disabling Ruby names is an experimental feature, and it is not recommended.
-
 
 === 2.2 - Using the Sandbox:
 
@@ -153,11 +145,8 @@ using Logger refer to the Ruby Logger documentation.
 
 == Rake targets
 
- $ rake getwsdl
-to get the wsdl files
-
  $ rake generate
-to regenerate the bindings if needed
+to regenerate the stubs if needed
 
  $ rake package
 to package the gem and create a release

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -17,101 +17,70 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# Rakefile for the AdWords API client library.
-
-# A little trick so we can load things from the lib/ directory without having
-# to patch the "require" statements in the files
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
+# AdWords API Rakefile.
 
 require 'rubygems'
-gem 'google-ads-common'
-require 'ads_common/config'
-require 'adwords_api/api_config'
-require 'adwords_api/extensions'
-require 'adwords_api/soap4r/soap4r_generator'
-
-# Configure some constants and built-in tasks
-$PROJECT_NAME = 'adwords_api'
-$GEM_NAME = 'google-adwords-api'
-$API_NAME = 'AdWords API'
-$CURRENT_VERSION = AdwordsApi::ApiConfig::CLIENT_LIB_VERSION
-$PRODDIR = 'adwords_api'
-$ADS_COMMON_VERSION = '~> 0.5.0'
+require 'rubygems/package_task'
+require 'rake/testtask'
+require './lib/adwords_api/api_config'
+require './lib/adwords_api/extensions'
 
-# Configure module / namespace
-$MODULE = AdwordsApi
-
-# Configure config file location.
-$CONFIG_FILE = 'adwords_api.yml'
-
-# Configure gem details
-$GEM_SUMMARY = "Client library for the AdWords API."
-description = "#{$PROJECT_NAME} provides an easy to use way to access " +
-    "the AdWords API in Ruby.\nCurrently the following AdWords API versions " +
-    "are supported:"
-versions = AdwordsApi::ApiConfig.versions.map { |version| version.to_s }
-versions.sort.each do |version|
-  description += "\n  * #{version}"
+# Google common ads library used for wrapper code generation.
+gem 'google-ads-common'
+require 'ads_common/build/savon_generator'
+
+files = FileList['{lib,examples}/**/*', 'Rakefile'].to_a
+tests = FileList['test/**/test*.rb']
+docs = ['README', 'COPYING', 'ChangeLog']
+extra_files = ['adwords_api.yml']
+
+spec = Gem::Specification.new do |s|
+  s.name = 'google-adwords-api'
+  s.version = AdwordsApi::ApiConfig::CLIENT_LIB_VERSION
+  s.author = 'Danial Klimkin'
+  s.email = 'api.dklimkin@gmail.com'
+  s.homepage = 'http://code.google.com/p/google-api-ads-ruby/'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby Client libraries for AdWords API'
+  s.description = "%s is a AdWords API client library for Ruby" % s.name
+  s.files = files
+  s.require_path = 'lib'
+  s.test_files = tests
+  s.has_rdoc = true
+  s.extra_rdoc_files = docs
+  s.add_dependency('google-ads-common', '~> 0.5.0')
+  s.add_dependency('savon', '= 0.9.6')
 end
-$GEM_DESCRIPTION = description
-$GEM_AUTHORS = ['Sergio Gomes']
-$GEM_EMAIL = 'api.sgomes@gmail.com'
-$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-ads-ruby/'
 
+package_task = Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.package_files.include(extra_files)
+end
 
-# Configure code generation for the AdWords API client library.
-module Generator
-
-  class << Generator
-    include AdwordsApi::Soap4r::Soap4rGenerator
-  end
-
-  def self.api_config
-    AdwordsApi::ApiConfig
-  end
-
-  def self.config
-    filename = File.join(ENV['HOME'], $CONFIG_FILE)
-    if File.exist?(filename)
-      AdsCommon::Config.new(filename)
-    else
-      nil
-    end
-  end
-
-  def self.extension_config
-    AdwordsApi::Extensions
-  end
-
-  private
+Rake::TestTask.new do |t|
+  t.test_files = tests
+end
 
-  # Helper method to create a link to a method's entry in the API online docs.
-  #
-  # Args:
-  # - version: the API version (as an integer)
-  # - service: the service name (as a string)
-  # - method: the method name (as a string)
-  #
-  # Returns:
-  # The URL to the method's entry in the documentation (as a string).
-  # nil if none.
-  #
-  def self.doc_link(version, service, method)
-    if version.to_s == 'v13'
-      base = 'http://code.google.com/apis/adwords/docs/developer/'
-      url = base + service.to_s + '.html#' + method
-      return url
-    elsif version.to_s =~ /v20\d[\d]+/
-      base = 'http://code.google.com/apis/adwords/docs/reference/'
-      url = base + version.to_s + '/' + service.to_s + '.html#' + method
-      return url
-    else
-      return nil
+desc 'Default target - build'
+task :default => [:generate, :package]
+
+desc 'Generate API stubs only'
+task :generate do
+  logger = Logger.new(STDOUT)
+  logger.level = Logger::INFO
+  api_config = AdwordsApi::ApiConfig
+  versions = api_config.versions()
+  versions.each do |version|
+    code_path = "lib/%s/%s" % [api_config.api_path, version]
+    wsdls = AdwordsApi::ApiConfig.get_wsdls(version)
+    wsdls.each do |service_name, wsdl_url|
+      logger.info("Processing %s at [%s]..." % [service_name, wsdl_url])
+      extensions = AdwordsApi::Extensions.extensions()[[version,
+          service_name.to_sym]] || []
+      generator = AdsCommon::Build::SavonGenerator.new(wsdl_url, code_path,
+          api_config.api_name, version, service_name, extensions)
+      generator.process_wsdl()
     end
+    package_task.package_files.include(FileList[code_path + '/*'].to_a)
   end
-
 end
-
-
-# Import tasks in common file
-require 'adwords_api/soap4r/rake_common'

data/examples/v200909/add_ad_extension_override.rb

@@ -24,7 +24,6 @@
 # Tags: AdExtensionOverrideService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v200909
@@ -65,26 +64,18 @@ if __FILE__ == $0
   begin
     add_ad_extension_override()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v200909/add_ad_group.rb

@@ -23,7 +23,6 @@
 # Tags: AdGroupService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v200909
@@ -72,26 +71,18 @@ if __FILE__ == $0
   begin
     add_ad_group()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v200909/add_ad_group_criteria.rb

@@ -23,7 +23,6 @@
 # Tags: AdGroupCriterionService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v200909
@@ -91,26 +90,18 @@ if __FILE__ == $0
   begin
     add_ad_group_criteria()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v200909/add_ads.rb

@@ -23,7 +23,6 @@
 # Tags: AdGroupAdService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 require 'base64'
 
@@ -104,26 +103,18 @@ if __FILE__ == $0
   begin
     add_ads()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v200909/add_campaign.rb

@@ -22,7 +22,6 @@
 # Tags: CampaignService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v200909
@@ -75,26 +74,18 @@ if __FILE__ == $0
   begin
     add_campaign()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v200909/add_campaign_ad_extension.rb

@@ -23,7 +23,6 @@
 # Tags: GeoLocationService.get, CampaignAdExtensionService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v200909
@@ -104,26 +103,18 @@ if __FILE__ == $0
   begin
     add_campaign_ad_extension()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end