sem4r 0.1.2 → 0.1.3

data/lib/sem4r/report_definition/report_definition_account_extension.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,41 +20,90 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# 
 # -------------------------------------------------------------------------
 
 module Sem4r
-  
-  module ReportDefinitionAccountExtension
 
-    def report_definition_delete(report_definition_id)
-      report_definition = ReportDefinition.new(self)
-      report_definition.instance_eval { @id = report_definition_id }
-      op = ReportDefinitionOperation.new
-      op.remove(report_definition)
-      soap_message = service.report_definition.mutate(credentials, op.to_xml("operations"))
-      add_counters( soap_message.counters )
-    end
+  module ReportDefinitionAccountExtension
 
-    def report_fields
-      soap_message = service.report_definition.report_fields(credentials)
-      add_counters( soap_message.counters )
+    #
+    # Query the list of field for a report type
+    # @param [ReportDefinition::ReportTypes] a value of
+    #
+    def report_fields(report_type)
+      soap_message = service.report_definition.report_fields(credentials, report_type)
+      add_counters(soap_message.counters)
       els = soap_message.response.xpath("//getReportFieldsResponse/rval")
       els.map do |el|
         ReportField.from_element(el)
       end
     end
 
+    #
+    # Delete a report definition
+    #
+    # @param[ReportDefinition, Number]
+    #
+    def report_definition_delete(repdef_or_id)
+      if repdef_or_id.class == ReportDefinition
+        report_definition = repdef_or_id
+      else
+        report_definition = ReportDefinition.new(self)
+        report_definition.instance_eval { @id = repdef_or_id }
+      end
+
+      op           = ReportDefinitionOperation.remove(report_definition)
+      soap_message = service.report_definition.mutate(credentials, op.to_xml)
+      add_counters(soap_message.counters)
+
+      unless @report_definitions
+        @report_definition.delete_if { |repdef| repdef == report_definition.id }
+      end
+      report_definition.instance_eval { @id = -1 } # repdef status invalid/deleted
+      self
+    end
+
+    #
+    # Delete all report definition
+    #
+    def report_definition_delete_all
+      report_definitions.each do |repdef|
+        repdef.delete
+      end
+    end
+
+    #
+    # Create a new report definition
+    # @yield report definition DSL
+    # @return [ReportDefinition] in unsaved state
+    #
+    # @example 
+    #   account.report_definition do
+    #     name "MyReport"
+    #     ...
+    #   end
+    #
     def report_definition(&block)
       ReportDefinition.new(self, &block)
     end
 
+    #
+    # Prints on stdout the list of report definition contained into account
+    # @param [bool] true if the list must be refreshed
+    # @return self
+    #
     def p_report_definitions(refresh = false)
       report_definitions(refresh).each do |report_definition|
         puts report_definition.to_s
       end
+      self
     end
 
+    #
+    # Returns an array of ReportDefinition
+    # @param [bool] true if the list must be refreshed
+    # @return [Array of ReportDefinition]
+    #
     def report_definitions(refresh = false)
       _report_definitions unless @report_definitions and !refresh
       @report_definitions
@@ -63,8 +113,8 @@ module Sem4r
 
     def _report_definitions
       soap_message = service.report_definition.get(credentials, ReportDefinitionSelector.new.to_xml)
-      add_counters( soap_message.counters )
-      els = soap_message.response.xpath("//entries")
+      add_counters(soap_message.counters)
+      els                 = soap_message.response.xpath("//entries")
       @report_definitions = els.map do |el|
         ReportDefinition.from_element(self, el)
       end

data/lib/sem4r/report_definition/report_definition_operation.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,14 +20,13 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# 
 # -------------------------------------------------------------------------
 
 module Sem4r
   class ReportDefinitionOperation < Operation
     def initialize(&block)
       @operation_type = "n1:ReportDefinitionOperation"
-      @namespace = 'xmlns:n1="https://adwords.google.com/api/adwords/cm/v201008"'
+      @attrs = {'xmlns:n1'=>"https://adwords.google.com/api/adwords/cm/v201008"}
       if block_given?
         block.arity < 1 ? instance_eval(&block) : block.call(self)
       end

data/lib/sem4r/report_definition/report_definition_selector.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,7 +20,6 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# 
 # -------------------------------------------------------------------------
 
 module Sem4r

data/lib/sem4r/report_definition/report_definition_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -23,19 +24,22 @@
 
 module Sem4r
 
-  class ReportDefinitionService
-    include SoapCall
+  #
+  # @private
+  #
+  class ReportDefinitionService < Sem4rSoap::SoapServiceV2010
 
     def initialize(connector)
       @connector = connector
       @header_namespace = "https://adwords.google.com/api/adwords/cm/v201008"
 
       @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201008/ReportDefinitionService"
+      init(@header_namespace, @service_namespace)      
     end
 
-    soap_call_v2010 :get,             :mutate => false
-    soap_call_v2010 :report_fields,   :mutate => false
-    soap_call_v2010 :mutate
+    soap_call :get,             :mutate => false
+    soap_call :report_fields,   :mutate => false
+    soap_call :mutate
 
     private
 
@@ -43,8 +47,8 @@ module Sem4r
       "<get>#{xml}</get>"
     end
 
-    def _report_fields
-      "<getReportFields><reportType>URL_PERFORMANCE_REPORT</reportType></getReportFields>"
+    def _report_fields(report_type)
+      "<getReportFields><reportType>#{report_type}</reportType></getReportFields>"
     end
 
     def _mutate(xml)

data/lib/sem4r/report_definition/report_field.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -24,7 +25,7 @@
 module Sem4r
 
   class ReportField
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     attrs =[
       :field_name,
@@ -50,7 +51,7 @@ module Sem4r
     end
 
     def to_s
-      "#{@field_name} #{@field_type} #{@address_line2} #{@city}"
+      "#{@field_name} #{@field_type}"
     end
 
   end

data/lib/sem4r/sem4r_templates.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# -------------------------------------------------------------------------
+# Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# -------------------------------------------------------------------------
+
+module Sem4r
+
+  # @private
+  #
+  # create an example mutate job useful for test, example, etc
+  #
+  def template_campaign_and_ad_group(account)
+    client_account = account.client_accounts.first
+
+    campaign       = Campaign.create(client_account) do
+      name "campaign #{Time.now.strftime('%m%d-%H%M%S')}"
+    end
+
+    ad_group       = campaign.ad_group do
+      name "adgroup #{Time.now.strftime('%m%d-%H%M%S')}"
+    end
+
+    puts "created campaign '#{campaign.name}' with id '#{campaign.id}'"
+    puts "created adgroup '#{ad_group.name}' with id '#{ad_group.id}'"
+    [campaign, ad_group]
+  end
+
+  # @private
+  #
+  # create an example mutate job useful for test, example, etc
+  #
+  def template_bulk_mutate_job(campaign, adgroup)
+    # TextAd
+    text_ad1                    = AdGroupTextAd.new(adgroup)
+    text_ad1.headline           = "Cruise to Mars Sector 1"
+    text_ad1.description1       = "Visit the Red Planet in style."
+    text_ad1.description2       = "Low-gravity fun for everyone!"
+    text_ad1.url                = "http://www.example.com"
+    text_ad1.display_url        = "www.example.com"
+
+    # TextAd
+    text_ad2                    = AdGroupTextAd.new(adgroup)
+    text_ad2.headline           = "Cruise to Mars Sector 2"
+    text_ad2.description1       = "Visit the Red Planet in style."
+    text_ad2.description2       = "Low-gravity fun for everyone!"
+    text_ad2.url                = "http://www.example.com"
+    text_ad2.display_url        = "www.example.com"
+
+
+    bulk_mutate_job             = BulkMutateJob.new
+    bulk_mutate_job.campaign_id = campaign.id
+    bulk_mutate_job.add_operation AdGroupAdOperation.add text_ad1
+    bulk_mutate_job.add_operation AdGroupAdOperation.add text_ad2
+
+    bulk_mutate_job
+  end
+  
+end

data/lib/sem4r/{services/service.rb → service.rb}

@@ -22,53 +22,53 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class Service
 
-    def initialize(connector)
-      @connector = connector
-    end
+    class Service #:nodoc: all
+
+      def initialize(connector)
+        @connector = connector
+      end
 
-    ###########################################################################
-    # services v13
+      ###########################################################################
+      # services v13
 
-    %w{ account report traffic_estimator }.each do |service|
-      klass_name = service.split('_').map{|p| p.capitalize}.join('')
-      str=<<-EOFR
+      %w{ account report }.each do |service|
+        klass_name = service.split('_').map{|p| p.capitalize}.join('')
+        str=<<-EOFR
         require 'sem4r/v13_#{service}/#{service}_service'
         def #{service}
           return @#{service}_service if @#{service}_service
           @#{service}_service = #{klass_name}Service.new(@connector)
         end
-      EOFR
-      eval str
-    end
+        EOFR
+        eval str
+      end
 
-    ###########################################################################
-    # services v2010xx
+      ###########################################################################
+      # services v2010xx
 
-    %w{ ad_extension_override
+      %w{ 
         ad_group
         ad_group_ad
         ad_param
         ad_group_criterion
         campaign
-        campaign_criterion 
-        campaign_target
         geo_location
         info
         targeting_idea
         bulk_mutate_job
         report_definition }.each do |service|
-      klass_name = service.split('_').map{|p| p.capitalize}.join('')
-      str=<<-EOFR
+        klass_name = service.split('_').map{|p| p.capitalize}.join('')
+        str=<<-EOFR
         require 'sem4r/#{service}/#{service}_service'
         def #{service}
           return @#{service}_service if @#{service}_service
           @#{service}_service = #{klass_name}Service.new(@connector)
         end
-      EOFR
-      eval str
+        EOFR
+        eval str
+      end
+
     end
 
-  end
-end
+end # module Sem4r

data/lib/sem4r/targeting_idea/targeting_idea.rb

@@ -26,7 +26,7 @@ module Sem4r
 
 
   class TargetingIdea
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     enum :AttributeTypes, [
       :AdFormatSpecListAttribute,
@@ -83,7 +83,7 @@ module Sem4r
   end
 
   class TKeywordAttribute
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_accessor :text
     g_accessor :match_type
@@ -108,7 +108,7 @@ module Sem4r
   end
   
   class TMonthlySearchVolumeAttribute
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_accessor :text
     g_accessor :values
@@ -139,7 +139,7 @@ module Sem4r
   end
 
   class TIdeaTypeAttribute
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_accessor :value
 

data/lib/sem4r/targeting_idea/targeting_idea_account_extension.rb

@@ -30,7 +30,7 @@ module Sem4r
 
     def targeting_idea(&block)
       selector = TargetingIdeaSelector.new(&block)
-      soap_message = service.targeting_idea.get(@credentials, selector.to_xml)
+      soap_message = service.targeting_idea.get(credentials, selector.to_xml)
       add_counters( soap_message.counters )
       rval = soap_message.response.at_xpath("//getResponse/rval")
       els = rval.xpath("entries")

data/lib/sem4r/targeting_idea/targeting_idea_selector.rb

@@ -25,7 +25,7 @@
 module Sem4r
 
   class RelatedToKeywordSearchParameter
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_set_accessor :text
     g_accessor :match_type
@@ -51,7 +51,7 @@ module Sem4r
   end
 
   class ExcludedKeywordSearchParameter
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_accessor :text
     g_accessor :match_type
@@ -76,7 +76,7 @@ module Sem4r
   end
 
   class KeywordMatchTypeSearchParameter
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_set_accessor :match_type
 
@@ -97,7 +97,7 @@ module Sem4r
   end
 
   class CountryTargetSearchParameter
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_set_accessor :country_code
 
@@ -120,7 +120,7 @@ module Sem4r
   end
   
   class NgramGroupsSearchParameter
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_set_accessor :ngram
 
@@ -141,7 +141,7 @@ module Sem4r
   end
   
   class TargetingIdeaSelector
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     enum :IdeaTypes, [:KEYWORD, :PLACEMENT]
     enum :RequestTypes, [:IDEAS, :STATS]

data/lib/sem4r/targeting_idea/targeting_idea_service.rb

@@ -22,8 +22,11 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class TargetingIdeaService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class TargetingIdeaService < Sem4rSoap::SoapServiceV2010 #:nodoc: all
 
     def initialize(connector)
       @connector = connector
@@ -33,11 +36,10 @@ module Sem4r
 
       @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/o/v201008/TargetingIdeaService"
       @production_service_url = "https://adwords.google.com/api/adwords/o/v201008/TargetingIdeaService"
+      init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v2010 :get, :mutate => false
-
-    ################
+    soap_call :get, :mutate => false
 
     private
 

data/lib/sem4r/v13_account/account_account_extension.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,19 +20,20 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# 
 # -------------------------------------------------------------------------
 
 module Sem4r
 
   module AccountAccountExtension
+
     ############################################################################
-    # Info Account - Service Account
+    # Info
 
     def p_info
       _info unless @currency_code
       puts "currency_code: #{@currency_code}"
       puts "customer_id: #{@customer_id}"
+      puts "email: #{@credentials.client_email}" if @credentials.client_email
       puts @billing_address
     end
 
@@ -59,7 +61,7 @@ module Sem4r
     public
 
     ############################################################################
-    # Account - Service Account
+    # Client
 
     def client_accounts(refresh = false)
       _client_accounts unless @accounts and !refresh
@@ -67,9 +69,8 @@ module Sem4r
     end
 
     def p_client_accounts(refresh = false)
-      cs = client_accounts(refresh)
-      # puts "#{cs.length} client accounts"
-      cs.each do |account|
+      client_accounts(refresh)
+      @accounts.each do |account|
         puts account.to_s
       end
       self
@@ -90,10 +91,6 @@ module Sem4r
       end
     end
 
-    public
-
-    ###########################################################################
-
   end
 
   class Account

data/lib/sem4r/v13_account/account_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -22,17 +23,22 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class AccountService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class AccountService < Sem4rSoap::SoapServiceV13
 
     def initialize(connector)
+      super()
       @connector = connector
       @sandbox_service_url    = "https://sandbox.google.com/api/adwords/v13/AccountService"
       @production_service_url = "https://adwords.google.com/api/adwords/v13/AccountService"
+      # init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v13 :account_info,    :mutate => false
-    soap_call_v13 :client_accounts, :mutate => false
+    soap_call :account_info,    :mutate => false
+    soap_call :client_accounts, :mutate => false
 
     private
 

data/lib/sem4r/v13_account/billing_address.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,12 +20,11 @@
 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-# 
 # -------------------------------------------------------------------------
 
 module Sem4r
   class BillingAddress
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     g_accessor :company_name
     g_accessor :address_line1

data/lib/sem4r/v13_report/report_service.rb

@@ -22,25 +22,27 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class ReportService
 
-    include SoapCall
+  #
+  # @private
+  #
+  class ReportService < Sem4rSoap::SoapServiceV13
 
     def initialize(connector)
+      super()
       @connector = connector
       @namespace = "https://adwords.google.com/api/adwords/v13"
 
       @sandbox_service_url    = "https://sandbox.google.com/api/adwords/v13/ReportService"
       @production_service_url = "https://adwords.google.com/api/adwords/v13/ReportService"
+      # init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v13 :all,      :mutate => false 
-    soap_call_v13 :validate, :mutate => false 
-    soap_call_v13 :schedule, :mutate => false 
-    soap_call_v13 :status,   :mutate => false 
-    soap_call_v13 :url,      :mutate => false 
-
-    ################
+    soap_call :all,      :mutate => false 
+    soap_call :validate, :mutate => false
+    soap_call :schedule, :mutate => false
+    soap_call :status,   :mutate => false
+    soap_call :url,      :mutate => false
 
     def download(url, path_name)
       @connector.download(url, path_name)