sem4r 0.1.1

data/lib/sem4r/ad_group_criterion/ad_group_criterion_operations.rb

@@ -0,0 +1,35 @@
+# -------------------------------------------------------------------------
+# 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 AdGroupCriterionOperation < Operation
+    def initialize(&block)
+      @operation_type = "AdGroupCriterionOperation"
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+  end
+end
+

data/lib/sem4r/ad_group_criterion/ad_group_criterion_service.rb

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------
+# 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 AdGroupCriterionService
+    include SoapCall
+
+    def initialize(connector)
+      @connector = connector
+      @service_namespace = "https://adwords.google.com/api/adwords/cm/v201003"
+      @header_namespace = @service_namespace
+
+      @sandbox_service_url = "https://adwords-sandbox.google.com/api/adwords/cm/v201003/AdGroupCriterionService"
+    end
+
+    soap_call_v2009 :all,   :mutate => false
+    soap_call_v2009 :mutate
+
+    private
+    
+    def _all(ad_group_id)
+      <<-EOFS
+      <get xmlns="#{@service_namespace}">
+        <selector>
+          <idFilters>
+            <adGroupId>#{ad_group_id}</adGroupId>
+          </idFilters>
+        </selector>
+      </get>
+      EOFS
+    end
+
+    def _mutate(xml)
+      "<mutate xmlns=\"#{@service_namespace}\">#{xml}</mutate>"
+    end
+
+  end
+end

data/lib/sem4r/ad_group_criterion/criterion.rb

@@ -0,0 +1,67 @@
+# -------------------------------------------------------------------
+# 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 Criterion < Base
+
+    enum :Types,             [:Keyword, :Placement]
+    enum :KeywordMatches,    [:EXACT, :BROAD, :PHRASE]
+
+    attr_reader   :ad_group
+    attr_accessor :type
+
+    def initialize( ad_group )
+      super( ad_group.adwords, ad_group.credentials )
+      @ad_group = ad_group
+    end
+
+    def saved?
+      !@id.nil?
+    end
+
+    def id
+      @id
+    end
+
+    def self.from_element( ad_group, el )
+      xml_type =       el.elements["Criterion.Type"].text.strip
+      #      klass = Module::const_get(type)
+      #      klass.from_element(ad_group, el)
+      case xml_type
+      when Keyword
+        CriterionKeyword.from_element(ad_group, el)
+      when Placement
+        CriterionPlacement.from_element(ad_group, el)
+      end
+    end
+
+    ############################################################################
+    # ad params management
+
+    def ad_param(index = nil, text = nil, &block)
+      ad_group.ad_param(self, index, text, &block)
+    end
+
+  end
+end

data/lib/sem4r/ad_group_criterion/criterion_keyword.rb

@@ -0,0 +1,80 @@
+# -------------------------------------------------------------------
+# 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 CriterionKeyword < Criterion
+
+    enum :KeywordMatches,    [:EXACT, :BROAD, :PHRASE]
+
+    g_accessor :text
+    g_accessor :match
+
+    def initialize(ad_group, text = nil, match = "BROAD", &block)
+      super( ad_group )
+      self.type = Keyword
+      self.text = text   unless text.nil?     # TODO: text == nil raise error
+      self.match = match unless match.nil?
+      if block_given?
+        @inside_initialize = true
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+      @inside_initialize = false
+    end
+
+    def inside_initialize?
+      @inside_initialize
+    end
+
+    def self.create(ad_group, &block)
+      new(ad_group, &block).save
+    end
+
+    def self.from_element( ad_group, el )
+      new(ad_group) do
+        @id      = el.elements["id"].text.strip.to_i
+        text       el.elements["text"].text.strip
+        match      el.elements["matchType"].text.strip
+      end
+    end
+
+    def to_s
+      "#{saved? ? id : 'unsaved' } #{type} #{text} #{match}"
+    end
+
+    def xml(t)
+      t.criterion("xsi:type" => "#{type}") { |t| 
+        t.text        text
+        t.matchType   match
+      }
+    end
+
+    def to_xml(tag)
+      builder = Builder::XmlMarkup.new
+      builder.tag!(tag, "xsi:type" => "#{type}") do |t|
+        t.text        text
+        t.matchType   match
+      end
+    end
+
+  end
+end

data/lib/sem4r/ad_group_criterion/criterion_placement.rb

@@ -0,0 +1,66 @@
+# -------------------------------------------------------------------
+# 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 CriterionPlacement < Criterion
+
+    g_accessor :url
+
+    def initialize(ad_group, url = nil, &block)
+      super( ad_group )
+      self.type = Placement
+      self.url = url unless url.nil?
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def self.create(ad_group, &block)
+      new(ad_group, &block).save
+    end
+
+    def self.from_element( ad_group, el )
+      new(ad_group) do
+        @id      = el.elements["id"].text.strip.to_i
+        url        el.elements["url"].text.strip
+      end
+    end
+
+    def to_s
+      "#{saved? ? id : 'unsaved'} #{type} #{url}"
+    end
+
+    def xml(t)
+      t.criterion("xsi:type" => "#{type}") do |ad|
+        ad.url  url
+      end
+    end
+
+    def to_xml(tag)
+      builder = Builder::XmlMarkup.new
+      t = builder.tag!(tag, "xsi:type" => "CriterionKeyword")
+      xml(t)
+    end
+
+  end
+end

data/lib/sem4r/ad_param/ad_param.rb

@@ -0,0 +1,96 @@
+# -------------------------------------------------------------------------
+# 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 AdParam < Base
+
+    attr_reader :ad_group
+    attr_reader :criterion
+
+    g_accessor :index
+    g_accessor :text
+
+    def initialize(ad_group, criterion, index = nil, text = nil, &block)
+      super( ad_group.adwords, ad_group.credentials )
+      @saved = false
+      @ad_group   = ad_group
+      @criterion  = criterion
+      self.index = index unless index.nil?
+      self.text  = text  unless text.nil?
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+        save unless criterion.inside_initialize? or ad_group.inside_initialize?
+      end
+    end
+
+    def saved?
+      @saved
+    end
+
+    def to_s
+      "#{@id} #{@index} #{@text}"
+    end
+
+    # adGroupId  	   Id of ad_group This field is required and should not be null.
+    # criterionId 	 The id of the Keyword criterion that this ad parameter applies to.
+    #                The keyword must be associated with the same ad_group as this AdParam.
+    #                This field is required and should not be null.
+    # insertionText  Numeric value or currency value (eg. 15, $99.99) to insert into the ad text
+    #                This field is required and should not be null when it is contained
+    #                within Operators : SET. The length of this string should be
+    #                between 1 and 25, inclusive.
+    # paramIndex
+    def to_xml(tag)
+      builder = Builder::XmlMarkup.new
+      builder.tag!(tag) do |t|
+        t.adGroupId     @ad_group.id
+        t.criterionId   @criterion.id
+        t.insertionText @text
+        t.paramIndex    @index
+      end
+    end
+
+    def self.from_element(ad_group, el)
+      criterion_id = el.elements["criterionId"].text.strip.to_i
+      criterion = ad_group.find_criterion(criterion_id)
+      new(ad_group, criterion) do
+        # ad_param don't have id so use @saved to indicate if readed from xml
+        @saved = true
+        index         el.elements["paramIndex"].text.strip.to_i
+        text          el.elements["insertionText"].text.strip
+      end
+    end
+
+    def save
+      return if @saved
+      o = AdParamOperation.new.set( self )
+      soap_message = service.ad_param.mutate(credentials, o.to_xml("operations") )
+      add_counters( soap_message.counters )
+      # ignore response ad_param doesn't have id
+      @saved = true
+      self
+    end
+
+  end
+end

data/lib/sem4r/ad_param/ad_param_operation.rb

@@ -0,0 +1,34 @@
+# -------------------------------------------------------------------------
+# 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 AdParamOperation < Operation
+    def initialize(&block)
+      @operation_type = "AdParamOperation"
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+  end
+end

data/lib/sem4r/ad_param/ad_param_service.rb

@@ -0,0 +1,59 @@
+# -------------------------------------------------------------------------
+# 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 AdParamService
+    include SoapCall
+
+    def initialize(connector)
+      @connector = connector
+
+      @service_namespace = "https://adwords.google.com/api/adwords/cm/v201003"
+      @header_namespace = @service_namespace
+
+      @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/cm/v201003/AdParamService"
+      @production_service_url = "https://adwords.google.com/api/adwords/cm/v201003/AdParamService"
+    end
+
+    soap_call_v2009 :all, :mutate => false
+    soap_call_v2009 :mutate
+
+    private
+
+    def _all(ad_group_id)
+      <<-EOFS
+      <get xmlns="#{@service_namespace}">
+        <selector>
+          <adGroupIds>#{ad_group_id}</adGroupIds>
+        </selector>
+      </get>
+      EOFS
+    end
+
+    def _mutate(xml)
+      "<mutate xmlns=\"#{@service_namespace}\">#{xml}</mutate>"
+    end
+
+  end
+end