adapi 0.0.7 → 0.0.8

data/lib/adapi/location.rb

@@ -23,6 +23,7 @@ module Adapi
     # Location.find(:country => 'CZ', :region => 'Prague' :city => 'Prague')
     #
     # TODO add legacy aliases: :city_name, :province_code, :country_code
+    # TODO move search by id into separate method
     #
     def self.find(amount = :all, params = {})
       # set amount = :first by default
@@ -37,17 +38,23 @@ module Adapi
       # in which language to retrieve locations
       params[:locale] ||= 'en'
 
-      # support for legacy parameter
+      # support for legacy :province parameter
       if params[:province] and not params[:region]
         params[:region] = params[:province]
       end
 
+      # if :region parameter is in old format, replace it with province name
+      if params[:region] && (params[:region] =~ /^[A-Z]{2}\-\w{1,3}$/)
+        province_name = ConstantData::Location::Province.find_name_by_province_code(params[:region])
+        params[:region] = province_name if province_name
+      end
+
       # if :country parameter is valid country code, replace it with country name
       if params[:country] && (params[:country].size == 2)
         country_name = ConstantData::Location::Country.find_name_by_country_code(params[:country])
         params[:country] = country_name if country_name
       end
-
+      
       # determine by what criteria to search
       location_type, location_name = nil, nil
       LOCATIONS_HIERARCHY.each do |param_name|
@@ -58,7 +65,7 @@ module Adapi
         end
       end
       
-      raise "Invalid params" unless location_name
+      raise "Invalid params" if location_name.nil? and not params[:id]
       
       selector = {
         :fields => ['Id', 'LocationName', 'CanonicalName', 'DisplayType', 'ParentLocations', 'Reach'],
@@ -70,23 +77,31 @@ module Adapi
         ]
       }
 
+      if params[:id]
+        selector[:predicates] = [
+            { :field => 'Id', :operator => 'EQUALS', :values => [ params[:id].to_i ] }
+        ]
+      end
+
       # returns array of locations. and now the fun begins    
       locations = Location.new.service.get(selector)
+
+      if params[:id]
+        return locations.first[:location] rescue nil
+      end
       
       # now we have to find location with correct display_type and TODO hierarchy
       # problematic example: Prague is both city and province (region)
       
-      location = nil 
       locations.each do |entry|
+        next unless entry.is_a?(Hash)
+
         if entry[:location][:display_type] == location_type
-          location = entry[:location]
-          break
+          return entry[:location]
         end
       end
       
-      # FIXME for now, omit hierarchy as check just display type. results will be in 99,5% the same
-
-      location
+      nil
     end
 
     # Displays location tree - location with its parents

data/lib/adapi/version.rb

@@ -1,10 +1,19 @@
 # encoding: utf-8
 
 module Adapi
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 
   # CHANGELOG:
   #
+  # 0.0.8
+  # updated to AdWords API version v201109
+  # updated gem dependencies
+  # removed obsolete monkeypatches
+  # improved SOAP logging - enable pretty logging and configurable log path
+  # added conversion of legacy province_code to province_name in location search
+  # added tests for Campaign, CampaignCriterion and Location service
+  # added Getting Started section to README
+  #
   # 0.0.7
   # fix Location search by country code
   # hotfix OAuth

data/lib/httpi_monkeypatch.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+# manually hardcode timeouts for HTTPI to 5 minutes (300 seconds)
+# TODO check if there's still no way to do it properly through HTTPI
+# TODO enable user to set timeout in adapi configuration
+
+module HTTPI
+  class Request
+    def open_timeout
+      300
+    end
+
+    def read_timeout
+      300
+    end
+  end
+end

data/lib/savon_monkeypatch.rb

@@ -0,0 +1,43 @@
+
+# This monkeypatch adds option to prettify Savon SOAP log
+#
+# Not necessary, but very convenient feature - unless you're fond of deciphering
+# endless SOAP request/response one-liners.
+#
+# Can be safely removed. Should be only temporary, as the idea is taken straight
+# out of Savon pull requests and should be included in its future version.
+
+module Savon
+  module Config
+
+   # Logs a given +message+. Optionally filtered if +xml+ is truthy.
+    def log(message, xml = false)
+      return unless log?
+
+      # ORIG
+      # message = filter_xml(message) if xml && !log_filter.empty?
+
+      # NEW: always run filter_xml method 
+      message = filter_xml(message) # if xml && !log_filter.empty?
+
+      logger.send log_level, message
+    end
+
+    # Filters the given +xml+ based on log filter.
+    def filter_xml(xml)
+      doc = Nokogiri::XML(xml)
+      return xml unless doc.errors.empty?
+
+      log_filter.each do |filter|
+        doc.xpath("//*[local-name()='#{filter}']").map { |node| node.content = "***FILTERED***" }
+      end
+
+      # ORIG
+      # doc.root.to_s
+
+      # NEW: return formatted SOAP
+      doc.to_xml(:indent => 2)
+    end
+
+  end
+end

data/test/factories/ad_group_factory.rb

@@ -2,10 +2,14 @@
 
 the_bids = { :xsi_type => 'ManualCPCAdGroupBids', :keyword_max_cpc => 10 }
 
-Factory.define :ad_group, :class => Adapi::AdGroup do |f|
-  f.sequence(:campaign_id)    { |n| n }
-  f.name                      "AdGroup %d" % (Time.new.to_f * 1000).to_i
-  f.status                    'ENABLED'
-  f.bids                      the_bids
-  f.keywords                  [ 'dem codez', '"top coder"', '[-code]' ]
+FactoryGirl.define do
+
+  factory :ad_group, :class => Adapi::AdGroup do
+    sequence(:campaign_id)    { |n| n }
+    name                      "AdGroup %d" % (Time.new.to_f * 1000).to_i
+    status                    'ENABLED'
+    bids                      the_bids
+    keywords                  [ 'dem codez', '"top coder"', '[-code]' ]
+  end
+
 end

data/test/factories/ad_text_factory.rb

@@ -1,10 +1,14 @@
 # encoding: utf-8
 
-Factory.define :text_ad, :class => Adapi::Ad::TextAd do |f|
-  f.sequence(:ad_group_id)    { |n| n }
-  f.headline                  'Code like Neo'
-  f.description1              'Need mad coding skills?'
-  f.description2              'Check out my new blog!'
-  f.url                       'http://www.demcodez.com'
-  f.display_url               'http://www.demcodez.com'  
+FactoryGirl.define do
+
+  factory :text_ad, :class => Adapi::Ad::TextAd do
+    sequence(:ad_group_id)    { |n| n }
+    headline                  'Code like Neo'
+    description1              'Need mad coding skills?'
+    description2              'Check out my new blog!'
+    url                       'http://www.demcodez.com'
+    display_url               'http://www.demcodez.com'
+  end
+
 end

data/test/factories/campaign_factory.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+FactoryGirl.define do
+
+  a_bidding_strategy = { :xsi_type => 'BudgetOptimizer', :bid_ceiling => 55 }
+
+  factory :valid_campaign, :class => Adapi::Campaign do
+    sequence(:id)             { |n| n }
+    sequence(:name)           { |n| 'Campaign #%s' % n }
+    status                    'PAUSED'
+    bidding_strategy          a_bidding_strategy
+    budget                    50
+  end
+
+end

data/test/integration/create_campaign_test.rb

@@ -3,15 +3,15 @@
 require 'test_helper'
 
 module Adapi
-  class CreateCampaignTest < Test::Unit::TestCase
-    context "non-existent Campaign" do
+  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
 
-    context "existing Campaign" do
+    context "existing campaign" do
       setup do 
         @campaign_data = {
           :name => "Campaign #%d" % (Time.new.to_f * 1000).to_i,
@@ -23,6 +23,13 @@ module Adapi
             :target_search_network => true,
             :target_content_network => false,
             :target_content_contextual => false
+          },
+          
+          :criteria => {
+            :language => %w{ en cs },
+            :location => {
+              :name => { :city => 'Brno', :region => 'CZ-JM', :country => 'CZ' }
+            }
           }
         }
         
@@ -37,6 +44,14 @@ module Adapi
 
         assert_equal @campaign_data[:status], @campaign.status
         assert_equal @campaign_data[:name], @campaign.name
+        
+        # TODO move campaign criteria to separate test
+        criteria = Adapi::CampaignCriterion.find(:campaign_id => @campaign.id)
+        assert_equal %w{ cs en }, criteria.map { |c| c[:code] if c[:type] == "LANGUAGE" }.compact.sort
+
+        location = criteria.find { |c| c[:type] == "LOCATION" }
+        assert_equal "Brno", location[:location_name]
+        assert_equal "City", location[:display_type]
       end      
 
       should "still be found after deletion" do
@@ -46,7 +61,7 @@ module Adapi
 
         assert_equal "DELETED", deleted_campaign.status
         assert_equal @campaign_data[:name], deleted_campaign.name
-      end      
+      end
 
     end
 

data/test/integration/find_location_test.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+module Adapi
+  class FindLocationTest < Test::Unit::TestCase
+    context "non-existent Location" do
+      setup do 
+        @location = Adapi::Location.find( :city => "Shamballa" )
+      end
+
+      should "not be found" do
+        assert_nil @location
+      end
+    end
+
+    context "existing Location" do
+      
+      should "be found by name" do
+        @location = Adapi::Location.find( :country=>"CZ", :province=>"Prague", :city=>"Prague" )
+        assert_not_nil @location
+        assert_equal 1003803, @location[:id]
+        assert_equal "Prague", @location[:location_name]
+        assert_equal "City", @location[:display_type]
+      end
+
+      should "be found by id" do
+        @location = Adapi::Location.find( :id => 1003803 )
+        assert_not_nil @location
+        assert_equal 1003803, @location[:id]
+        assert_equal "Prague", @location[:location_name]
+        assert_equal "City", @location[:display_type]
+      end
+
+      should "be found by country_code" do
+        @location = Adapi::Location.find( :country => "CZ" )
+        assert_not_nil @location
+        assert_equal 2203, @location[:id]
+        assert_equal "Czech Republic", @location[:location_name]
+        assert_equal "Country", @location[:display_type]
+     end
+
+      should "be found by province_code" do
+        @location = Adapi::Location.find( :country => "CZ", :province => "CZ-JM" )
+        assert_not_nil @location
+        assert_equal 20219, @location[:id]
+        assert_equal "South Moravia", @location[:location_name]
+        assert_equal "Region", @location[:display_type]
+     end
+
+    end
+
+  end
+end

data/test/unit/ad/ad_text_test.rb

@@ -12,7 +12,7 @@ module Adapi
 
     context "valid new TextAd instance" do
       setup do
-        @text_ad = Factory.build(:text_ad)
+        @text_ad = FactoryGirl.build(:text_ad)
       end
 
       should "be valid" do

data/test/unit/ad_group_test.rb

@@ -12,7 +12,7 @@ module Adapi
 
     context "valid new instance" do
       setup do
-        @ad_group = Factory.build(:ad_group)
+        @ad_group = FactoryGirl.build(:ad_group)
       end
 
       should "be valid" do

data/test/unit/campaign_test.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+module Adapi
+  class CampaignTest < Test::Unit::TestCase
+  
+    context "invalid Campaign" do
+      setup do
+        @campaign = Campaign.new
+      end
+
+      should "not be valid?" do
+        assert ! @campaign.valid?
+      end
+
+      should "return error messages" do
+        @campaign.valid? # creates errors messages
+        assert ! @campaign.errors.full_messages.empty?
+      end
+    end
+
+    context "Campaign status" do
+      
+      should "be required" do
+        campaign = FactoryGirl.build(:valid_campaign, :status => nil)
+        assert ! campaign.valid?
+        assert campaign.errors.has_key? :status
+      end
+      
+      should "should be only ACTIVE, DELETED or PAUSED" do
+        campaign = FactoryGirl.build(:valid_campaign, :status => "TEST")
+        assert ! campaign.valid?
+        assert campaign.errors.has_key? :status
+      end
+
+    end
+
+    context "Campaign name" do
+      
+      should "be required" do
+        campaign = FactoryGirl.build(:valid_campaign, :name => nil)
+        assert ! campaign.valid?
+        assert campaign.errors.has_key? :name
+      end
+
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapi
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: google-adwords-api
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -192,17 +192,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -270,23 +270,27 @@ files:
 - lib/adapi/constant_data.rb
 - lib/adapi/constant_data/country.rb
 - lib/adapi/constant_data/language.rb
+- lib/adapi/constant_data/province.rb
 - lib/adapi/keyword.rb
 - lib/adapi/location.rb
 - lib/adapi/version.rb
-- lib/ads_common_monkeypatch.rb
-- lib/httpi_request_monkeypatch.rb
+- lib/httpi_monkeypatch.rb
+- lib/savon_monkeypatch.rb
 - test/config/adapi.yml.template
 - test/config/adwords_api.yml.template
 - test/factories/.gitignore
 - test/factories/ad_group_factory.rb
 - test/factories/ad_text_factory.rb
+- test/factories/campaign_factory.rb
 - test/integration/create_campaign_test.rb
+- test/integration/find_location_test.rb
 - test/test_helper.rb
 - test/unit/.gitignore
 - test/unit/ad/ad_text_test.rb
 - test/unit/ad_group_test.rb
 - test/unit/ad_test.rb
 - test/unit/campaign_criterion_test.rb
+- test/unit/campaign_test.rb
 - test/unit/config_test.rb
 homepage: https://github.com/lstejskal/adapi
 licenses: []
@@ -300,12 +304,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -478548313315719997
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -478548313315719997
 requirements: []
 rubyforge_project: adapi
 rubygems_version: 1.8.21