adapi 0.0.9 → 0.1.0

data/lib/adapi/campaign_criterion.rb

@@ -6,7 +6,9 @@ module Adapi
   #
   class CampaignCriterion < Api
 
-    attr_accessor :campaign_id, :criteria
+    ATTRIBUTES = [ :campaign_id, :criteria ]
+
+    attr_accessor *ATTRIBUTES 
 
     validates_presence_of :campaign_id
 
@@ -16,7 +18,7 @@ module Adapi
       :criterion_user_list, :vertical ]
 
     def attributes
-      super.merge( 'campaign_id' => campaign_id, 'criteria' => criteria )
+      super.merge Hash[ ATTRIBUTES.map { |k| [k, self.send(k)] } ]
     end
 
     def initialize(params = {})
@@ -29,8 +31,8 @@ module Adapi
         'CampaignCriterion'
       end
 
-      %w{ campaign_id criteria }.each do |param_name|
-        self.send "#{param_name}=", params[param_name.to_sym]
+      ATTRIBUTES.each do |param_name|
+        self.send "#{param_name}=", params[param_name]
       end
 
       # HOTFIX backward compatibility with old field for criteria

data/lib/adapi/campaign_target.rb

@@ -9,12 +9,14 @@ module Adapi
   #
   class CampaignTarget < Api
 
-    attr_accessor :campaign_id, :targets
+    ATTRIBUTES = [ :campaign_id, :targets ]
+
+    attr_accessor *ATTRIBUTES 
 
     validates_presence_of :campaign_id
 
     def attributes
-      super.merge( 'campaign_id' => campaign_id, 'targets' => targets )
+      super.merge Hash[ ATTRIBUTES.map { |k| [k, self.send(k)] } ]
     end
 
     def initialize(params = {})
@@ -22,8 +24,8 @@ module Adapi
 
       @xsi_type = 'CampaignTarget'
 
-      %w{ campaign_id targets }.each do |param_name|
-        self.send "#{param_name}=", params[param_name.to_sym]
+      ATTRIBUTES.each do |param_name|
+        self.send "#{param_name}=", params[param_name]
       end
 
       super(params)

data/lib/adapi/config.rb

@@ -8,10 +8,10 @@ module Adapi
       attr_accessor :dir, :filename
     end
 
-    self.dir = ENV['HOME']
+    self.dir = ENV['HOME'] || '.'
     self.filename = 'adapi.yml'
 
-    DEFAULT_LOG_PATH = File.join(ENV['HOME'], 'adapi.log')
+    DEFAULT_LOG_PATH = File.join(self.dir, 'adapi.log')
 
     # display hash of all account settings
     #

data/lib/adapi/keyword.rb

@@ -21,7 +21,7 @@ module Adapi
     attr_accessor :keywords
 
     def attributes
-      super.merge('keywords' => keywords)
+      super.merge( keywords: keywords )
     end
 
     def initialize(params = {})
@@ -85,13 +85,12 @@ module Adapi
       response = self.mutate(operations)
 
       # check for PolicyViolationErrors, set exemptions and try again
-      # TODO for now, this is only done once. how about setting a number of retries?
-      unless self.errors[:PolicyViolationError].empty?
-        # FIXME this works, but add exemptions_requests only for related keyword if possible 
-        operations.each_with_index do |operation, i|
-          operations[i][:exemption_requests] = self.errors[:PolicyViolationError].map do |error_key|
-            { :key => error_key }
-          end
+      # do it only once. from my experience with AdWords API, multiple retries are bad practice
+      if self.errors[:PolicyViolationError].any?
+
+        self.errors[:PolicyViolationError].each do |e|
+          i = e.delete(:operation_index) 
+          operations[i][:exemption_requests] = [ { :key => e } ]
         end
 
         self.errors.clear
@@ -99,57 +98,13 @@ module Adapi
         response = self.mutate(operations)
       end
 
-      return false unless self.errors.empty?
+      return false if self.errors.any?
       
       self.keywords = response[:value].map { |keyword| keyword[:criterion] }
 
       true
     end
 
-    # keywords mutate wrapper, deals with PolicyViolations for ads
-    #
-    # REFACTOR use just one mutate method in Api class
-    #
-    def mutate(operation)
-      operation = [operation] unless operation.is_a?(Array)
-      
-      # fix to save space during specifyng operations
-      operation = operation.map do |op|
-        op[:operand].delete(:status) if op[:operand][:status].nil?
-        op
-      end
-      
-      begin
-        
-        response = @service.mutate(operation)
-
-      rescue *API_EXCEPTIONS => e
-
-        # return PolicyViolations in specific format so they can be sent again
-        # see adwords-api gem example for details: handle_policy_violation_error.rb
-        e.errors.each do |error|
-          # error[:xsi_type] seems to be broken, so using also alternative key
-          # also could try: :"@xsi:type" (but api_error_type seems to be more robust)
-          if (error[:xsi_type] == 'PolicyViolationError') || (error[:api_error_type] == 'PolicyViolationError')
-            if error[:is_exemptable]
-              self.errors.add(:PolicyViolationError, error[:key])
-            end
-
-            # return also exemptable errors, operation may fail even with them
-            self.errors.add(:base, "violated %s policy: \"%s\" on \"%s\"" % [
-              error[:is_exemptable] ? 'exemptable' : 'non-exemptable', 
-              error[:key][:policy_name], 
-              error[:key][:violating_text]
-            ])
-          else
-            self.errors.add(:base, e.message)
-          end
-        end # of errors.each
-      end
-
-      response
-    end
-
     def self.find(amount = :all, params = {})
       params[:format] ||= :google # default, don't do anything with the data from google
       
@@ -176,11 +131,9 @@ module Adapi
       selector = {
         :fields => ['Id', 'CriteriaType', 'KeywordText'],
         :ordering => [{ :field => 'AdGroupId', :sort_order => 'ASCENDING' }],
-        :predicates => predicates,
-        :paging => {
-          :start_index => 0,
-          :number_results => 10
-        }
+        :predicates => predicates
+        # obsolete, not needed in newer versions of AdWords API 
+        # :paging => { :start_index => 0, :number_results => 10 }
       }
 
       response = Keyword.new.service.get(selector)

data/lib/adapi/version.rb

@@ -1,10 +1,16 @@
 # encoding: utf-8
 
 module Adapi
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 
   # CHANGELOG:
   #
+  # 0.1.0
+  # updated to AdWords API version v201206
+  # updated gem dependencies (including google-adwords-api to 0.7.0)
+  # improved and debugged error handling for complex create/update methods
+  # optimized batch creating of ads
+  #
   # 0.0.9
   # added Campaign#update method - updates campaign, criteria and ad groups by a single method call
   # fixed PolicyViolation exemptions for keywords and ads

data/test/integration/create_ad_group_test.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+module Adapi
+  class AdGroupCreateTest < Test::Unit::TestCase
+    context "non-existent ad group" do
+      should "not be found" do
+        assert assert_nil Adapi::AdGroup.find(:first, :campaign_id => Time.new.to_i)
+      end
+    end
+
+    context "existing ad group" do
+      setup do 
+        @campaign_id = create_bare_campaign! 
+
+        @ad_group_data = {
+          :campaign_id => @campaign_id,
+          :name => "AdGroup #%d" % (Time.new.to_f * 1000).to_i,
+          :status => 'ENABLED',
+          :bids => {
+            :xsi_type => 'BudgetOptimizerAdGroupBids',
+            :proxy_keyword_max_cpc => 15
+          }
+        }
+        
+        ag = Adapi::AdGroup.create(@ad_group_data)
+        
+        @ad_group = Adapi::AdGroup.find(:first, :id => ag.id, :campaign_id => @campaign_id)
+      end
+
+      should "be found" do
+        assert_not_nil @ad_group
+
+        assert_equal @ad_group_data[:status], @ad_group.status
+        assert_equal @ad_group_data[:name], @ad_group.name        
+      end      
+
+      should "not be found after deletion" do
+        @ad_group.delete
+
+        assert_nil Adapi::AdGroup.find(:first, :id => @ad_group.id, :campaign_id => @campaign_id)
+      end
+
+    end
+
+  end
+end

data/test/integration/create_campaign_test.rb

@@ -6,7 +6,6 @@ module Adapi
   class CampaignCreateTest < Test::Unit::TestCase
     context "non-existent campaign" do
       should "not be found" do
-        # FIXME randomly generated id, but it might actually exist        
         assert_nil Adapi::Campaign.find(Time.new.to_i)
       end
     end
@@ -21,8 +20,7 @@ module Adapi
           :network_setting => {
             :target_google_search => true,
             :target_search_network => true,
-            :target_content_network => false,
-            :target_content_contextual => false
+            :target_content_network => false
           },
           
           :criteria => {
@@ -38,7 +36,6 @@ module Adapi
         @campaign = Adapi::Campaign.find(c.id)
       end
 
-      # this basically tests creating bare campaign
       should "be found" do
         assert_not_nil @campaign
 

data/test/test_helper.rb

@@ -19,4 +19,53 @@ Dir[ File.join(File.dirname(__FILE__), 'factories', '*.rb') ].each { |f| require
 
 class Test::Unit::TestCase
   FakeWeb.allow_net_connect = false
+
+  # many integration tests need to use campaign or ad group
+  # instead of creating them in every test, we do it here  
+  #
+  @@bare_campaign_id = nil
+  @@bare_ad_group_id = nil
+
+  def create_bare_campaign!(force = false)
+    if force or @@bare_campaign_id.nil?
+      campaign = Adapi::Campaign.create(
+        name: "Campaign #%d" % (Time.new.to_f * 1000).to_i,
+        status: 'PAUSED',
+        bidding_strategy: { 
+          xsi_type: 'BudgetOptimizer', 
+          bid_ceiling: 20 
+        },
+        budget: 50
+      )
+
+      if campaign.errors.any?
+        raise "CANNOT CREATE BARE CAMPAIGN (during test initialization):\n" + campaign.errors.join("\n")
+      end
+
+      @@bare_campaign_id = campaign[:id]
+    end
+
+    @@bare_campaign_id
+  end
+
+  def create_bare_ad_group!(force = false)
+    if force or @@bare_ad_group_id.nil?
+      @@bare_campaign_id ||= create_bare_campaign!(true)
+
+      ad_group = Adapi::AdGroup.create(
+        campaign_id: @@bare_campaign_id,
+        name: "AdGroup #%d" % (Time.new.to_f * 1000).to_i,
+        status: 'ENABLED'
+      )
+
+      if ad_group.errors.any?
+        raise "CANNOT CREATE BARE AD GROUP (during test initialization):\n" + ad_group.errors.join("\n")
+      end
+
+      @@bare_ad_group_id = ad_group[:id]
+    end
+
+    @@bare_ad_group_id
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapi
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
-  requirement: &14836360 !ruby/object:Gem::Requirement
+  requirement: &8558440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *14836360
+  version_requirements: *8558440
 - !ruby/object:Gem::Dependency
   name: google-adwords-api
-  requirement: &14835520 !ruby/object:Gem::Requirement
+  requirement: &8554360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *14835520
+  version_requirements: *8554360
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &14834820 !ruby/object:Gem::Requirement
+  requirement: &8562720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14834820
+  version_requirements: *8562720
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &14834120 !ruby/object:Gem::Requirement
+  requirement: &9409620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14834120
+  version_requirements: *9409620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14849580 !ruby/object:Gem::Requirement
+  requirement: &9443740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,32 +65,32 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *14849580
+  version_requirements: *9443740
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &14848220 !ruby/object:Gem::Requirement
+  requirement: &9448120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *14848220
+  version_requirements: *9448120
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &14846280 !ruby/object:Gem::Requirement
+  requirement: &9038540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *14846280
+  version_requirements: *9038540
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &14845320 !ruby/object:Gem::Requirement
+  requirement: &9037880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *14845320
+  version_requirements: *9037880
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &14843740 !ruby/object:Gem::Requirement
+  requirement: &9036120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,51 +109,51 @@ dependencies:
         version: 0.9.6
   type: :development
   prerelease: false
-  version_requirements: *14843740
+  version_requirements: *9036120
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &14842660 !ruby/object:Gem::Requirement
+  requirement: &9034380 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *14842660
+  version_requirements: *9034380
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &14858140 !ruby/object:Gem::Requirement
+  requirement: &9032760 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *14858140
+  version_requirements: *9032760
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &14857440 !ruby/object:Gem::Requirement
+  requirement: &9159820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *14857440
+  version_requirements: *9159820
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &14856840 !ruby/object:Gem::Requirement
+  requirement: &9157340 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *14856840
+  version_requirements: *9157340
 description: This gem provides user-friendly interface to Google Adwords API.
 email:
 - lucastej@gmail.com
@@ -179,6 +179,7 @@ files:
 - examples/add_keywords.rb
 - examples/add_negative_campaign_criteria.rb
 - examples/add_text_ad.rb
+- examples/add_text_ads.rb
 - examples/custom_settings.yml
 - examples/customize_configuration.rb
 - examples/delete_ad_group.rb
@@ -225,6 +226,7 @@ files:
 - test/factories/campaign_factory.rb
 - test/fixtures/adapi.yml
 - test/fixtures/adwords_api.yml
+- test/integration/create_ad_group_test.rb
 - test/integration/create_campaign_test.rb
 - test/integration/find_location_test.rb
 - test/test_helper.rb
@@ -250,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3921754169281817969
+      hash: 2590493232299727233
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -259,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3921754169281817969
+      hash: 2590493232299727233
 requirements: []
 rubyforge_project: adapi
 rubygems_version: 1.8.15