sem4r 0.1.1

data/lib/sem4r/services/soap_message_v13.rb

@@ -0,0 +1,129 @@
+# -------------------------------------------------------------------
+# 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 SoapMessageV13
+
+    attr_reader :response
+    attr_reader :counters
+
+    def initialize(connector, credentials)
+      @credentials = credentials
+      @connector = connector
+      @response = nil
+      @counters = {}
+    end
+
+    def body=(soap_body_content)
+      @soap_body_content = soap_body_content
+    end
+
+    def send(service_url, soap_action)
+      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)
+
+      # extract information from header
+      #  <soapenv:Header>
+      #      <responseTime soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns="https://adwords.google.com/api/adwords/v13">16</responseTime>
+      #      <operations soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next" soapenv:mustUnderstand="0" xmlns="https://adwords.google.com/api/adwords/v13">5</operations>
+      #      <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")
+      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
+        }
+      end
+      
+      # check soap fault
+      #<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+      # <soapenv:Body>
+      #  <soapenv:Fault>
+      #   <faultcode>soapenv:Server.generalException</faultcode>
+      #   <faultstring>An internal error has occurred.  Please retry your request.</faultstring>
+      #   <detail>
+      #    <fault xmlns:ns1="https://adwords.google.com/api/adwords/v13">
+      #     <code>0</code>
+      #     <message>An internal error has occurred.  Please retry your request.</message>
+      #    </fault>
+      #   </detail>
+      #  </soapenv:Fault>
+      # </soapenv:Body>
+      #</soapenv:Envelope>
+      fault_el = REXML::XPath.first(@response, "//soapenv:Fault")
+      if fault_el
+        fault_code   = fault_el.elements['faultcode'].text
+        fault_string = fault_el.elements['faultstring'].text
+        raise SoapError,  "#{fault_code}: '#{fault_string}'"
+      end
+      self
+    end
+
+    private
+
+    def build_soap_header(credentials)
+      str= <<-EOFS
+      <env:Header>
+        <email env:mustUnderstand="0">#{credentials.email}</email>
+        <password env:mustUnderstand="0">#{credentials.password}</password>
+      EOFS
+
+      if credentials.client_email
+        str += "<clientEmail env:mustUnderstand=\"0\">#{credentials.client_email}</clientEmail>"
+      end
+
+      str += <<-EOFS
+        <useragent env:mustUnderstand="0">#{credentials.useragent}</useragent>
+        <developerToken env:mustUnderstand="0">#{credentials.developer_token}</developerToken>
+      </env:Header>
+      EOFS
+      str
+    end
+
+    def build_soap_message
+      soap_message = '<?xml version="1.0" encoding="utf-8" ?>'
+      soap_message +=<<-EOFS
+      <env:Envelope
+         xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+      EOFS
+      soap_message += build_soap_header(@credentials)
+      soap_message += "<env:Body>"
+      soap_message += @soap_body_content
+      soap_message += <<-EOFS
+      </env:Body>
+    </env:Envelope>
+      EOFS
+      soap_message
+    end
+
+  end
+end

data/lib/sem4r/services/soap_message_v2009.rb

@@ -0,0 +1,170 @@
+# -------------------------------------------------------------------
+# 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 SoapMessageV2009
+
+    attr_reader :response
+    attr_reader :counters
+    
+    def initialize(connector, credentials)
+      @connector = connector
+      @credentials = credentials
+      @response = nil
+      @counters = {}
+      @logger = nil
+    end
+
+    def logger=(logger)
+      @logger= logger
+    end
+
+    def init(header_namespace, service_namespace)
+      @header_namespace = header_namespace
+      @service_namespace = service_namespace
+    end
+
+    def body=(soap_body_content)
+      @soap_body_content = soap_body_content
+    end
+
+    def send(service_url)
+      response_xml = @connector.send(service_url, "", build_soap_message)
+      # erase namespace so it more simple parsing the xml
+      response_xml = response_xml.gsub(/ns\d:/, "")
+      @response = REXML::Document.new(response_xml)
+
+      #
+      # extract information from header
+      #
+      header = REXML::XPath.first(@response, "//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
+        }
+      end
+
+      #
+      # check soap fault
+      #
+      fault_el = REXML::XPath.first(@response, "//soap:Fault")
+      if fault_el
+        fault_string = fault_el.elements['faultstring'].text
+        @logger.error("soap error: #{fault_string}") if @logger
+        raise fault_string
+      end
+      self
+
+      #  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      #    <soap:Header>
+      #        <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v200909">
+      #            <requestId>e7c3b00f339bcaf56b7df47db97efdb7</requestId>
+      #            <operations>1</operations>
+      #            <responseTime>231</responseTime>
+      #            <units>1</units>
+      #        </ResponseHeader>
+      #    </soap:Header>
+      #    <soap:Body>
+      #        <soap:Fault>
+      #            <faultcode>soap:Server</faultcode>
+      #            <faultstring>[CampaignError.DUPLICATE_CAMPAIGN_NAME @ operations[0].operand.name]</faultstring>
+      #            <detail>
+      #                <ApiExceptionFault xmlns="https://adwords.google.com/api/adwords/cm/v200909">
+      #                    <message>[CampaignError.DUPLICATE_CAMPAIGN_NAME @ operations[0].operand.name]</message>
+      #                    <ApplicationException.Type>ApiException</ApplicationException.Type>
+      #                    <errors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CampaignError">
+      #                        <fieldPath>operations[0].operand.name</fieldPath>
+      #                        <trigger></trigger>
+      #                        <ApiError.Type>CampaignError</ApiError.Type>
+      #                        <reason>DUPLICATE_CAMPAIGN_NAME</reason>
+      #                    </errors>
+      #                </ApiExceptionFault>
+      #            </detail>
+      #        </soap:Fault>
+      #    </soap:Body>
+      #</soap:Envelope>
+    end
+
+    private
+
+    def build_soap_header
+      auth_token = @credentials.authentication_token
+
+      str = "<env:Header>"
+
+      if @service_namespace
+        str += "<s:RequestHeader env:mustUnderstand=\"0\">"
+      else
+        str += "<RequestHeader env:mustUnderstand=\"0\">"
+      end
+
+      str +=<<-EOFS
+          <authToken>#{auth_token}</authToken>
+          <userAgent>#{@credentials.useragent}</userAgent>
+          <developerToken>#{@credentials.developer_token}</developerToken>
+      EOFS
+
+      if @credentials.client_email
+        str += "<clientEmail>#{@credentials.client_email}</clientEmail>"
+      end
+      
+      if @service_namespace
+        str += "</s:RequestHeader>"
+      else
+        str += "</RequestHeader>"
+      end
+      str += "</env:Header>"
+      str
+    end
+
+    def build_soap_message
+      soap_message = '<?xml version="1.0" encoding="utf-8" ?>'
+      soap_message +=<<-EOFS
+      <env:Envelope
+         xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+         xmlns="#{@header_namespace}"
+      EOFS
+
+      if @service_namespace
+        soap_message += " xmlns:s=\"#{@service_namespace}\""
+      end
+      soap_message += ">"
+
+      soap_message += build_soap_header
+      soap_message += "<env:Body>"
+      soap_message += @soap_body_content
+      soap_message += <<-EOFS
+      </env:Body>
+    </env:Envelope>
+      EOFS
+      soap_message
+    end
+
+  end
+
+end

data/lib/sem4r/soap_attributes.rb

@@ -0,0 +1,141 @@
+# -------------------------------------------------------------------
+# 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 SoapAttributes
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def enum(set, values)
+        tmp = values.map do |v|
+          if const_defined?(v.to_sym)
+            const_get(v.to_sym)
+          else
+            const_set(v.to_sym, v.to_s)
+          end
+        end
+        const_set( set.to_sym, tmp )
+      end
+
+      def g_reader(name)
+        attr_reader name
+      end
+
+      #
+      # constraints
+      #   values_in
+      #
+      # TODO: g_accessor prende in input anche elements ed estrae automaticamente l'elemento che interessa
+      #       cioe' invece di scrivere headline       el.elements["headline"].text dovrebbe bastare scrivere
+      #       headline el
+      def g_accessor(name, constraints = {})
+        name = name.to_s
+
+        # vales_in
+        enum = nil
+        if constraints.key?(:values_in)
+          enum = const_get(constraints[:values_in])
+        end
+
+        # if_type
+        if_type = nil
+        if constraints.key?(:if_type)
+          if_type = constraints[:if_type]
+          other_instance_var = "type"
+        end
+
+        # default_value
+        default_value = nil
+        if constraints.key?(:default)
+          default_value = constraints[:default]
+        end
+
+        define_method "#{name}=" do |value|
+          if enum and !enum.include?(value)
+            raise "Value '#{value}' not permitted "
+          end
+          if if_type
+            type = instance_variable_get "@#{other_instance_var}"
+            raise "type must be '#{if_type}' instead of '#{type}'" unless if_type == type
+          end
+          instance_variable_set "@#{name}", value
+        end
+
+        define_method "#{name}" do |*values|  # |value = nil| is incorrect in ruby 1.8
+          raise ArgumentError, "wrong number of arguments (#{values.size} for 0)" if values.length > 1
+          value = values.first
+          if value
+            self.__send__("#{name}=", value)
+          elsif instance_variable_defined? "@#{name}"
+            instance_variable_get "@#{name}"
+          else
+            default_value
+          end
+        end
+      end
+      
+      def g_set_accessor(column, constraints = {})
+        column  = column.to_s
+        columns = "#{column}s"
+
+        # values_in
+        enum = nil
+        if constraints.key?(:values_in)
+          enum = const_get(constraints[:values_in])
+        end
+
+        define_method "#{column}=" do |value|
+          if enum and !enum.include?(value)
+            raise "Value not permitted #{value}"
+          end
+          instance_eval <<-EOFS
+            @#{columns} ||= []
+            @#{columns} << value unless @#{columns}.include?(value)
+          EOFS
+        end
+
+        alias_method column, "#{column}="
+
+        define_method "#{columns}" do |*values|
+          if values and !values.empty?
+            instance_eval "@#{columns} ||= []"
+            values.each do |value|
+              instance_eval "@#{column}(value)"
+            end
+          else
+            instance_eval "@#{columns} ||= []"
+            instance_variable_get "@#{columns}"
+          end
+        end
+
+      end
+      
+    end
+
+  end
+end
+

data/lib/sem4r/targeting_idea/targeting_idea.rb

@@ -0,0 +1,158 @@
+# -------------------------------------------------------------------------
+# 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 TargetingIdea
+    include SoapAttributes
+
+    enum :AttributeTypes, [
+      :AdFormatSpecListAttribute,
+      :BooleanAttribute,
+      :DoubleAttribute,
+      :IdeaTypeAttribute,
+      :InStreamAdInfoAttribute,
+      :IntegerAttribute,
+      :IntegerSetAttribute,
+      :LongAttribute,
+      :MonthlySearchVolumeAttribute,
+      :PlacementTypeAttribute,
+      :StringAttribute,
+      :WebpageDescriptorAttribute,
+      :KeywordAttribute,
+      :MoneyAttribute,
+      :PlacementAttribute,
+      :LongRangeAttribute,
+      :MonthlySearchVolumeAttribute]
+
+    attr_reader :attributes
+    
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.from_element(el)
+      els = REXML::XPath.match( el, "data")
+      @attributes = els.map do |el|
+        el1 = el.elements["value"]
+        xml_type =       el1.elements["Attribute.Type"].text.strip
+        case xml_type
+        when IdeaTypeAttribute
+          TIdeaTypeAttribute.from_element(el1)
+        when KeywordAttribute
+          TKeywordAttribute.from_element(el1)
+        when MonthlySearchVolumeAttribute
+          TMonthlySearchVolumeAttribute.from_element(el1)
+        end
+      end
+    end
+
+    def to_s
+      @attributes.collect { |attr| attr.to_s }.join("\n")
+    end
+
+  end
+
+  class TKeywordAttribute
+    include SoapAttributes
+
+    g_accessor :text
+    g_accessor :match_type
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.from_element( el )
+      el1 = el.elements["value"]
+      new do
+        text       el1.elements["text"].text
+        match_type el1.elements["matchType"].text
+      end
+    end
+
+    def to_s
+      "Keyword '#{text}' '#{match_type}'"
+    end
+  end
+  
+  class TMonthlySearchVolumeAttribute
+    include SoapAttributes
+
+    g_accessor :text
+    g_accessor :values
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.from_element( el )
+      historical_values = []
+      el.elements.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_values << historical_value
+      end
+      new do
+        values historical_values
+      end
+    end
+
+    def to_s
+      "Values: #{values.inspect}"
+    end
+  end
+
+  class TIdeaTypeAttribute
+    include SoapAttributes
+
+    g_accessor :value
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.from_element( el )
+      new do
+        value       el.elements["value"].text
+      end
+    end
+
+    def to_s
+      "Idea '#{value}'"
+    end
+  end
+
+end