sem4r 0.1.1

data/lib/sem4r/adwords.rb

@@ -0,0 +1,242 @@
+# -------------------------------------------------------------------
+# 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 Adwords
+
+    attr_reader :profile
+    
+    class << self
+      def sandbox( config = nil )
+        new( "sandbox", config )
+      end
+
+      def production( config = nil )
+        new( "production", config )
+      end
+
+      def search_config_file
+        config_filename = "sem4r.yml"
+
+        #
+        # try current directory
+        #
+        return File.expand_path(config_filename) if File.exists?( config_filename)
+
+        #
+        # try ~/.sem4r/sem4r.yml
+        #
+        # require 'etc'
+        # homedir = Etc.getpwuid.dir
+        homedir = ENV['HOME']
+        config_filepath = File.join( homedir, ".sem4r", config_filename)
+        return config_filepath if File.exists?( config_filepath )
+
+        #
+        # try <home_sem4r>/config/sem4r
+        #
+        config_filepath =  File.expand_path( File.join( File.dirname( __FILE__ ), "..", "..", "config", config_filename ) )
+        return config_filepath if File.exists?( config_filepath )
+
+        config_filepath =  File.expand_path( File.join( File.dirname( __FILE__ ), "..", "..", "config", "sem4r.example.yml" ) )
+        return config_filepath if File.exists?( config_filepath )
+
+        nil
+      end
+
+      def profiles( profile_file = nil )
+        profile_file = search_config_file unless profile_file
+        unless profile_file
+          raise Sem4rError, "config file 'sem4r' not found"
+        end
+        # puts "Loaded profiles from #{profile_file}"
+        yaml = YAML::load( File.open( profile_file ) )
+        profiles = yaml['google_adwords']
+        profiles
+      end
+    end
+
+    # new( "sandbox", {:email=>"..."} )
+    # new( {:environment=>"...", email => "..." } )
+    # new( "sandbox" )
+    # new() sandbox default
+    def initialize( profile = "sandbox", options = nil )
+      @logger = nil
+      if not options.nil?
+        # new( "sandbox", {:email=>"..."} )
+        @profile = profile.to_s      
+        options = options.stringify_keys
+        options.assert_valid_keys("environment", "email", "password", "developer_token", "mutable", "config_file")
+        f = options.delete("config_file")
+        self.config_file= f if f
+        @options = load_config(@profile)
+        @options = @options.merge(options)
+      elsif profile.respond_to?(:keys)
+        # new( {:environment=>"...", email => "..." } )
+        @options = profile.stringify_keys
+        @options.assert_valid_keys("environment", "email", "password", "developer_token", "mutable")
+        @profile = "anonymous_" + @options["environment"]
+      else
+        # new( "sandbox" )
+        @profile = profile.to_s
+        @options = load_config(@profile)
+      end
+      if ["sandbox", "production"].include?(profile)
+        if @options["environment"].nil?
+          @options["environment"] = profile
+        end
+        if @options["environment"] != profile
+          raise "you cannot use profile '#{profile}' with environment #{@options["environment"]}"
+        end
+      end
+    end
+
+    def to_s
+      "adwords profile: '#{profile}' config file: '#{config_file}'"
+    end
+
+    def config_file=(file_path)
+      config_filepath = File.expand_path(file_path)
+      if File.exists?( config_filepath)
+        @config_filepath = config_filepath
+      else
+        puts "#{config_filepath} not exists"
+      end
+      @config_filepath
+    end
+
+    # return the config file name
+    def config_file
+      return @config_filepath if @config_filepath
+      @config_file_path = Adwords.search_config_file
+      @config_file_path
+    end
+
+    def load_config(profile)
+      unless config_file
+        raise Sem4rError, "config file 'sem4r' not found"
+      end
+      # puts "Loaded profiles from #{config_file}"
+      yaml = YAML::load( File.open( config_file ) )
+      config  = yaml['google_adwords'][profile]
+      config || {}
+    end
+
+    ##########################################################################
+    # logging
+
+    def dump_soap_options( dump_options )
+      @dump_soap_options = dump_options
+      @connector.dump_soap_options( dump_options ) if @connector
+    end
+
+    def dump_soap?
+      not @dump_soap_options.nil?
+    end
+
+    def dump_soap_where
+      if @dump_soap_options[:directory]
+        "directory:#{@dump_soap_options[:directory]}"
+      else
+        "file:#{@dump_soap_options[:file]}"
+      end
+    end
+
+    def logger= logger
+      unless logger.instance_of?(Logger)
+        file = File.open( logger, "a" )
+        file.sync = true
+        logger = Logger.new(file)
+        logger.formatter = proc { |severity, datetime, progname, msg|
+          "#{datetime.strftime("%H:%M:%S")}: #{msg}\n"
+        }
+      end     
+      @logger= logger
+
+      @connector.logger= logger if @connector
+    end
+
+    def logger
+      @logger
+    end
+
+    def account
+      deferred_initialize unless @initialized
+      @account
+    end
+
+    def p_counters
+      operations    = @counters[:operations]
+      units         = @counters[:units]
+      response_time = @counters[:response_time]
+      puts "#{units} unit spent for #{operations} operations in #{response_time}ms"
+    end
+
+    ##########################################################################
+    # methods only for internal use
+
+    attr_reader :service
+
+    #
+    # TODO: credentials are necessary because you might use more then account/credentials
+    #       at the same time
+    #
+    def add_counters( credentials, counters )
+      counters.each_pair { |k,v|
+        @counters[k] ||= 0
+        @counters[k] += v
+      }
+    end
+
+    private
+
+    def deferred_initialize
+      @initialized = true
+
+      @connector = SoapConnector.new
+      @connector.dump_soap_options(@dump_soap_options) if @dump_soap_options
+      @connector.logger=(@logger) if @logger
+
+      @credentials = Credentials.new(
+        :environment         => @options["environment"],
+        :email               => @options["email"],
+        :password            => @options["password"],
+        :useragent           => "Sem4r Adwords Ruby Client Library (http://github.com/sem4r/sem4r)",
+        :developer_token     => @options["developer_token"],
+        :mutable             => @options["mutable"]
+      )
+      @credentials.connector = @connector
+
+      @service = Service.new(@connector)
+      @account  = Account.new( self, @credentials )
+      @counters = {
+        :operations => 0,
+        :response_time => 0,
+        :units => 0
+      }
+    end
+
+  end
+
+end

data/lib/sem4r/api_counters.rb

@@ -0,0 +1,7 @@
+module Sem4r
+  class ApiCounters
+    def initialize
+      
+    end
+  end
+end

data/lib/sem4r/base.rb

@@ -0,0 +1,43 @@
+# -------------------------------------------------------------------
+# 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 Base
+    include SoapAttributes
+
+    attr_reader :adwords
+    attr_reader :credentials
+    attr_reader :service
+
+    def initialize(adwords, credentials)
+      @adwords = adwords
+      @credentials = credentials
+      @service = adwords.service
+    end
+
+    def add_counters( counters )
+      @adwords.add_counters( @credentials, counters )
+    end
+  
+  end
+end

data/lib/sem4r/bulk_mutate_job/bulk_mutate_job.rb

@@ -0,0 +1,108 @@
+# -------------------------------------------------------------------------
+# 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 BulkMutateJob
+    include SoapAttributes
+
+    attr_reader :id
+    attr_accessor :campaign_id
+    attr_reader :operations
+
+    g_accessor :status
+
+    def initialize(&block)
+      @operations = []
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def add_operation(operation)
+      @operations << operation
+      self
+    end
+
+    def empty?
+      @operations.empty?
+    end
+
+    def add( something )
+      case something
+      when AdGroupTextAd
+        ad_operation = AdGroupAdOperation.new
+        ad_operation.add something
+      else
+        raise "how you suppose I must do when incounter a #{something.class}?"
+      end
+      self
+    end
+
+    def to_xml(tag)
+      xml =""
+      
+      if tag
+        xml += "<operand xsi:type='BulkMutateJob'>"
+      end
+      xml += <<-EOS
+      <request>
+        <partIndex>0</partIndex>
+        <operationStreams>
+          <scopingEntityId>
+            <type>CAMPAIGN_ID</type>
+            <value>#{campaign_id}</value>
+          </scopingEntityId>
+      EOS
+
+      if @operations
+        @operations.each do |operation|
+          xml += operation.to_xml('operations')
+        end
+      end
+   
+      xml +=<<-EOS
+        </operationStreams>
+      </request>
+      <numRequestParts>1</numRequestParts>
+      EOS
+
+      if tag
+        xml += "</operand>"
+      end
+    end
+
+    def self.from_element(el)
+      new do
+        @id          = el.elements["id"].text.strip.to_i
+        status         el.elements["status"].text
+      end
+    end
+
+    def to_s
+      "#{@id} #{status}"
+    end
+
+  end
+
+end

data/lib/sem4r/bulk_mutate_job/bulk_mutate_job_selector.rb

@@ -0,0 +1,56 @@
+# -------------------------------------------------------------------------
+# 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 BulkMutateJobSelector
+    include SoapAttributes
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      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
+
+    ##########################################################################
+
+  end
+end

data/lib/sem4r/bulk_mutate_job/bulk_mutate_job_service.rb

@@ -0,0 +1,57 @@
+# -------------------------------------------------------------------------
+# 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 BulkMutateJobService
+    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/job/v201003/BulkMutateJobService"
+      @production_service_url = "https://adwords.google.com/api/adwords/job/v201003/BulkMutateJobService"
+    end
+
+    soap_call_v2009 :all,    :mutate => false
+    soap_call_v2009 :mutate
+
+    private
+
+    def _all(selector)
+      "<get xmlns=\"#{@service_namespace}\">" + selector.to_xml +  '</get>';
+    end
+
+    def _mutate(job_operation)
+      <<-EOFS
+      <mutate xmlns="#{@service_namespace}">
+        #{job_operation.to_xml('operation')}
+      </mutate>
+      EOFS
+    end
+
+  end
+end

data/lib/sem4r/bulk_mutate_job/job_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 JobOperation < Operation
+    def initialize(&block)
+      @operation_type = "JobOperation"
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+  end
+end