adapi 0.0.3 → 0.0.4

data/lib/adapi/version.rb

@@ -1,8 +1,16 @@
+# encoding: utf-8
+
 module Adapi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   # CHANGELOG:
   #
+  # 0.0.4
+  # changed README to markdown format
+  # updated DSL for creating campaign and campaign target
+  # implemented find methods for campaigns and ad groups
+  # implemented getting complete campaigns (in one hash with targets, ad groups, keywords and ads)
+  #
   # 0.0.3
   # converted to ActiveModel
   # moved common functionality to Api class

data/lib/httpi_request_monkeypatch.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 # manually hardcode timeouts for HTTPI to 5 minutes (300 seconds)
 # HOTFIX there's no way how to do it properly through HTTPI

data/test/factories/ad_group_factory.rb

@@ -1,20 +1,11 @@
+# encoding: utf-8
+
+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                    {}
+  f.bids                      the_bids
   f.keywords                  [ 'dem codez', '"top coder"', '[-code]' ]
 end
-
-=begin
-ad_group_data = {
-  :bids => {
-    :xsi_type => 'ManualCPCAdGroupBids',
-    :keyword_max_cpc => {
-      :amount => {
-        :micro_amount => 10000000
-      }
-    }
-  },
-=end

data/test/factories/ad_text_factory.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 Factory.define :text_ad, :class => Adapi::Ad::TextAd do |f|
   f.sequence(:ad_group_id)    { |n| n }

data/test/test_helper.rb

@@ -1,5 +1,7 @@
+# encoding: utf-8
 
 require 'rubygems'
+gem 'minitest'
 require 'test/unit'
 require 'turn'
 require 'shoulda'
@@ -17,4 +19,5 @@ class Test::Unit::TestCase
   
   FakeWeb.allow_net_connect = false
 
+
 end

data/test/unit/ad/ad_text_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'test_helper'
 
 module Adapi

data/test/unit/ad_group_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'test_helper'
 
 module Adapi
@@ -17,8 +19,15 @@ module Adapi
         assert @ad_group.valid?
       end
 
-      should "parse :keywords correctly" do
-        
+      should "parse :bids correctly" do
+        # FIXME factory doesn't work in this case for some reason
+        ag = AdGroup.new( :bids => { :xsi_type => 'ManualCPCAdGroupBids', :keyword_max_cpc => 10 } )
+
+        assert_equal ag.bids,
+        {
+          :xsi_type => 'ManualCPCAdGroupBids',
+          :keyword_max_cpc => { :amount => { :micro_amount => 10000000 } }
+        }
       end
 
       context " / data method" do

data/test/unit/ad_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'test_helper'
 
 module Adapi

data/test/unit/campaign_target_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'test_helper'
 
 module Adapi
@@ -10,6 +12,11 @@ module Adapi
           [{:language_code => 'en'}, {:language_code => 'cs'}]
       end
 
+      should "automatically convert :language targets to lowercase" do
+        assert_equal CampaignTarget.create_targets(:language, ['EN', 'CS']),
+          [{:language_code => 'en'}, {:language_code => 'cs'}]
+      end
+
       should "parse :geo / :country and :province targets" do
         assert_equal CampaignTarget.create_targets(:geo, {:country => 'CZ', :province => 'CZ-PR'}),
           [
@@ -18,6 +25,14 @@ module Adapi
           ]
       end
 
+      should "automatically convert :geo / :country and :province targets to uppercase" do
+        assert_equal CampaignTarget.create_targets(:geo, {:country => 'cz', :province => 'cz-pr'}),
+          [
+            {:xsi_type => 'CountryTarget', :excluded => false, :country_code => 'CZ'},
+            {:xsi_type => 'ProvinceTarget', :excluded => false, :province_code => 'CZ-PR'}
+          ]
+      end
+
       should "parse :geo / :proximity targets" do
         assert_equal CampaignTarget.create_targets(:geo,
           {:proximity => {:geo_point => '38.89859,-77.035971', :radius => '10 km'}}),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-26 00:00:00.000000000 +02:00
-default_executable: 
+date: 2011-12-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
-  requirement: &16900920 !ruby/object:Gem::Requirement
+  requirement: &15506360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *16900920
+  version_requirements: *15506360
 - !ruby/object:Gem::Dependency
   name: google-adwords-api
-  requirement: &16900260 !ruby/object:Gem::Requirement
+  requirement: &15455540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,32 +32,32 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *16900260
+  version_requirements: *15455540
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &16899620 !ruby/object:Gem::Requirement
+  requirement: &15454880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *16899620
+  version_requirements: *15454880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &16899100 !ruby/object:Gem::Requirement
+  requirement: &15454300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *16899100
+  version_requirements: *15454300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16898440 !ruby/object:Gem::Requirement
+  requirement: &15453760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,32 +65,54 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *16898440
+  version_requirements: *15453760
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &16896280 !ruby/object:Gem::Requirement
+  requirement: &15453080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.15
+        version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *16896280
+  version_requirements: *15453080
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &15452120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *15452120
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &15449500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *15449500
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &16895700 !ruby/object:Gem::Requirement
+  requirement: &15423440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - =
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *16895700
+  version_requirements: *15423440
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &16895040 !ruby/object:Gem::Requirement
+  requirement: &15420900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16895040
+  version_requirements: *15420900
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &16894420 !ruby/object:Gem::Requirement
+  requirement: &15419460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +131,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16894420
+  version_requirements: *15419460
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &16893920 !ruby/object:Gem::Requirement
+  requirement: &15418480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15418480
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &15417640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,7 +153,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16893920
+  version_requirements: *15417640
 description: This gem provides user-friendly interface to Google Adwords API.
 email:
 - lucastej@gmail.com
@@ -132,7 +164,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - adapi.gemspec
 - examples/add_ad_group.rb
@@ -146,6 +178,10 @@ files:
 - examples/add_text_ad.rb
 - examples/custom_settings.yml
 - examples/customize_configuration.rb
+- examples/delete_keyword.rb
+- examples/find_all_campaigns.rb
+- examples/find_campaign.rb
+- examples/find_campaign_ad_groups.rb
 - examples/log_to_specific_account.rb
 - examples/rollback_campaign.rb
 - examples/update_campaign.rb
@@ -161,7 +197,6 @@ files:
 - lib/adapi/config.rb
 - lib/adapi/keyword.rb
 - lib/adapi/version.rb
-- lib/collection.rb
 - lib/httpi_request_monkeypatch.rb
 - test/factories/.gitignore
 - test/factories/ad_group_factory.rb
@@ -172,7 +207,6 @@ files:
 - test/unit/ad_group_test.rb
 - test/unit/ad_test.rb
 - test/unit/campaign_target_test.rb
-has_rdoc: true
 homepage: ''
 licenses: []
 post_install_message: 
@@ -193,8 +227,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: adapi
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: User-friendly interface to Google Adwords API
 test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,162 +0,0 @@
-== Adapi
-
-Adapi (shortened "AdWords API") is a library for easy and painless work with
-Google Adwords API. Its users shouldn't bother with SOAP and tangle of XML- and
-API-specific objects (remember adwords4r gem?), inputs and outputs are plain
-Ruby arrays and hashes.
-
-Adapi is built on new Google Adwords API gems: google-ads-common and
-google-adwords-api. Arrays and hashes instead of objects come from there, but
-adapi takes it several steps further. AdWords services are represented by models
-with relations, so among other things it's possible to create whole campaign in
-single method call: Adapi::Campaign.create(campaign_data). Various convenience
-methods are added to the models, for example: campaign.pause! (pauses
-campaign). Adapi enables multiple AdWords accounts to be used at the same time.
-
-Adapi is STILL IN DEVELOPMENT and not nearly done yet! Version 1.0.0 should have
-all planned functionality.
-
-== Installation
-
-       gem install adapi
-
-=== from git repository
-
-       bundle install
-       rake install
-
-== Configuration
-
-This section explains how to connect to specific AdWords account and client.
-
-You can set many AdWords accounts to connect to and switch between while running
-the application. You can even update single values of the settings on-the-fly.
-
-       # load the settings
-       Adapi::Config.load_settings(:in_hash => {
-         :coca_cola => {
-           :authentication => {
-             :method => 'ClientLogin',
-             :email => 'coca_cola_email@gmail.com',
-             :password => 'coca_cola_password',
-             :developer_token => 'coca_cola_developer_token',
-             :user_agent => 'Coca-Cola Adwords API Test'
-           },
-           :service => {
-             :environment => 'SANDBOX'
-           }
-         },
-        :pepsi => {
-           :authentication => {
-             :method => 'ClientLogin',
-             :email => 'pepsi_email@gmail.com',
-             :password => 'pepsi_password',
-             :developer_token => 'pepsi_developer_token',
-             :user_agent => 'Pepsi Adwords API Test'
-           },
-           :service => {
-             :environment => 'SANDBOX'
-           }
-         }
-       })
-
-       # set to pepsi and specific client       
-       Adapi::Config.set(:pepsi, :client_customer_id => '555-666-7777')
-       
-       # do some stuff here...
-       
-       # set to coca-cola and another client       
-       Adapi::Config.set(:coca_cola, :client_customer_id => '777-666-5555')
-
-       # do some stuff here...
-
-=== Authentication workflow
-
-* load configuration from ~/adapi.yml
-* load configuration from ~/adwords_api.yml (default configuration for AdWords gems
-  from Google)
-* set configuration directly to Adapi::Config (overrides previous settings)
-
-=== Configuration by adapi.yml
-
-Stored in ~/adapi.yml. Supports multiple accounts, which are identifed by
-aliases. Example:
-
-      :default:
-        :authentication:
-          :method: ClientLogin
-          :email: default_email@gmail.com
-          :password: default_password
-          :developer_token: default_token
-          :client_email: default_client_email@gmail.com
-          :user_agent: My Adwords API Client
-        :service:
-          :environment: PRODUCTION
-      
-      :sandbox:
-        :authentication:
-          :method: ClientLogin
-          :email: sandbox_email@gmail.com
-          :password: sandbox_password
-          :developer_token: sandbox_token
-          :client_email: sandbox_client_email@gmail.com
-          :user_agent: Adwords API Test
-        :service:
-          :environment: SANDBOX
-
-You tell adapi which account to use by setting an alias:
-
-      Adapi::Config.set(:sandbox)
-
-:default account is, as name implies, used by default. You must either set an
-alias to Adapi::Config or have account with :default alias available.
-
-=== Configuration by adwords_api.yml
-
-If you already have google-adwords-api gem configured and use just one account,
-the same configuration will also work for adapi: ~/adwords_api.yml
-
-=== Configuration directly in code
-
-Before logging into the Adwords API, you can set global settings through
-Adapi::Config:
-
-  # load the settings
-  Adapi::Config.load_settings(:in_hash => {
-    :sandbox => {   
-        :authentication => {
-          :method           => "ClientLogin"
-          :email            => "sandbox_email@gmail.com",
-          :password         => "sandbox_password",
-          :developer_token  => "sandbox_token",
-          :client_email     => "sandbox_client_email@gmail.com",
-          :user_agent       => "Adwords API Test"
-        },
-        :service => {
-          :environment      => "SANDBOX"
-        }
-    }
-  })
-  
-  Adapi::Config.set(:sandbox)
-
-== TODO API
-
-AdWords Services are implemented as models, similar to ActiveRecord models of
-database tables. They are built on ActiveModel.
-
-== API Version Support
-
-Adapi supports only the latest version of Google AdWords API: v201101. Older
-versions will not be supported. v201101 and newer versions will still be
-supported when new versions are released.
-
-== Examples
-
-Example are available in /examples directory. For now, they are mostly just dumb
-rewrites of examples from google-adwords-api gem, but that's going to change
-when proper UI to AdWords models will be implemented.
-
-== Author
-
-Lukas Stejskal