sem4r 0.1.2 → 0.1.3

data/lib/sem4r/bulk_mutate_job/bulk_mutate_job_selector.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,12 +20,22 @@
 # 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 BulkMutateJobSelector
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
+
+    enum :JobStatuses, [
+        :COMPLETED,
+        :PROCESSING,
+        :FAILED,
+        :PENDING]
+
+    g_set_accessor :status, {:values_in => :JobStatuses}
+    g_set_accessor :jobId
+    g_accessor :stats
+    g_accessor :history
 
     def initialize(&block)
       if block_given?
@@ -32,25 +43,23 @@ module Sem4r
       end
     end
 
-    enum :JobStatuses, [
-      :COMPLETED,
-      :PROCESSING,
-      :FAILED,
-      :PENDING]
-
-    def to_xml
-      <<-EOFS
-        <selector>
-          <customerJobKeys></customerJobKeys>
-          <jobStatuses>COMPLETED</jobStatuses>
-          <jobStatuses>PROCESSING</jobStatuses>
-          <jobStatuses>FAILED</jobStatuses>
-          <jobStatuses>PENDING</jobStatuses>
-        </selector>
-      EOFS
-    end
+    def to_xml(tag = "selector")
+      builder = Builder::XmlMarkup.new
+      builder.tag!(tag) do |t|
 
-    ##########################################################################
+        t.includeHistory history unless history.nil?
+        t.includeStats stats unless stats.nil?
+
+        unless jobIds.empty?
+          jobIds.each { |i| t.jobIds i }
+        end
+
+
+        unless statuss.empty?
+          statuss.each { |f| t.jobStatuses f }
+        end
+      end
+    end
 
   end
 end

data/lib/sem4r/bulk_mutate_job/bulk_mutate_job_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,38 +20,36 @@
 # 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 BulkMutateJobService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class BulkMutateJobService < Sem4rSoap::SoapServiceV2010 
 
     def initialize(connector)
       @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/job/v201008/BulkMutateJobService"
       @production_service_url = "https://adwords.google.com/api/adwords/job/v201008/BulkMutateJobService"
+      init(@header_namespace, @service_namespace)      
     end
 
-    soap_call_v2010 :all,    :mutate => false
-    soap_call_v2010 :mutate
+    soap_call :get,    :mutate => false
+    soap_call :mutate
 
     private
 
-    def _all(selector)
-      "<get xmlns=\"#{@service_namespace}\">" + selector.to_xml +  '</get>';
+    def _get(xml)
+      "<get xmlns=\"#{@service_namespace}\">#{xml}</get>";
     end
 
-    def _mutate(job_operation)
-      <<-EOFS
-      <mutate xmlns="#{@service_namespace}">
-        #{job_operation.to_xml('operation')}
-      </mutate>
-      EOFS
+    def _mutate(xml)
+      "<mutate xmlns=\"#{@service_namespace}\">#{xml}</mutate>"
     end
 
   end

data/lib/sem4r/bulk_mutate_job/job_operations.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/campaign/campaign.rb

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

data/lib/sem4r/campaign/campaign_account_extension.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -70,7 +71,7 @@ module Sem4r
     private
 
     def _campaigns
-      soap_message = service.campaign.all(credentials)
+      soap_message = service.campaign.all( credentials )
       add_counters( soap_message.counters )
       rval = soap_message.response.at_xpath("//getResponse/rval")
       els = rval.xpath("entries")

data/lib/sem4r/campaign/campaign_service.rb

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

data/lib/sem4r/credentials.rb

@@ -75,12 +75,18 @@ module Sem4r
 
     def authentication_token
       return @authentication_token if @authentication_token
-      if @credentials
-        return @authentication_token = @credentials.authentication_token
-      end
+      return @authentication_token = @credentials.authentication_token if @credentials
       raise "no connector in credentials! use credentials.connector="  unless @connector
-      @authentication_token = @connector.authentication_token(@email, @password)
-      @authentication_token
+
+      url = "https://www.google.com/accounts/ClientLogin"
+      query = "accountType=GOOGLE&Email=#{URI.escape(email)}&Passwd=#{URI.escape(password)}&service=adwords"
+      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
+      response = @connector.post(url, query, headers )
+      status = response.code.to_i
+      if status != 200
+        raise Sem4rError, "authentication failed status is #{status}"
+      end
+      @authentication_token = response.body[/Auth=(.*)/, 1]
     end
 
   end

data/lib/sem4r/geo_location/address.rb

@@ -0,0 +1,56 @@
+# -*- 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
+  class Address
+    include Sem4rSoap::SoapAttributes
+
+    g_accessor :address, :xpath => 'streetAddress'
+    g_accessor :address2, :xpath => 'streetAddress2'
+    g_accessor :city, :xpath => 'cityName'
+    g_accessor :province_code, :xpath => 'provinceCode'
+    g_accessor :province, :xpath => 'provinceName'
+    g_accessor :postal_code, :xpath => 'postalCode'
+    g_accessor :country, :xpath => 'countryCode'
+
+    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_xml(tag = "addresses")
+      _to_xml(tag)
+    end
+
+    def to_s
+      _to_s
+    end
+
+  end
+end

data/lib/sem4r/geo_location/geo_location_account_extension.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -19,18 +20,38 @@
 # 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 GeoLocationAccountExtension
-    ############################################################################
-    # Geo Location
 
-    def geo_location
-      soap_message = service.geo_location.get(@credentials, "")
-      add_counters( soap_message.counters )
+    # Call geolocation adwords service
+    #
+    # @example
+    #   account.geo_location("Roma", "IT")
+    #   account.geo_location("Via Conca del Naviglio", "Milano", "IT")
+    #   account.geo_location( geoLocationSelector )
+    #
+    def geo_location(c1 = nil, c2 = nil, c3 = nil)
+      if c1.class != GeoLocationSelector
+        selector = GeoLocationSelector.new
+        selector.address do
+          if c3
+            address c1
+            city c2
+            country c3
+          else
+            city c1
+            country c2
+          end
+        end
+      else
+        selector = c1
+      end
+
+      soap_message = service.geo_location.get(credentials, selector.to_xml)
+      add_counters(soap_message.counters)
       # cost = REXML::XPath.first( soap_message.response, "//getResponse/rval/cost")
       # cost.text.to_i
     end

data/lib/sem4r/geo_location/geo_location_selector.rb

@@ -0,0 +1,57 @@
+# -*- 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
+
+  class GeoLocationSelector
+    include Sem4rSoap::SoapAttributes
+
+    attr_reader :addresses
+    
+    def initialize(&block)
+      @addresses = []
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def address(address = nil, &block)
+      if address.nil? and block_given?
+        @addresses << Address.new(&block)
+      else
+        @addresses << address
+      end
+    end
+
+    def to_xml
+      xml = "<s:selector>"
+      @addresses.each do |address|
+        xml += address.to_xml("addresses")
+      end
+      xml += "</s:selector>"
+      xml
+    end
+
+  end
+end

data/lib/sem4r/geo_location/geo_location_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -22,8 +23,11 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class GeoLocationService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class GeoLocationService < Sem4rSoap::SoapServiceV2010 
 
     def initialize(connector)
       @connector = connector
@@ -33,26 +37,15 @@ module Sem4r
 
       @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/cm/v201008/GeoLocationService"
       @production_service_url = "https://adwords.google.com/api/adwords/cm/v201008/GeoLocationService"
+      init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v2010 :get
-
-    ################
+    soap_call :get
 
     private
 
     def _get(xml)
-      <<-EOFS
-      <s:get>
-        <s:selector>
-          <addresses>
-            <streetAddress>Via Nazionale,10</streetAddress>
-            <cityName>Rome</cityName>
-            <countryCode>IT</countryCode>
-          </addresses>
-        </s:selector>
-      </s:get>
-      EOFS
+      "<s:get>#{xml}</s:get>"
     end
 
   end

data/lib/sem4r/info/info_account_extension.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -27,13 +28,13 @@ module Sem4r
   module AccountInfoExtension
 
     def year_unit_cost(usage_type)
-      now = Time.new
+      now = Time.new - 60 * 60 * 24  # - 1 day time in which timezone?
       selector = InfoSelector.new do
         usage_type    usage_type
         min           now.strftime("%Y0101") # first January
         max           now.strftime("%Y%m%d")
       end
-      soap_message = service.info.get(@credentials, selector.to_xml)
+      soap_message = service.info.get(credentials, selector.to_xml)
       add_counters( soap_message.counters )
       # cost = REXML::XPath.first( soap_message.response, "//getResponse/rval/cost")
       cost = soap_message.response.at_xpath("//getResponse/rval/cost")

data/lib/sem4r/info/info_selector.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -72,7 +73,7 @@ module Sem4r
   #   operator parameters.
 
   class InfoSelector
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
 
     enum :UsageTypes, [
       :FREE_USAGE_API_UNITS_PER_MONTH,

data/lib/sem4r/info/info_service.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 #
@@ -22,8 +23,11 @@
 # -------------------------------------------------------------------
 
 module Sem4r
-  class InfoService
-    include SoapCall
+
+  #
+  # @private
+  #
+  class InfoService < Sem4rSoap::SoapServiceV2010
 
     def initialize(connector)
       @connector = connector
@@ -32,9 +36,12 @@ module Sem4r
 
       @production_service_url = "https://adwords.google.com/api/adwords/info/v201008/InfoService"
       @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/info/v201008/InfoService"
+      init(@header_namespace, @service_namespace)
     end
 
-    soap_call_v2010 :get, :mutate => false
+    soap_call :get, :mutate => false
+
+    private
 
     def _unit_cost( usage_type )
       <<-EOFS

data/lib/sem4r/operation.rb

@@ -25,13 +25,30 @@
 
 module Sem4r
 
+  #
+  # Contains an operand. Operand can be everything that respond_to :to_xml and :xml
+  #
   class Operation
-    include SoapAttributes
+    include Sem4rSoap::SoapAttributes
+
+    class << self
+      def add(operand)
+        self.new.add(operand)
+      end
+
+      def remove(operand)
+        self.new.remove(operand)
+      end
+
+      def set(operand)
+        self.new.set(operand)
+      end
+    end
 
     enum :Operations, [
-      :ADD,
-      :REMOVE,
-      :SET]
+        :ADD,
+        :REMOVE,
+        :SET]
 
     attr_reader :operation_type
     g_accessor :operator
@@ -54,27 +71,29 @@ module Sem4r
       self
     end
 
-    def to_xml(tag)
-      if @operand == nil
-        raise Sem4rError, "Missing Operand"
-      end
+    def _xml(t)
+      raise Sem4rError, "Missing Operand" unless @operand
+      t.operator operator
+      @operand.xml(t, "operand")
+    end
 
-      xml = ""
+    def xml(t, tag = nil)
+      raise Sem4rError, "Missing Operand" unless @operand
       if tag
-        xml += "<#{tag} xsi:type='#{operation_type}' #{if @namespace then @namespace else '' end}>"
-        # xsi:type="n1:ReportDefinitionOperation" xmlns:n1="https://adwords.google.com/api/adwords/cm/v201008"
+        attrs = {}
+        attrs = {'xsi:type'=> operation_type} if operation_type
+        attrs.merge! @attrs if @attrs
+        t.__send__(tag, attrs) { |t| _xml(t) }
+      else
+        _xml(t)
       end
-      xml +=<<-EOS
-        <operator>#{operator}</operator>
-        #{@operand.to_xml('operand')}
-      EOS
+    end
 
-      if tag
-        xml += "</#{tag}>"
-      end
-      xml
+    def to_xml(tag = "operations")
+      raise Sem4rError, "Missing Operand" unless @operand
+      xml(Builder::XmlMarkup.new, tag)
     end
 
   end
 
-end
+end #module Sem4r

data/lib/sem4r/report_definition/report_definition.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
@@ -94,19 +94,23 @@ module Sem4r
       "#{@id}: '#{@name}'"
     end
 
-    def to_xml(tag)
-      builder = Builder::XmlMarkup.new
-      builder.tag!(tag) do |t|
-
-        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
+    #
+    # @private
+    #
+    def _xml(t)
+      t.id             @id         if @id
 
+      if !fields.empty? or ( !!from and !!to )
         #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}
+
+#            t.predicates do |t|
+#              t.field    "AdGroupId"
+#              t.operator "EQUALS"
+#              t.values   1
+#            end
+
           if from and to
             t.dateRange do |t|
               t.min from
@@ -114,10 +118,32 @@ module Sem4r
             end
           end
         end
+      end
+
+      t.reportName     @name       if @name
+      t.reportType     @type       if @type
+      t.dateRangeType  @date_range if @date_range
+      t.downloadFormat @format     if @format
+    end
+
 
+    #
+    # Marshall to xml using a Builder::Markup
+    # @param [Builder::Markup]
+    #
+    def xml(t, tag = nil)
+      if tag
+        t.__send__(tag) { |t| _xml(t) }
+      else
+        _xml(t)
       end
     end
 
+    def to_xml(tag = "operand")
+      xml(Builder::XmlMarkup.new, tag)
+    end
+
+
     ###########################################################################
 
     def self.from_element(account, el)
@@ -149,15 +175,7 @@ module Sem4r
     end
 
     def delete
-      soap_message = service.campaign.delete(credentials, @id)
-      add_counters( soap_message.counters )
-      @id = -1 # logical delete
-    end
-
-    ###########################################################################
-
-    def empty?
-      _ad_groups.empty?
+      @account.report_definition_delete(self)
     end
 
   end