sem4r 0.1.1 → 0.1.2

data/lib/sem4r/services/soap_dumper.rb

@@ -0,0 +1,105 @@
+# -------------------------------------------------------------------------
+# 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 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]
+
+      @soap_dump_interceptor = dump_options[:interceptor] if dump_options[:interceptor]
+    end
+
+    def dump_soap_request(service_url, request_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
+      str = ""
+      str << "<!-- Post to '#{service_url}' -->\n"
+      str << xml_to_s(request_xml) << "\n"
+      dump(service_url, "req", str)
+    end
+
+    def dump_soap_response(service_url, response_xml)
+      return unless @soap_dump
+      response_xml.gsub(/<email[^>]*>.+<\/email>/, "<email>**censured**</email>")
+      str = ""
+      str <<  "<!-- response -->\n" unless @soap_dump_dir
+      str << xml_to_s(response_xml) << "\n"
+      str <<  "<!-- end -->" unless @soap_dump_dir
+      dump(service_url, "res", str)
+    end
+
+    private
+
+    def dump(service_url, type, str)
+
+      @soap_dump_interceptor.call(service_url, type, str) if @soap_dump_interceptor
+
+      if @soap_dump_dir
+        service = service_url.match(/\/([^\/]*)$/)[1]
+        filename = Time.now.strftime "%Y%m%d-%H%M%S-%L-#{service}-#{type}.xml"
+
+        FileUtils.mkdir_p(@soap_dump_dir) unless File.directory?(@soap_dump_dir)
+        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
+
+    def xml_to_s(xml)
+      if !@soap_dump_format
+        xml
+      else
+        # TODO: using nokogiri also for pretty print xml ?
+        require 'rexml/document'
+        xml_document = REXML::Document.new(xml)
+        f = REXML::Formatters::Pretty.new
+        out = String.new
+        f.write(xml_document, out)
+        # remove xml directive
+        out.gsub("<?xml version='1.0' encoding='UTF-8'?>","")
+      end
+    end
+  end
+end

data/lib/sem4r/services/soap_message_v13.rb

@@ -43,8 +43,12 @@ module Sem4r
       soap_message = build_soap_message
       response_xml = @connector.send(service_url, soap_action, soap_message)
       # erase namespace 'nsX'so it more simple parsing the xml
-      response_xml = response_xml.gsub(/ns\d:/, "")
-      @response = REXML::Document.new(response_xml)
+
+      # response_xml = response_xml.gsub(/ns\d:/, "")
+      # @response = REXML::Document.new(response_xml)
+      response_xml.gsub!(/\b(ns\d:|xsi:|s:|soapenv:|env:|soap:)/, "")
+      response_xml.gsub!(/xmlns=["'].*?['"]/, '')
+      @response = Nokogiri::XML::Document.parse(response_xml)
 
       # extract information from header
       #  <soapenv:Header>
@@ -53,12 +57,13 @@ module Sem4r
       #      <units soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns="https://adwords.google.com/api/adwords/v13">5</units>
       #      <requestId soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns="https://adwords.google.com/api/adwords/v13">abade53d3dbecd45600e7d14563f10f1</requestId>
       #  </soapenv:Header>
-      header = REXML::XPath.first(@response, "//soapenv:Header")
+
+      header = @response.xpath("//Header").first
       if header
         @counters = {
-          :response_time => header.elements['responseTime'].text.to_i,
-          :operations => header.elements['operations'].text.to_i,
-          :units => header.elements['units'].text.to_i
+          :response_time => header.at_xpath('responseTime').text.to_i,
+          :operations => header.at_xpath('operations').text.to_i,
+          :units => header.at_xpath('units').text.to_i
         }
       end
       
@@ -77,10 +82,11 @@ module Sem4r
       #  </soapenv:Fault>
       # </soapenv:Body>
       #</soapenv:Envelope>
-      fault_el = REXML::XPath.first(@response, "//soapenv:Fault")
+      #=======
+      fault_el = @response.xpath("//Fault").first
       if fault_el
-        fault_code   = fault_el.elements['faultcode'].text
-        fault_string = fault_el.elements['faultstring'].text
+        fault_code   = fault_el.at_xpath('faultcode').text
+        fault_string = fault_el.at_xpath('faultstring').text
         raise SoapError,  "#{fault_code}: '#{fault_string}'"
       end
       self

data/lib/sem4r/services/{soap_message_v2009.rb → soap_message_v2010.rb}

@@ -23,7 +23,7 @@
 
 module Sem4r
 
-  class SoapMessageV2009
+  class SoapMessageV2010
 
     attr_reader :response
     attr_reader :counters
@@ -50,29 +50,45 @@ module Sem4r
     end
 
     def send(service_url)
-      response_xml = @connector.send(service_url, "", build_soap_message)
+      send_raw(service_url, build_soap_message)
+    end
+
+    def send_raw(service_url, soap_message)
+      soap_message = soap_message.dup
+      soap_message.gsub!(/{authentication_token}/,      @credentials.authentication_token)
+      soap_message.gsub!(/{useragent}/,       @credentials.useragent)
+      soap_message.gsub!(/{developer_token}/, @credentials.developer_token)
+      # soap_message.gsub!(/{client_email}/,    @credentials.client_email)
+      _send_raw(service_url, soap_message)
+    end
+
+    private
+
+    def _send_raw(service_url, soap_message)
+      response_xml = @connector.send(service_url, "", soap_message)
       # erase namespace so it more simple parsing the xml
-      response_xml = response_xml.gsub(/ns\d:/, "")
-      @response = REXML::Document.new(response_xml)
+      response_xml.gsub!(/\b(ns\d:|xsi:|s:|soapenv:|env:|soap:)/, "")
+      response_xml.gsub!(/xmlns=["'].*?['"]/, '')
+      @response = Nokogiri::XML::Document.parse(response_xml)
 
       #
       # extract information from header
       #
-      header = REXML::XPath.first(@response, "//ResponseHeader")
+      header = @response.at_xpath("//ResponseHeader")
       if header
         @counters = {
-          :operations    => header.elements['operations'].text.to_i,
-          :response_time => header.elements['responseTime'].text.to_i,
-          :units         => header.elements['units'].text.to_i
+          :operations    => header.at_xpath("operations").text.to_i,
+          :response_time => header.at_xpath("responseTime").text.to_i,
+          :units         => header.at_xpath("units").text.to_i
         }
       end
 
       #
       # check soap fault
       #
-      fault_el = REXML::XPath.first(@response, "//soap:Fault")
+      fault_el = @response.at_xpath("//Fault")
       if fault_el
-        fault_string = fault_el.elements['faultstring'].text
+        fault_string = fault_el.at_xpath('faultstring').text
         @logger.error("soap error: #{fault_string}") if @logger
         raise fault_string
       end
@@ -108,8 +124,6 @@ module Sem4r
       #</soap:Envelope>
     end
 
-    private
-
     def build_soap_header
       auth_token = @credentials.authentication_token
 

data/lib/sem4r/targeting_idea/targeting_idea.rb

@@ -56,10 +56,10 @@ module Sem4r
     end
 
     def self.from_element(el)
-      els = REXML::XPath.match( el, "data")
+      els = el.xpath("data")
       @attributes = els.map do |el|
-        el1 = el.elements["value"]
-        xml_type =       el1.elements["Attribute.Type"].text.strip
+        el1 = el.at_xpath("value")
+        xml_type = el1.at_xpath("Attribute.Type").text.strip
         case xml_type
         when IdeaTypeAttribute
           TIdeaTypeAttribute.from_element(el1)
@@ -67,6 +67,11 @@ module Sem4r
           TKeywordAttribute.from_element(el1)
         when MonthlySearchVolumeAttribute
           TMonthlySearchVolumeAttribute.from_element(el1)
+        else
+          # added from biilmann trunk
+          Struct.new(:key, :text).new(
+            el.xpath("key").text.strip,
+            el1.xpath("value").text.strip)
         end
       end
     end
@@ -90,10 +95,10 @@ module Sem4r
     end
 
     def self.from_element( el )
-      el1 = el.elements["value"]
+      el1 = el.at_xpath("value")
       new do
-        text       el1.elements["text"].text
-        match_type el1.elements["matchType"].text
+        text       el1.at_xpath("text").text
+        match_type el1.at_xpath("matchType").text
       end
     end
 
@@ -116,11 +121,11 @@ module Sem4r
 
     def self.from_element( el )
       historical_values = []
-      el.elements.each do |node|
+      el.children.each do |node|
         next if node.name == "Attribute.Type"
-        historical_value = { :year => node.elements["year"].text,
-                             :month => node.elements["month"].text}
-        historical_value.merge!(:count => node.elements["count"].text) if node.elements["count"]
+        historical_value = { :year => node.at_xpath("year").text,
+          :month => node.at_xpath("month").text}
+        historical_value.merge!(:count => node.at_xpath("count").text) if node.at_xpath("count")
         historical_values << historical_value
       end
       new do
@@ -146,7 +151,7 @@ module Sem4r
 
     def self.from_element( el )
       new do
-        value       el.elements["value"].text
+        value       el.at_xpath("value").text
       end
     end
 

data/lib/sem4r/targeting_idea/targeting_idea_account_extension.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------
+# 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 TargetingIdeaExtension
+    ############################################################################
+    # Targeting Idea
+
+    def targeting_idea(&block)
+      selector = TargetingIdeaSelector.new(&block)
+      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")
+      els.map do |el|
+        TargetingIdea.from_element( el )
+      end
+    end
+
+    def p_targeting_idea(&block)
+      targeting_ideas = targeting_idea(&block)
+      targeting_ideas.each{ |idea| puts idea }
+    end
+  end
+
+  class Account
+    include TargetingIdeaExtension
+  end
+
+end

data/lib/sem4r/targeting_idea/targeting_idea_selector.rb

@@ -27,7 +27,7 @@ module Sem4r
   class RelatedToKeywordSearchParameter
     include SoapAttributes
 
-    g_accessor :text
+    g_set_accessor :text
     g_accessor :match_type
 
     def initialize(&block)
@@ -37,15 +37,16 @@ module Sem4r
     end
 
     def to_xml
-      <<-EOS
-          <s:searchParameters xsi:type="s:RelatedToKeywordSearchParameter">
-            <s:keywords xsi:type="Keyword">
-              <Criterion.Type>Keyword</Criterion.Type>
-              <text>#{text}</text>
-              <matchType>#{match_type}</matchType>
-            </s:keywords>
-          </s:searchParameters>
-      EOS
+      xml = ""
+      xml << '<s:searchParameters xsi:type="s:RelatedToKeywordSearchParameter">'
+      texts.each do |t|
+        xml << '<s:keywords xsi:type="Keyword">'
+          xml << "<Criterion.Type>Keyword</Criterion.Type>"
+          xml << "<text>#{t}</text>"
+          xml << "<matchType>#{match_type}</matchType>"
+        xml << "</s:keywords>"
+      end
+      xml << '</s:searchParameters>'
     end
   end
 
@@ -118,6 +119,27 @@ module Sem4r
     end
   end
   
+  class NgramGroupsSearchParameter
+    include SoapAttributes
+
+    g_set_accessor :ngram
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def to_xml
+      xml = ""
+      xml << '<s:searchParameters xsi:type="s:NgramGroupsSearchParameter">'
+      ngrams.each do |t|
+        xml << "<s:ngramGroups>#{t}</s:ngramGroups>"
+      end
+      xml << '</s:searchParameters>'
+    end
+  end
+  
   class TargetingIdeaSelector
     include SoapAttributes
 
@@ -153,6 +175,10 @@ module Sem4r
     def country_target_search_parameter(&block)
       @search_parameters << CountryTargetSearchParameter.new(&block)
     end
+    
+    def ngram_group_search_parameter(&block)
+      @search_parameters << NgramGroupsSearchParameter.new(&block)
+    end
 
     def to_xml
       xml=<<-EOFS

data/lib/sem4r/targeting_idea/targeting_idea_service.rb

@@ -28,14 +28,14 @@ module Sem4r
     def initialize(connector)
       @connector = connector
 
-      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201003"
-      @service_namespace = "https://adwords.google.com/api/adwords/o/v201003"
+      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201008"
+      @service_namespace = "https://adwords.google.com/api/adwords/o/v201008"
 
-      @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/o/v201003/TargetingIdeaService"
-      @production_service_url = "https://adwords.google.com/api/adwords/o/v201003/TargetingIdeaService"
+      @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"
     end
 
-    soap_call_v2009 :get, :mutate => false
+    soap_call_v2010 :get, :mutate => false
 
     ################
 

data/lib/sem4r/v13_account/account_account_extension.rb

@@ -0,0 +1,103 @@
+# -------------------------------------------------------------------------
+# 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 AccountAccountExtension
+    ############################################################################
+    # Info Account - Service Account
+
+    def p_info
+      _info unless @currency_code
+      puts "currency_code: #{@currency_code}"
+      puts "customer_id: #{@customer_id}"
+      puts @billing_address
+    end
+
+    def currency_code
+      _info unless @currency_code
+      @currency_code
+    end
+
+    def customer_id
+      _info unless @customer_id
+      @customer_id
+    end
+
+    private
+
+    def _info
+      soap_message = service.account.account_info(credentials)
+      add_counters( soap_message.counters )
+      el = soap_message.response.at_xpath("//getAccountInfoResponse/getAccountInfoReturn")
+      @currency_code = el.at_xpath('currencyCode').text.strip
+      @customer_id   = el.at_xpath('customerId').text.strip
+      @billing_address = BillingAddress.from_element( el.at_xpath('billingAddress') )
+    end
+
+    public
+
+    ############################################################################
+    # Account - Service Account
+
+    def client_accounts(refresh = false)
+      _client_accounts unless @accounts and !refresh
+      @accounts
+    end
+
+    def p_client_accounts(refresh = false)
+      cs = client_accounts(refresh)
+      # puts "#{cs.length} client accounts"
+      cs.each do |account|
+        puts account.to_s
+      end
+      self
+    end
+
+    alias clients client_accounts
+    alias p_clients p_client_accounts
+
+    private
+
+    def _client_accounts
+      soap_message = service.account.client_accounts(credentials)
+      add_counters( soap_message.counters )
+      els = soap_message.response.xpath("//getClientAccountsReturn")
+      @accounts = els.map do |el|
+        client_email = el.text
+        Account.new( adwords, Credentials.new(@credentials, client_email) )
+      end
+    end
+
+    public
+
+    ###########################################################################
+
+  end
+
+  class Account
+    include AccountAccountExtension
+  end
+  
+end

data/lib/sem4r/v13_account/billing_address.rb

@@ -30,6 +30,13 @@ module Sem4r
     g_accessor :address_line1
     g_accessor :address_line2
     g_accessor :city
+    g_accessor :country_code
+    g_accessor :email,           :xpath => 'emailAddress'
+    g_accessor :fax_number
+    g_accessor :name
+    g_accessor :phone,           :xpath => 'phoneNumber'
+    g_accessor :postal_code
+    g_accessor :state
 
     def initialize(&block)
       if block_given?
@@ -37,28 +44,10 @@ module Sem4r
       end
     end
 
-    # <billingAddress>
-    #   <addressLine1>1600 Amphitheatre Parkway</addressLine1>
-    #   <addressLine2>Building #42</addressLine2>
-    #   <city>Mountain View</city>
-    #   <companyName>Some Company</companyName>
-    #   <countryCode>US</countryCode>
-    #   <emailAddress>Some@email</emailAddress>
-    #   <faxNumber>4085551213</faxNumber>
-    #   <name>Some contact</name>
-    #   <phoneNumber>4085551212</phoneNumber>
-    #   <postalCode>94043</postalCode>
-    #   <state>CA</state>
-    # </billingAddress>
-    def self.from_element(el)
-      new do
-        company_name          el.elements["companyName"].text.strip
-        address_line1         el.elements["addressLine1"].text.strip
-        address_line2         el.elements["addressLine2"].text.strip
-        city                  el.elements["city"].text.strip
-      end
+    def self.from_element(*args)
+      _from_element(*args)
     end
-
+    
     def to_s
       "#{@company_name} #{@address_line1} #{@address_line2} #{@city}"
     end

data/lib/sem4r/v13_report/report.rb

@@ -130,11 +130,11 @@ module Sem4r
 
     def self.from_element(account, el)
       new(account) do
-        @id       = el.elements["id"].text.strip.to_i         # id is read only
-        name        el.elements["name"].text.strip
-        start_day   el.elements["startDay"].text.strip
-        end_day     el.elements["endDay"].text.strip
-        @status   = el.elements["status"].text.strip     # status is read only
+        @id       = el.at_xpath("id").text.strip.to_i # id is read only
+        name        el.at_xpath("name").text.strip
+        start_day   el.at_xpath("startDay").text.strip
+        end_day     el.at_xpath("endDay").text.strip
+        @status   = el.at_xpath("status").text.strip # status is read only
       end
     end
 
@@ -144,7 +144,7 @@ module Sem4r
       return @status unless refresh
       soap_message = service.report.status(credentials, @id)
       add_counters( soap_message.counters )
-      el = REXML::XPath.first( soap_message.response, "//getReportJobStatusResponse/getReportJobStatusReturn")
+      el = soap_message.response.xpath("//getReportJobStatusResponse/getReportJobStatusReturn").first
       @status = el.text
     end
 
@@ -163,7 +163,7 @@ module Sem4r
     def schedule
       soap_message = service.report.schedule(credentials, to_xml)
       add_counters( soap_message.counters )
-      el = REXML::XPath.first( soap_message.response, "//scheduleReportJobResponse/scheduleReportJobReturn")
+      el = soap_message.response.xpath("//scheduleReportJobResponse/scheduleReportJobReturn").first
       @id = el.text
       # puts "requested report assigned job nr. #{@job_id}"
       ReportJob.new(self, @id)
@@ -172,7 +172,7 @@ module Sem4r
     def url
       soap_message = service.report.url(credentials, @id)
       add_counters( soap_message.counters )
-      el = REXML::XPath.first( soap_message.response, "//getReportDownloadUrlResponse/getReportDownloadUrlReturn")
+      el = soap_message.response.xpath("//getReportDownloadUrlResponse/getReportDownloadUrlReturn").first
       url = el.text
       url
     end