adapi 0.0.5 → 0.0.6

data/adapi.gemspec

@@ -18,14 +18,17 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # require specific version of ad-common and adwords-api gems,
-  # they're stil changing a lot and automatic updates through '~>'
-  # can easily break something
+  # Requires google-adwords-api gem, which provides low-level interface to
+  # AdWords API, and its dependecy, google-ads-common gem.
   #
-  # PS: ads-common is "freezed" - required before adwords-api
+  # * versions of both gems should be freezed
+  # * ads-common should be required before adwords-api
   #  
-  s.add_dependency "google-ads-common", "0.6.2"
-  s.add_dependency "google-adwords-api", "0.5.0"
+  # PS: versions are freezed because both of these gems change a lot and
+  # automatic updates through '~>' can (and already did) break something
+  #
+  s.add_dependency "google-ads-common", "0.6.3"
+  s.add_dependency "google-adwords-api", "0.5.2"
 
   s.add_dependency "activemodel", "~> 3.1"
   s.add_dependency "activesupport", "~> 3.1"
@@ -39,4 +42,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "fakeweb"
   s.add_development_dependency "factory_girl"
   s.add_development_dependency "minitest"
+
 end

data/examples/add_campaign.rb

@@ -21,7 +21,7 @@ campaign_data = {
 
   # PS: :targets key is obsolete, this should be named :criteria, but it still works
   :targets => {
-    :language => [ 'en', 'cs' ],
+    :language => [ :en, :cs ],
     # TODO test together with city target
     :geo => { :proximity => { :geo_point => '38.89859,-77.035971', :radius => '10 km' } }
   },

data/examples/add_campaign_criteria.rb

@@ -7,7 +7,7 @@ require_relative 'add_bare_campaign'
 
 $campaign_criterion = Adapi::CampaignCriterion.new(
   :campaign_id => $campaign[:id],
-  :criteria => {
+  :targets => { #  obsolete, use :criteria instead
     :language => %w{ en cs },
 
     :location => { 

data/examples/find_campaign.rb

@@ -18,10 +18,9 @@ puts "Budget period: %s" % $campaign[:budget][:period]
 puts "\nBidding strategy type: %s" % $campaign[:bidding_strategy][:xsi_type]
 # TODO bidding_strategy.bid_ceiling
 
-puts "\nCriteria:"
+puts "\nCriteria (%d in total):" % $campaign[:criteria].size
 $campaign[:criteria].each do |criterion|
-  p criterion[:xsi_type]
-  p criterion
+  puts criterion.inspect
 end
 
 puts "\nAd groups (#{$campaign[:ad_groups].size} in total):"

data/examples/find_campaign_criteria.rb

@@ -1,103 +1,12 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 example illustrates how to retrieve all the campaign targets. To set
-# campaign targets, run add_campaign_targeting_criteria.rb.
-#
-# Tags: CampaignCriterionService.get
+# encoding: utf-8
 
-require 'adwords_api'
+require 'adapi'
 
-API_VERSION = :v201109
-PAGE_SIZE = 500
+# create campaign
+require_relative 'add_campaign_criteria'
 
-def get_campaign_targeting_criteria()
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new
+$criteria = Adapi::CampaignCriterion.find(:campaign_id => $campaign.to_param)
 
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
+puts "Found %d criteria:\n" % $criteria.size
 
-  campaign_criterion_srv =
-      adwords.service(:CampaignCriterionService, API_VERSION)
-
-  # Specify campaign ID to get targeting for.
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Selector to get all the targeting for this campaign.
-  selector = {
-    :fields => ['Id', 'CriteriaType', 'KeywordText'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_criterion_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |typed_criterion|
-        negative = typed_criterion[:xsi_type] == 'NegativeCampaignCriterion' ?
-           ' (negative)' : ''
-        criterion = typed_criterion[:criterion]
-        puts ("Campaign criterion%s with ID %d, type '%s' and text '%s'" +
-            " was found.") %
-            [negative, criterion[:id], criterion[:type], criterion[:text]]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  if page.include?(:total_num_entries)
-    puts "\tCampaign ID %d has %d criteria." %
-        [campaign_id, page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_campaign_targeting_criteria()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    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
-end
+$criteria.each { |criterion| p criterion }

data/examples/find_locations.rb

@@ -11,11 +11,17 @@ $search_params = [
   { :province => 'Prague' },
   { :city => 'Prague' }
 ]
- 
+
 $search_params.each do |params| 
   $location = Adapi::Location.find(params)
 
   puts "\nSearched for: " + params.inspect
-  # puts "Found Location ID: #{Adapi::Location.location_tree($location)}"
-  puts "Found Location ID: #{$location[:id]}"
+
+  if $location.nil?
+    puts "Not found."
+    next
+  else
+    # puts "Found Location ID: #{Adapi::Location.location_tree($location)}"
+    puts "Found Location ID: #{$location[:id]}"
+  end
 end

data/examples/test_diacritics.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# this test should not raise an exception (sic!)
+
+$search_params = { :city => 'São Paulo' }
+
+$location = Adapi::Location.find($search_params)
+
+puts "\nSearched for: " + $search_params.inspect
+
+if $location.nil?
+  puts "Not found."
+else
+  # puts "Found Location ID: #{Adapi::Location.location_tree($location)}"
+  puts "Found Location ID: #{$location[:id]}"
+end

data/lib/adapi/campaign.rb

@@ -54,7 +54,9 @@ module Adapi
       # PS: not sure if this should be a default. maybe we don't even need it
       @budget[:delivery_method] ||= 'STANDARD'
 
-      @criteria ||=  []
+      # HOTFIX backward compatibility with old field for criteria
+      @criteria ||= params[:targets] || {}
+
       @ad_groups ||= []
 
       super(params)

data/lib/adapi/campaign_criterion.rb

@@ -33,12 +33,15 @@ module Adapi
         self.send "#{param_name}=", params[param_name.to_sym]
       end
 
+      # HOTFIX backward compatibility with old field for criteria
+      @criteria ||= params[:targets] || {}
+
       super(params)
     end
 
     def create
       # step 1 - convert input hash to new array of criteria
-      # example: :language => [ :en, :cz ] ->  [:language, :en]
+      # example: :language => [ :en, :cs ] -> [ [:language, :en], [:language, :cs] ]
       criteria_array = []
 
       @criteria.each_pair do |criterion_type, criterion_settings|
@@ -136,9 +139,6 @@ module Adapi
   
     def self.find(params = {})
       params.symbolize_keys!
-
-      # by default, skip criteria types that have no criterion data
-      params[:skip_empty_criterion_types] ||= true
       
       if params[:conditions]
         params[:campaign_id] = params[:campaign_id] || params[:conditions][:campaign_id]
@@ -154,9 +154,11 @@ module Adapi
         end
       end.compact
 
-      # TODO: get more fields
+      # TODO: get more fields - tricky, because value files differ for most types
+      #
       selector = {
-        :fields => ['Id'],
+        # HOTFIX added LocationName - and values for other criterion types mysteriously appeared as well!
+        :fields => ['Id', 'CriteriaType', 'KeywordText', 'LocationName'],
         :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
         :predicates => predicates
       }
@@ -165,16 +167,15 @@ module Adapi
 
       response = (response and response[:entries]) ? response[:entries] : []
 
-      # return everything or only 
-      if params[:skip_empty_criterion_types]
-        response.select! { |criterion_type| criterion_type.has_key?(:criteria) }
-      end
-
       # TODO optionally return just certain type(s)
       # easy, just add condition (single type or array), filter and set
       # :skip_empty_target_types option to false
 
-      response
+      # TODO add custom column :value, which will return criterion value
+      # unrelated to the actual column where value is stored (code,
+      # location_name, etc.)
+
+      response.map { |entry| entry[:criterion] }.compact
     end
 
     # Transforms our custom high-level criteria parameters to AdWords API parameters
@@ -185,6 +186,7 @@ module Adapi
     # :language => [ :en, :cs ]
     # :language => [ 1000, 1021 ] # integers!
     #
+    # TODO return error if language cannot be found
     #
     def self.create_criterion(criterion_type, criterion_data)
       case criterion_type

data/lib/adapi/version.rb

@@ -1,10 +1,15 @@
 # encoding: utf-8
 
 module Adapi
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 
   # CHANGELOG:
   #
+  # 0.0.6
+  # updated to latest adwords-api and ads-common gems, which fix many issues with AdWords API version v201109
+  # fix CampaignCriterion service
+  # fix examples
+  #
   # 0.0.5
   # converted to AdWords API version v201109
   #   moved from CampaignTarget to CampaignCriterion

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapi
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000 Z
+date: 2012-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
-  requirement: &10751680 !ruby/object:Gem::Requirement
+  requirement: &5230940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *10751680
+  version_requirements: *5230940
 - !ruby/object:Gem::Dependency
   name: google-adwords-api
-  requirement: &10749800 !ruby/object:Gem::Requirement
+  requirement: &5229860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *10749800
+  version_requirements: *5229860
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &10748340 !ruby/object:Gem::Requirement
+  requirement: &5229100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *10748340
+  version_requirements: *5229100
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &10747280 !ruby/object:Gem::Requirement
+  requirement: &5228260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *10747280
+  version_requirements: *5228260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10743320 !ruby/object:Gem::Requirement
+  requirement: &5227180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *10743320
+  version_requirements: *5227180
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &10742640 !ruby/object:Gem::Requirement
+  requirement: &5226200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *10742640
+  version_requirements: *5226200
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &10740660 !ruby/object:Gem::Requirement
+  requirement: &8121020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *10740660
+  version_requirements: *8121020
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &10739480 !ruby/object:Gem::Requirement
+  requirement: &8117900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *10739480
+  version_requirements: *8117900
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &10738540 !ruby/object:Gem::Requirement
+  requirement: &8115180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -109,10 +109,10 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *10738540
+  version_requirements: *8115180
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &10737680 !ruby/object:Gem::Requirement
+  requirement: &8102400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10737680
+  version_requirements: *8102400
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &10732740 !ruby/object:Gem::Requirement
+  requirement: &8100640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10732740
+  version_requirements: *8100640
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &10729600 !ruby/object:Gem::Requirement
+  requirement: &8099340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10729600
+  version_requirements: *8099340
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10726800 !ruby/object:Gem::Requirement
+  requirement: &8097340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10726800
+  version_requirements: *8097340
 description: This gem provides user-friendly interface to Google Adwords API.
 email:
 - lucastej@gmail.com
@@ -188,6 +188,7 @@ files:
 - examples/find_locations.rb
 - examples/log_to_specific_account.rb
 - examples/rollback_campaign.rb
+- examples/test_diacritics.rb
 - examples/update_campaign.rb
 - examples/update_campaign_status.rb
 - lib/adapi.rb
@@ -240,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: adapi
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: User-friendly interface to Google Adwords API