sem4r 0.1.2 → 0.1.3

data/Gemfile

@@ -1,11 +1,22 @@
 source :gemcutter
 
 gem "builder"
-gem "jeweler"
-gem "rake"
 gem "nokogiri"
+gem "httpclient"
+gem 'highline', :require => 'highline/import'
+
+group :development do
+  gem "jeweler"
+  gem "rake"
+  gem "yard"
+  gem "bundler"  # funny!
+end
 
 group :test do
   gem "differ"
   gem "rspec"
 end
+
+#platforms :jruby do
+#  gem 'jruby-openssl'
+#end

data/Gemfile.lock

@@ -5,6 +5,8 @@ GEM
     diff-lcs (1.1.2)
     differ (0.1.1)
     git (1.2.5)
+    highline (1.6.1)
+    httpclient (2.1.5.2)
     jeweler (1.5.1)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
@@ -13,15 +15,16 @@ GEM
     nokogiri (1.4.4-java)
       weakling (>= 0.0.3)
     rake (0.8.7)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    rspec-mocks (2.2.0)
     weakling (0.0.4-java)
+    yard (0.6.3)
 
 PLATFORMS
   java
@@ -30,7 +33,10 @@ PLATFORMS
 DEPENDENCIES
   builder
   differ
+  highline
+  httpclient
   jeweler
   nokogiri
   rake
   rspec
+  yard

data/README.rdoc

@@ -40,20 +40,57 @@ You can list all client accounts:
 See directory examples_sem4r[http://github.com/sem4r/sem4r/tree/master/examples_sem4r/examples_sem4r] for more examples.
 Follow the sem4r.com[http://www.sem4r.com] feed for announcements of new releases.
 
-== Install
-
-  sudo gem install sem4r
-
 == Ruby Versions
 
-Sem4r tested on following ruby version:
+Sem4r last gem was tested on following rubies:
 
 * 1.9.2-p0 - linux (works)
 * jruby 1.5.5 - linux (some example are not working, certificate verify failed OpenSSL in sandbox)
 * ...
 
+== Install
+
+  sudo gem install sem4r
+
+== Api status
+
+=== Campaign Data Management
+
+* CampaignService: ...
+* CampaignTargetService: ...
+* AdGroupService: ...
+* AdGroupAdService: ...
+* CampaignAdExtensionService: ...
+* AdExtensionOverrideService: ...
+* CampaignCriterionService: ...
+* AdGroupCriterionService: ...
+* AdParamService: ...
+* UserListService: ...
+
+=== Optimization
+
+* BidLandscapeService: ...
+* ReportDefinitionService
+* TargetingIdeaService
+* TrafficEstimatorService
+
+=== Account Management
+
+* AlertService
+* CustomerSyncService
+* InfoService
+* ServicedAccountService
+
+=== Utility
+
+* BulkMutateJobService
+* GeoLocationService
+* MediaService
+
 == How to submit a bug report
 
+...
+
 == Contribute
 
 So you want your prefered service supported by sem4r. Great! Please follow this steps:
@@ -71,9 +108,9 @@ So you want your prefered service supported by sem4r. Great! Please follow this
 
 == Contributors
 
-If I miss someone send me a note.
+If I miss someone send me[sem4ruby@gmail.com] a note.
 
-* Glenn Gillen {http://github.com/rubypond}
+* Glenn Gillen[http://github.com/rubypond]
 
 
 To see all contributors execute: git shortlog -n -s --no-merges

data/Rakefile

@@ -1,129 +1,9 @@
 require 'rubygems'
 require 'rake'
 
-#
-# jeweler
-#
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-    gem.name = "sem4r"
-    gem.summary = %Q{Library to access google adwords api. Works with ruby 1.9 and ruby 1.8}
-    gem.description = %Q{
-       Sem4r is a library to access google adwords api.
-       It will works with ruby 1.9 and ruby 1.8 without soap4r.
-       It uses a high level model instead of a low level api.
-       You think about clients, campaigns, keywords and not about operations, operands, selectors, service calls.
-
-       This is a ALPHA version don't use in production.
-       If you are interested in this project let me now: install it and update periodically, so the gemcutter
-       download counter go up. Or subscribe to my feed at sem4r.com. Or watch the project on github.
-       Or simply drop me a line in email. However I will know there is someone out of here.
-    }
-
-    gem.authors = ["Sem4r"]
-    gem.email = "sem4ruby@gmail.com"
-    gem.homepage = "http://www.sem4r.com"
-
-    #
-    # dependecies
-    #
-    # gem.add_dependency 'patron'
-    gem.add_dependency 'builder'
-    gem.add_dependency 'nokogiri'
-    gem.add_development_dependency 'rspec'
-    gem.add_development_dependency 'differ'
-
-    #
-    # files
-    #
-    gem.files  = %w{LICENSE README.rdoc Rakefile VERSION.yml sem4r.gemspec Gemfile Gemfile.lock}
-    gem.files << 'config/sem4r.example.yml'
-    gem.files.concat Dir['examples_sem4r/*.rb']
-    gem.files.concat Dir['examples_blog/*.rb']
-    gem.files.concat Dir['lib/**/*.rb']
-
-    #
-    # test files
-    #
-    gem.test_files = Dir['spec/**/*.rb']
-    gem.test_files.concat Dir['spec/**/*.xml']
-    gem.test_files.concat Dir['spec/fixtures/**/*']
-
-    #
-    # rubyforge
-    #
-    # gem.rubyforge_project = 'sem'
-  end
-
-  # Jeweler::RubyforgeTasks.new do |rubyforge|
-  #   rubyforge.doc_task = "rdoc"
-  # end
-
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-#
-# rdoc
-#
-require 'rake/rdoctask'
-
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "sem4r #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-#
-# spec
-#
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ["--color", "--format", "spec", '--backtrace']
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-#desc "Generate HTML report for failing examples"
-#RSpec::Core::RakeTask.new('failing_examples_with_html') do |spec|
-#  spec.pattern = 'failing_examples/**/*.rb'
-#  spec.rspec_opts = ["--format", "html:doc/reports/tools/failing_examples.html", "--diff"]
-#  spec.fail_on_error = false
-#end
+# Load tasks
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
 
 task :test => :check_dependencies
 task :default => :spec
 
-###############################################################################
-# Sem4r
-
-namespace :sem4r do
-  #
-  # examples
-  #
-  desc 'run all sem4r example'
-  task :examples do
-
-    Dir['examples_sem4r/*.rb'].sort.each do |filename|
-      next unless filename =~ /\d\d.+\.rb$/
-      unless system "ruby #{filename}"
-        exit
-      end
-    end
-    puts "All examples run successfull"
-
-  end
-
-  desc "Start an IRB shell"
-  task :shell do
-    sh 'IRBRC=`pwd`/config/irbrc.rb irb'
-  end
-end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 2
+:patch: 3
 :build: 

data/bin/sem

@@ -31,4 +31,5 @@ $:.unshift(cwd) unless $:.include?(cwd)
 require 'sem4r_cli'
 
 include Sem4r
+include Sem4rCli
 exit CliSem.run

data/examples_sem4r/01_get_account.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/02_get_info.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/03_list_ad.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/04_list_keywords.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/05_request_report.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -21,30 +22,40 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 # -------------------------------------------------------------------
 
-require File.expand_path( File.join( File.dirname(__FILE__), "example_helper") )
+require File.expand_path(File.join(File.dirname(__FILE__), "example_helper"))
 
 run_example(__FILE__) do |adwords|
   account = adwords.account
+
+  puts "report list:"
   account.p_reports
 
+  puts ""
+  puts "schedule new report."
   report = account.report do
-    name                 "Test Report"
-    type                 "Structure"
-    start_day            "2009-01-01"
-    end_day              "2009-01-31"
-    aggregation          "Keyword"
-    column               "Campaign"
-    column               "AdGroup"
-    column               "Keyword"
-    column               "KeywordTypeDisplay"
+    name "Test Report"
+    type "Structure"
+    start_day "2009-01-01"
+    end_day "2009-01-31"
+    aggregation "Keyword"
+    column "Campaign"
+    column "AdGroup"
+    column "Keyword"
+    column "KeywordTypeDisplay"
   end
 
   report.validate
   job = report.schedule
-  job.wait(5) { |r, s| puts "status #{s}" }
-  report.download(tmp_dirname + "/05_request_report.xml")
+  puts "wait 10 sec. before each check status"
+  job.wait(10) do |r, s|
+    puts "status #{s}"
+  end
+
+  puts ""
+  puts "download report in #{tmp_dirname + '/05_request_report.xml'}"
+  report.download(tmp_dirname + '/05_request_report.xml')
 
+  puts ""
+  puts "refresh report list:"
   account.p_reports(true)
-  report = account.reports.first
-  puts report.status(true)
 end

data/examples_sem4r/{05_request_report_2010.rb → 06_request_report_definition.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -29,13 +30,10 @@ run_example(__FILE__) do |adwords|
 
   # account.report_fields
 
-
   rd = account.report_definition do
     name       "Keywords performance report #1290336379254"
     type       "KEYWORDS_PERFORMANCE_REPORT"
-    date_range "CUSTOM_DATE"
-    from       "20100101"
-    to         "20100110"
+    date_range "LAST_WEEK"
     format     "CSV"
 
     field "AdGroupId"

data/examples_sem4r/{06_create_campaigns.rb → 07_create_campaigns.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/{07_create_campaigns_block.rb → 08_create_campaigns_block.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/{07_create_campaigns_simple.rb → 09_create_campaigns_simple.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/{08_ad_params.rb → 10_ad_params.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/{09_targeting_idea.rb → 11_targeting_idea.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 

data/examples_sem4r/{10_get_location.rb → 12_get_location.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/{11_submit_bulk_job.rb → 13_submit_bulk_job.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -23,7 +24,6 @@
 
 require File.expand_path( File.join( File.dirname(__FILE__), "example_helper") )
 
-
 def create_bulk_mutate_job(campaign, adgroup)
   text_ad1 = AdGroupTextAd.new(adgroup)
   text_ad1.headline     = "Cruise to Mars Sector 1"

data/examples_sem4r/{12_list_bulk_job.rb → 14_list_bulk_job.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -26,4 +27,6 @@ require File.expand_path( File.join( File.dirname(__FILE__), "example_helper") )
 run_example(__FILE__) do |adwords|
   account = adwords.account
   account.p_jobs
+  account.job_result(38444)
+  # account.job_delete(33669)
 end

data/examples_sem4r/30_prune_empty_adgroup.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/31_empty_accounts.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/examples_sem4r/example_helper.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -29,7 +30,7 @@ require 'sem4r'
 include Sem4r
 
 def tmp_dirname
-  d = File.join( File.dirname(__FILE__), "..", "tmp" )
+  d = File.expand_path( File.join( File.dirname(__FILE__), "..", "tmp" ) )
   return d if File.directory?(d)
   
   if RUBY_PLATFORM.include?("linux")

data/lib/sem4r/ad_group/ad_group.rb

@@ -65,6 +65,10 @@ module Sem4r
       "#{@id ? @id : 'unsaved'} '#{@name}' (#{@status}) - #{@bid}"
     end
 
+    # Build xml into Builder
+    #
+    # @param [Builder::XmlMarkup]
+    #
     def xml(t)
       t.campaignId campaign.id
       t.name name
@@ -72,6 +76,12 @@ module Sem4r
       @bids.to_xml(t) if @bids
     end
 
+    #
+    # Marshall this object to xml
+    #
+    # @param [String] top level tag
+    # @return [Builder::XmlMarkup]
+    #
     def to_xml(tag)
       builder = Builder::XmlMarkup.new
       builder.tag!(tag) { |t|
@@ -94,6 +104,11 @@ module Sem4r
       new(campaign, &block).save
     end
 
+    #
+    # Unmarshal this object from xml
+    #
+    # @param [Nokogiri::Element] xml element
+    #
     def self.from_element(campaign, el)
       new(campaign) do
         @id          = el.at_xpath("id").text.strip.to_i
@@ -115,7 +130,7 @@ module Sem4r
 
     def _save
       unless @id
-        soap_message = service.ad_group.create(credentials, to_xml("operand"))
+        soap_message = service.ad_group.create( credentials, to_xml("operand") )
         add_counters( soap_message.counters )
         rval = soap_message.response.xpath("//mutateResponse/rval").first
         id = rval.xpath("value/id").first
@@ -126,7 +141,7 @@ module Sem4r
     public
 
     def delete
-      soap_message = service.ad_group.delete(credentials, @id)
+      soap_message = service.ad_group.delete( credentials, @id )
       add_counters( soap_message.counters )
       @id = -1 # logical delete
     end
@@ -179,7 +194,7 @@ module Sem4r
     private
 
     def _ads
-      soap_message = service.ad_group_ad.all(credentials, id)
+      soap_message = service.ad_group_ad.all( credentials, id )
       add_counters( soap_message.counters )
       rval = soap_message.response.xpath("//getResponse/rval").first
       els = rval.xpath( "entries/ad" )
@@ -199,7 +214,7 @@ module Sem4r
         xml + o.to_xml("operations")
       end
 
-      soap_message = service.ad_group_ad.mutate(credentials, xml)
+      soap_message = service.ad_group_ad.mutate( credentials, xml )
       add_counters( soap_message.counters )
       els = soap_message.response.xpath("//mutateResponse/rval/value/ad/id")
 
@@ -266,7 +281,7 @@ module Sem4r
     private
 
     def _criterions
-      soap_message = service.ad_group_criterion.all(credentials, id)
+      soap_message = service.ad_group_criterion.all( credentials, id )
       add_counters( soap_message.counters )
       rval = soap_message.response.xpath("//getResponse/rval").first
       els = rval.xpath( "entries/criterion" )
@@ -287,7 +302,7 @@ module Sem4r
         o = AdGroupCriterionOperation.new.add(ad)
         xml + o.to_xml("operations")
       end
-      soap_message = service.ad_group_criterion.mutate(credentials, xml)
+      soap_message = service.ad_group_criterion.mutate( credentials, xml )
       add_counters( soap_message.counters )
       els = soap_message.response.xpath("//mutateResponse/rval/value/criterion/id")
       els.each_with_index do |e,index|
@@ -324,7 +339,7 @@ module Sem4r
     private
 
     def _ad_params
-      soap_message = service.ad_param.all(credentials, id)
+      soap_message = service.ad_param.all( credentials, id )
       add_counters( soap_message.counters )
       rval = soap_message.response.xpath("//getResponse/rval").first
       els = rval.xpath( "entries" )

data/lib/sem4r/ad_group/ad_group_bids.rb

@@ -23,7 +23,7 @@
 
 module Sem4r
   class AdGroupBids
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     enum :Types, [
       :BudgetOptimizerAdGroupBids,

data/lib/sem4r/ad_group/ad_group_service.rb

@@ -22,19 +22,26 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class AdGroupService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class AdGroupService < Sem4rSoap::SoapServiceV2010
 
     def initialize(connector)
+      super()
       @connector = connector
       @service_namespace = "https://adwords.google.com/api/adwords/cm/v201008"
       @header_namespace = @service_namespace
       @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201008/AdGroupService"
+      init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v2010 :all,       :mutate => false
-    soap_call_v2010 :create,    :mutate => true
-    soap_call_v2010 :delete,    :mutate => true
+    soap_call :all,       :mutate => false
+    soap_call :create,    :mutate => true
+    soap_call :delete,    :mutate => true
+
+    private
 
     def _all(campaign_id)
       <<-EOFS

data/lib/sem4r/ad_group_ad/ad_group_ad.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #

data/lib/sem4r/ad_group_ad/ad_group_ad_operations.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 

data/lib/sem4r/ad_group_ad/ad_group_ad_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -22,20 +23,24 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class AdGroupAdService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class AdGroupAdService < Sem4rSoap::SoapServiceV2010
 
     def initialize(connector)
-      @connector = connector
-      @service_namespace = "https://adwords.google.com/api/adwords/cm/v201008"
-      @header_namespace = @service_namespace
-      
+      @connector           = connector
+      @service_namespace   = "https://adwords.google.com/api/adwords/cm/v201008"
+      @header_namespace    = @service_namespace
+
       @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201008/AdGroupAdService"
+      init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v2010 :all,   :mutate => false
-    soap_call_v2010 :mutate
-      
+    soap_call :all, :mutate => false
+    soap_call :mutate
+
     private
 
     def _all(ad_group_id)