sem4r 0.1.1 → 0.1.2

data/lib/sem4r/report_definition/report_definition.rb

@@ -28,7 +28,52 @@ module Sem4r
 
     attr_reader :id
 
-    g_accessor :name
+    enum :ReportTypes, [
+      :KEYWORDS_PERFORMANCE_REPORT,
+      :AD_PERFORMANCE_REPORT,
+      :URL_PERFORMANCE_REPORT,
+      :ADGROUP_PERFORMANCE_REPORT,
+      :CAMPAIGN_PERFORMANCE_REPORT,
+      :ACCOUNT_PERFORMANCE_REPORT,
+      :SEARCH_QUERY_PERFORMANCE_REPORT,
+      :MANAGED_PLACEMENTS_PERFORMANCE_REPORT,
+      :AUTOMATIC_PLACEMENTS_PERFORMANCE_REPORT,
+      :CAMPAIGN_NEGATIVE_KEYWORDS_PERFORMANCE_REPORT,
+      :CAMPAIGN_NEGATIVE_PLACEMENTS_PERFORMANCE_REPORT,
+    ]
+
+    enum :DateRangeTypes, [
+      :TODAY,
+      :YESTERDAY,
+      :LAST_7_DAYS,
+      :LAST_WEEK,
+      :LAST_14_DAYS,
+      :LAST_30_DAYS,
+      :LAST_BUSINESS_WEEK,
+      :THIS_MONTH,
+      :LAST_MONTH,
+      :ALL_TIME,
+      :CUSTOM_DATE,
+    ]
+
+    enum :DownloadFormatTypes, [
+      :CSVFOREXCEL,
+      :CSV,
+      :TSV,
+      :XML,
+      :GZIPPED_CSV,
+      :GZIPPED_XML
+    ]
+
+    g_accessor :name,    { :xpath => 'reportName' }
+    g_accessor :type,    { :xpath => 'reportType',     :values_in => :ReportTypes }
+    g_accessor :format,  { :xpath => 'downloadFormat', :values_in => :DownloadFormatTypes }
+
+    g_accessor :date_range, { :values_in => :DateRangeTypes }    
+    g_accessor :from
+    g_accessor :to
+    
+    g_set_accessor :field
 
     def initialize(account, name = nil, &block)
       super( account.adwords, account.credentials )
@@ -46,27 +91,44 @@ module Sem4r
     end
 
     def to_s
-      "'#{@name}'"
+      "#{@id}: '#{@name}'"
     end
 
     def to_xml(tag)
       builder = Builder::XmlMarkup.new
       builder.tag!(tag) do |t|
-        t.reportName    @name
+
+        t.id             @id         if @id
+        t.reportName     @name       if @name
+        t.reportType     @type       if @type
+        t.dateRangeType  @date_range if @date_range
+        t.downloadFormat @format     if @format
+
+        #TODO: non costruire selector se il contenuto e' vuoto utile per l'operazione di delete
+        t.selector do |t|
+          fields.each { |f| t.fields f}
+          if from and to
+            t.dateRange do |t|
+              t.min from
+              t.max to
+            end
+          end
+        end
+
       end
     end
 
-
     ###########################################################################
 
     def self.from_element(account, el)
       new(account) do
-        @id          = el.elements["id"].text.strip.to_i
-        name           el.elements["name"].text.strip
-        status         el.elements['status'].text.strip # ACTIVE, PAUSED, DELETED
-        serving_status el.elements['servingStatus']
-        start_date     el.elements['startDate']
-        end_date       el.elements['endDate']
+
+        @id          = el.at_xpath("id").text.strip.to_i
+        name           el.at_xpath('reportName').text.strip
+        type           el.at_xpath('reportType').text.strip
+        format         el.at_xpath('downloadFormat').text.strip
+        # start_date     el.at_xpath('startDate')
+        # end_date       el.at_xpath('endDate')
       end
     end
 
@@ -76,13 +138,11 @@ module Sem4r
 
     def save
       unless @id
-        op = ReportDefinitionOperation.new
-        op.add(self)
-        puts op.to_xml "operations"
+        op = ReportDefinitionOperation.new.add(self)
         soap_message = service.report_definition.mutate(credentials, op.to_xml("operations"))
         add_counters( soap_message.counters )
-        rval = REXML::XPath.first( soap_message.response, "//mutateResponse/rval")
-        id = REXML::XPath.match( rval, "value/id" ).first
+        rval = soap_message.response.at_xpath("//mutateResponse/rval")
+        id = rval.at_xpath("id" )
         @id = id.text.strip.to_i
       end
       self

data/lib/sem4r/report_definition/report_definition_account_extension.rb

@@ -0,0 +1,79 @@
+# -------------------------------------------------------------------------
+# 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
+  
+  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
+
+    def report_fields
+      soap_message = service.report_definition.report_fields(credentials)
+      add_counters( soap_message.counters )
+      els = soap_message.response.xpath("//getReportFieldsResponse/rval")
+      els.map do |el|
+        ReportField.from_element(el)
+      end
+    end
+
+    def report_definition(&block)
+      ReportDefinition.new(self, &block)
+    end
+
+    def p_report_definitions(refresh = false)
+      report_definitions(refresh).each do |report_definition|
+        puts report_definition.to_s
+      end
+    end
+
+    def report_definitions(refresh = false)
+      _report_definitions unless @report_definitions and !refresh
+      @report_definitions
+    end
+
+    private
+
+    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")
+      @report_definitions = els.map do |el|
+        ReportDefinition.from_element(self, el)
+      end
+    end
+
+  end
+
+  class Account
+    include ReportDefinitionAccountExtension
+  end
+
+end

data/lib/sem4r/report_definition/report_definition_operation.rb

@@ -25,10 +25,12 @@
 module Sem4r
   class ReportDefinitionOperation < Operation
     def initialize(&block)
-      @operation_type = "ReportDefinitionOperation"
+      @operation_type = "n1:ReportDefinitionOperation"
+      @namespace = 'xmlns:n1="https://adwords.google.com/api/adwords/cm/v201008"'
       if block_given?
         block.arity < 1 ? instance_eval(&block) : block.call(self)
       end
+      self
     end
   end
 end

data/lib/sem4r/report_definition/report_definition_service.rb

@@ -28,15 +28,14 @@ module Sem4r
 
     def initialize(connector)
       @connector = connector
-      @service_namespace = "https://adwords.google.com/api/adwords/cm/v201003"
-      @header_namespace = @service_namespace
+      @header_namespace = "https://adwords.google.com/api/adwords/cm/v201008"
 
-      @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201003/ReportDefinitionService"
+      @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201008/ReportDefinitionService"
     end
 
-    soap_call_v2009 :get,             :mutate => false
-    soap_call_v2009 :getReportFields, :mutate => false
-    soap_call_v2009 :mutate
+    soap_call_v2010 :get,             :mutate => false
+    soap_call_v2010 :report_fields,   :mutate => false
+    soap_call_v2010 :mutate
 
     private
 
@@ -44,7 +43,8 @@ module Sem4r
       "<get>#{xml}</get>"
     end
 
-    def _get_report_fields
+    def _report_fields
+      "<getReportFields><reportType>URL_PERFORMANCE_REPORT</reportType></getReportFields>"
     end
 
     def _mutate(xml)

data/lib/sem4r/report_definition/report_field.rb

@@ -0,0 +1,57 @@
+# -------------------------------------------------------------------
+# 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
+
+  class ReportField
+    include SoapAttributes
+
+    attrs =[
+      :field_name,
+      :display_field_name,
+      :xml_attribute_name,
+      :field_type,
+      :can_select,
+      :can_filter,
+    ]
+
+    attrs.each do |s|
+      g_accessor s
+    end
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.from_element(*args)
+      _from_element(*args)
+    end
+
+    def to_s
+      "#{@field_name} #{@field_type} #{@address_line2} #{@city}"
+    end
+
+  end
+end

data/lib/sem4r/sem4r_error.rb

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

data/lib/sem4r/services/http_connector.rb

@@ -0,0 +1,93 @@
+# -------------------------------------------------------------------------
+# 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
+
+  class HttpConnector
+    begin
+      require 'patron'
+      UsePatron = false
+      # $stderr.puts "Using patron gems"
+    rescue LoadError
+      UsePatron = false
+      # $stderr.puts "Patron not found, degrade to net/https"
+    end
+
+    if !UsePatron
+      require 'net/https'
+      require 'uri'
+      # $stderr.puts "Using standard net/https"
+    end
+
+    def get_sess_for_host(uri)
+      @sessions ||= {}
+
+      if UsePatron
+        url = uri.scheme + "://" + uri.host
+        sess = @sessions[url]
+        unless sess
+          sess = Patron::Session.new
+          # sess.connect_timeout = 3000 #millis
+          sess.timeout = 12
+          sess.base_url = url
+          sess.headers['User-Agent'] = 'ruby'
+          @sessions[url] = sess
+        end
+        sess
+      else
+        url = uri.scheme + "://" + uri.host
+        sess = @sessions[url]
+        unless sess
+          sess = Net::HTTP.new(uri.host, uri.port)
+          sess.use_ssl = (uri.scheme == "https")
+          @sessions[url] = sess
+        end
+        sess
+      end
+    end
+
+    def invalidate_sess(uri)
+      sess = @sessions[uri.host]
+      if sess
+        # sess.close
+        @sessions[uri.host] = nil
+      end
+    end
+
+    def download(url, path_name)
+
+      if UsePatron
+        uri = URI.parse(url)
+        sess = get_sess_for_host(uri)
+        sess.get_file(uri.path, path_name)
+      else
+        require 'open-uri'
+        data = open(url){ |f| f.read }
+        File.open(path_name, "w") { |f| f.write(data) }
+      end
+
+    end
+  end
+
+end

data/lib/sem4r/services/service.rb

@@ -44,7 +44,7 @@ module Sem4r
     end
 
     ###########################################################################
-    # services v201003
+    # services v2010xx
 
     %w{ ad_extension_override
         ad_group

data/lib/sem4r/services/soap_call.rb

@@ -48,8 +48,8 @@ module Sem4r
       end
     end
 
-    def helper_call_v2009(credentials, soap_body_content)
-      soap_message = SoapMessageV2009.new(@connector, credentials)
+    def helper_call_v2010(credentials, soap_body_content)
+      soap_message = SoapMessageV2010.new(@connector, credentials)
       soap_message.init( @header_namespace, @service_namespace )
       soap_message.body = soap_body_content
       if credentials.sandbox?
@@ -59,6 +59,16 @@ module Sem4r
       end
     end
 
+    def helper_call_v2010_raw(credentials, xml_message)
+      soap_message = SoapMessageV2010.new(@connector, credentials)
+      soap_message.init( @header_namespace, @service_namespace )
+      if credentials.sandbox?
+        soap_message.send_raw(@sandbox_service_url, xml_message)
+      else
+        soap_message.send_raw(@production_service_url, xml_message)
+      end
+    end
+
     module ClassMethods
       def soap_call(helper_version, method, options = {})
         options.assert_valid_keys(:mutate)
@@ -72,7 +82,6 @@ module Sem4r
 
         # private_method_pars = args.join(",")
         # private_method_pars = ", #{private_method_pars}" unless private_method_pars.empty?
-
         rubystr =<<-EOFS
           define_method :#{method.to_sym} do |*args|
             credentials = args.shift
@@ -85,14 +94,27 @@ module Sem4r
           end
         EOFS
         eval rubystr
+
+        rubystr =<<-EOFS
+          define_method :#{(method.to_s + "_raw").to_sym} do |*args|
+            credentials  = args.shift
+            soap_message = args.shift
+            if #{smutate}
+              #{helper_version}_raw(credentials, soap_message)
+            else
+              raise "mutate methods '#{method}' cannot be called on read_only profile"
+            end
+          end
+        EOFS
+        eval rubystr
       end
 
       def soap_call_v13(method, options = {})
         soap_call("helper_call_v13", method, options)
       end
 
-      def soap_call_v2009(method, options = {})
-        soap_call("helper_call_v2009", method, options)
+      def soap_call_v2010(method, options = {})
+        soap_call("helper_call_v2010", method, options)
       end
     end
 

data/lib/sem4r/services/soap_connector.rb

@@ -23,148 +23,6 @@
 
 module Sem4r
 
-  class HttpConnector
-    begin
-      require 'patron'
-      UsePatron = false
-      # $stderr.puts "Using patron gems"
-    rescue LoadError
-      UsePatron = false
-      # $stderr.puts "Patron not found, degrade to net/https"
-    end
-
-    if !UsePatron
-      require 'net/https'
-      require 'uri'
-      # $stderr.puts "Using standard net/https"
-    end
-
-    def get_sess_for_host(uri)
-      @sessions ||= {}
-
-      if UsePatron
-        url = uri.scheme + "://" + uri.host
-        sess = @sessions[url]
-        unless sess
-          sess = Patron::Session.new
-          # sess.connect_timeout = 3000 #millis
-          sess.timeout = 12
-          sess.base_url = url
-          sess.headers['User-Agent'] = 'ruby'
-          @sessions[url] = sess
-        end
-        sess
-      else
-        url = uri.scheme + "://" + uri.host
-        sess = @sessions[url]
-        unless sess
-          sess = Net::HTTP.new(uri.host, uri.port)
-          sess.use_ssl = (uri.scheme == "https")
-          @sessions[url] = sess
-        end
-        sess
-      end
-    end
-
-    def invalidate_sess(uri)
-      sess = @sessions[uri.host]
-      if sess
-        # sess.close
-        @sessions[uri.host] = nil
-      end
-    end
-
-    def download(url, path_name)
-
-      if UsePatron
-        uri = URI.parse(url)
-        sess = get_sess_for_host(uri)
-        sess.get_file(uri.path, path_name)
-      else
-        require 'open-uri'
-        data = open(url){ |f| f.read }
-        File.open(path_name, "w") { |f| f.write(data) }
-      end
-
-    end
-  end
-
-  module SoapDumper
-
-    def initialize
-      @soap_dump = false
-      @soap_dump_log = nil
-    end
-
-    def dump_soap_options( dump_options )
-      @soap_dump = true
-      @soap_dump_log = nil
-
-      if dump_options[:directory]
-        @soap_dump_dir = dump_options[:directory]
-      else
-        @soap_dump_log = File.open( dump_options[:file], "w" )
-      end
-      @soap_dump_format = false || dump_options[:format]
-    end
-
-    def dump_soap(service_url, request_xml, response_xml)
-      return unless @soap_dump
-
-      %w{email password developerToken authToken clientEmail}.each do |tag|
-        request_xml = request_xml.gsub(/<#{tag}([^>]*)>.*<\/#{tag}>/, "<#{tag}\\1>***censured***</#{tag}>")
-      end
-      response_xml.gsub(/<email[^>]*>.+<\/email>/, "<email>**censured**</email>")
-
-      str =""
-      str << "<!-- Post to '#{service_url}' -->\n"
-
-      if !@soap_dump_format
-        str <<  request_xml
-      else
-        xml_document = REXML::Document.new(request_xml)
-        f = REXML::Formatters::Pretty.new
-        out = String.new
-        f.write(xml_document, out)
-        str << out
-      end
-      str << "\n"
-
-      str <<  "<!-- response -->\n"
-      if !@soap_dump_format
-        str <<  response_xml
-      else
-        xml_document = REXML::Document.new(response_xml)
-        f = REXML::Formatters::Pretty.new
-        out = String.new
-        f.write(xml_document, out)
-        str << out
-      end
-      str << "\n"
-      str <<  "<!-- end -->"
-
-      if @soap_dump_dir
-        service = service_url.match(/\/([^\/]*)$/)[1]
-        filename = Time.now.strftime "%Y%m%d-%H%M%S-%L-#{service}.log.xml"
-
-        if not File.directory?(@soap_dump_dir)
-          FileUtils.mkdir_p(@soap_dump_dir)
-        end
-
-        pathname = File.join(@soap_dump_dir, filename)
-        File.open(pathname, "w") {|f|
-          f.puts str
-        }
-      else
-        @soap_dump_log.puts str
-        @soap_dump_log.flush
-      end
-    end
-
-  end
-
-  #################
-
   class SoapConnector < HttpConnector
     include SoapDumper
 
@@ -272,13 +130,10 @@ module Sem4r
       end
 
       response_xml = response.body
-      dump_soap(service_url, soap_message, response_xml)
+      dump_soap_request(service_url, soap_message)
+      dump_soap_response(service_url, response_xml)
       response_xml
     end
-
-    private
-
-    
   end
 
 end