sem4r 0.1.1

data/lib/sem4r/campaign/campaign.rb

@@ -0,0 +1,193 @@
+# -------------------------------------------------------------------
+# 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 Campaign < Base
+
+    enum :Statuses, [
+      :ACTIVE,
+      :PAUSED,
+      :DELETED
+    ]
+
+    enum :ServingStatues, [
+      :SERVING,
+      :NONE,
+      :ENDED,
+      :PENDING,
+      :SUSPENDED
+    ]
+    
+    attr_reader :id
+    attr_reader :account
+
+    g_accessor :name
+    g_accessor :status, {:default => "PAUSED"}
+    g_accessor :serving_status
+    g_accessor :start_date
+    g_accessor :end_date
+
+    def initialize(account, name = nil, &block)
+      super( account.adwords, account.credentials )
+      @account = account
+      @ad_groups = nil
+      self.name = name
+      if block_given?
+        @inside_initialize = true
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+        save
+      end
+      @inside_initialize = false
+    end
+
+    def inside_initialize?
+      @inside_initialize
+    end
+
+    def to_s
+      "#{@id} '#{@name}' (#{@status})"
+    end
+
+    def to_xml
+      <<-EOS
+        <name>#{name}</name>
+        <status>#{status}</status>
+
+        <budget>
+          <period>DAILY</period>
+          <amount xsi:type="Money">
+            <microAmount>50000000</microAmount>
+          </amount>
+          <deliveryMethod>STANDARD</deliveryMethod>
+        </budget>
+
+        <biddingStrategy xsi:type="#{bidding_strategy}"></biddingStrategy>
+
+      EOS
+    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']
+      end
+    end
+
+    def self.create(account, &block)
+      new(account, &block).save
+    end
+
+    def save
+      unless @id
+        soap_message = service.campaign.create(credentials, to_xml)
+        add_counters( soap_message.counters )
+        rval = REXML::XPath.first( soap_message.response, "//mutateResponse/rval")
+        id = REXML::XPath.match( rval, "value/id" ).first
+        @id = id.text.strip.to_i
+      end
+      self
+    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?
+    end
+
+    ###########################################################################
+    # bidding_strategy
+
+    # ManualCPC, ManualCPM
+    def bidding_strategy(strategy = nil)
+      @bidding_strategy = strategy if strategy
+      @bidding_strategy ||= "ManualCPC"
+      @bidding_strategy
+    end
+
+    ###########################################################################
+    # ad_group management
+
+    def ad_group(name = nil, &block)
+      save
+      ad_group = AdGroup.new(self, name, &block)
+      ad_group.save
+      @ad_groups ||= []
+      @ad_groups.push(ad_group)
+      ad_group
+    end
+
+    def ad_groups(refresh = false, opts = {})
+      if refresh.respond_to?(:keys)
+        opts = refresh
+        refresh = false
+      end
+      _ad_groups unless @ad_groups and !refresh
+      # statuses = [:ACTIVE, :PAUSED]
+      # @ad_groups.select do |ad_group|
+      #   statuses.include?(ad_group.status)
+      # end
+      @ad_groups
+    end
+
+    def p_ad_groups(refresh = false, opts = {})
+      if refresh.respond_to?(:keys)
+        opts = refresh
+        refresh = false
+      end
+      cs = ad_groups(refresh, opts)
+      puts "#{cs.length} ad_groups"
+      cs.each do |ad_group|
+        puts ad_group.to_s
+      end
+      self
+    end
+
+    private
+
+    def _ad_groups
+      soap_message = service.ad_group.all(credentials, @id)
+      add_counters( soap_message.counters )
+      rval = REXML::XPath.first( soap_message.response, "//getResponse/rval")
+      els = REXML::XPath.match( rval, "entries")
+      @ad_groups = els.map do |el|
+        AdGroup.from_element(self, el)
+      end
+    end
+
+    ###########################################################################
+
+  end
+end

data/lib/sem4r/campaign/campaign_service.rb

@@ -0,0 +1,91 @@
+# -------------------------------------------------------------------
+# 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 CampaignService
+    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/CampaignService"
+    end
+
+    soap_call_v2009 :all,   :mutate => false
+    soap_call_v2009 :create
+    soap_call_v2009 :delete
+
+    private
+
+    def _all(statuses = [Campaign::ACTIVE, Campaign::PAUSED])
+      str = <<-EOFS
+      <get xmlns="#{@service_namespace}">
+        <selector>
+      EOFS
+      statuses.each do |s|
+        str += "<campaignStatuses>#{s}</campaignStatuses>"
+      end
+      str += <<-EOFS
+          <statsSelector>
+            <dateRange>
+              <min>20090101</min>
+              <max>20091231</max>
+            </dateRange>
+          </statsSelector>
+        </selector>
+      </get>
+      EOFS
+    end
+
+    def _create(xml)
+      <<-EOFS
+      <mutate xmlns="#{@service_namespace}">
+        <operations xsi:type="CampaignOperation">
+          <operator>ADD</operator>
+          <operand>
+            #{xml}
+          </operand>
+        </operations>
+      </mutate>
+      EOFS
+    end
+
+    def _delete(id)
+      <<-EOFS
+      <mutate xmlns="#{@service_namespace}">
+        <operations xsi:type="CampaignOperation">
+          <operator>SET</operator>
+          <operand>
+            <id>#{id}</id>
+            <status>DELETED</status>
+          </operand>
+        </operations>
+      </mutate>
+      EOFS
+    end
+
+  end
+end

data/lib/sem4r/campaign_criterion/campaign_criterion_service.rb

@@ -0,0 +1,30 @@
+# -------------------------------------------------------------------
+# 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 CampaignCriterionService
+    def initialize
+    
+    end
+  end
+end

data/lib/sem4r/campaign_target/campaign_target_service.rb

@@ -0,0 +1,30 @@
+## -------------------------------------------------------------------
+## 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 CampaignTargetService
+    def initialize
+    
+    end
+  end
+end

data/lib/sem4r/cli/cli_command.rb

@@ -0,0 +1,101 @@
+# -------------------------------------------------------------------------
+# 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 CliCommand
+
+    class << self
+
+      def inherited(base)
+        @command_list ||= []
+        @command_list << base
+      end
+
+      def commands
+        return @commands if @commands
+        @commands = {}
+        @command_list.each { |cmd| @commands[cmd.command] = cmd }
+        @commands
+      end
+
+      def split_args(argv)
+        idx = argv.find_index { |e| commands.key?(e) }
+        if idx
+          common_args  = argv[0,idx]
+          command      = argv[idx]
+          command_args = argv[idx+1..-1]
+          return [common_args, command, command_args]
+        else
+          return [argv, nil, nil]
+        end
+      end
+
+      def define_command(command_name, description_str, &block)
+
+        unless block_given?
+          raise "define_command: missing block"
+        end
+
+        cls = Class.new(CliCommand) do
+          def initialize(common_args)
+            @common_args = common_args
+          end
+
+          def opt_parser(options)
+            opt_parser = OptionParser.new
+            opt_parser.banner= "#{self.class.description}"
+            opt_parser.on("-h", "--help", "show this message") do
+              puts opt_parser
+              options.exit = true
+            end
+          end
+
+          define_method("parse_and_run") do |argv|
+            options = OpenStruct.new
+            opt_parser(options).parse( argv )
+            return false if options.exit
+            account = @common_args.account
+            unless account
+              puts "select an account!"
+              false
+            else
+              return block.call(account)
+            end
+          end
+        end
+
+        s = class << cls; self; end
+        s.class_eval do
+          define_method("command") { command_name }
+          define_method("description") { description_str }
+        end
+        cls
+      end
+
+    end
+
+  end
+
+end

data/lib/sem4r/cli/cli_commands.rb

@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------
+# 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
+
+  CliListClient = CliCommand.define_command("clients", "list clients account") do |account|
+    puts account.adwords.to_s
+    puts account.to_s    
+    account.p_client_accounts
+    account.adwords.p_counters
+    true
+  end
+  
+  CliListReport = CliCommand.define_command("reports", "list reports") do |account|
+    report(account.reports, :id, :name, :status)
+    account.adwords.p_counters
+    true
+  end
+
+  CliInfo = CliCommand.define_command("info", "account info") do |account|
+    account.p_info    
+    items = (Account::UsageTypes - [Account::METHOD_COST]).map do |usage_type|
+      n = account.year_unit_cost(usage_type)
+      # puts "#{usage_type} -> #{n}"
+      OpenStruct.new(:usage_type => usage_type, :n => n)
+    end
+    report(items, :usage_type, :n)
+    account.adwords.p_counters
+    true
+  end
+
+  CliCampaign = CliCommand.define_command("campaigns", "list campaigns") do |account|
+    puts "listing campaings in #{account}"
+    report( account.campaigns, :id, :name, :status )
+    account.adwords.p_counters
+    true
+  end
+
+end