sem4r 0.1.1 → 0.1.2

data/lib/sem4r/cli/commands/cli_repdef.rb

@@ -0,0 +1,109 @@
+# -*- 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 CliRepDef < CliCommand
+
+    def self.command
+      "repdef"
+    end
+
+    def self.description
+      "report definition"
+    end
+
+    def initialize(common_args)
+      @common_args = common_args
+    end
+
+    def command_opt_parser(options)
+      opt_parser = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options ] [fields|list|create]"
+      opt_parser.separator ""
+      opt_parser.separator "#{self.class.description}"
+      opt_parser.on("-h", "--help", "show this message") do
+        puts opt_parser
+        options.exit = true
+      end
+    end
+
+    def parse_and_run(argv)
+      options = OpenStruct.new
+      rest = command_opt_parser(options).parse( argv )
+      if options.exit
+        return false
+      end
+
+      if rest.empty?
+        puts "missing command"
+        return false
+      end
+
+      account = @common_args.account
+      
+      case rest[0]
+
+      when "fields"
+        account.report_fields.each do |f|
+          puts f.to_s
+        end
+
+      when "list"
+        account.p_report_definitions
+
+      when "delete"
+        report_definition_id = rest[1]
+        account.report_definition_delete(report_definition_id)
+
+      when "create"
+        rd = account.report_definition do
+          name       "Keywords performance report #1290336379254"
+          type       "KEYWORDS_PERFORMANCE_REPORT"
+          date_range "CUSTOM_DATE"
+          from       "20100101"
+          to         "20100110"
+          format     "CSV"
+
+          field "AdGroupId"
+          field "Id"
+          field "KeywordText"
+          field "KeywordMatchType"
+          field "Impressions"
+          field "Clicks"
+          field "Cost"
+        end
+        rd.save
+        puts rd.id
+        puts rd.to_s
+        account.p_report_definitions
+      else
+        puts "unknow command"
+      end
+      account.adwords.p_counters
+      true
+    end
+
+  end
+end

data/lib/sem4r/cli/commands/cli_report.rb

@@ -0,0 +1,78 @@
+# -*- 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 CliReport < CliCommand
+
+    def self.command
+      "report"
+    end
+
+    def self.description
+      "manage report"
+    end
+
+    def initialize(common_args)
+      @common_args = common_args
+    end
+
+    def command_opt_parser(options)
+      opt_parser = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options ] [fields|list|create]"
+      opt_parser.separator ""
+      opt_parser.separator "#{self.class.description}"
+      opt_parser.on("-h", "--help", "show this message") do
+        puts opt_parser
+        options.exit = true
+      end
+    end
+
+    def parse_and_run(argv)
+      options = OpenStruct.new
+      rest = command_opt_parser(options).parse( argv )
+      if options.exit
+        return false
+      end
+
+      if rest.length != 1
+        puts "missing command"
+        return false
+      end
+
+      account = @common_args.account
+
+      case rest[0]
+      when "list"
+        Sem4r::report(account.reports, :id, :name, :status)
+
+      else
+        puts "unknow command"
+      end
+      account.adwords.p_counters
+      true
+    end
+
+  end
+end

data/lib/sem4r/cli/{cli_request_report.rb → commands/cli_request_report.rb}

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

data/lib/sem4r/credentials.rb

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

data/lib/sem4r/extensions.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 module Sem4r #:nodoc:
   module CoreExtensions #:nodoc:
     module Hash #:nodoc:
@@ -47,16 +48,36 @@ module Sem4r #:nodoc:
       end
 
       #
-      # Giovanni
+      # Sem4r
       #
       def assert_check_keys(*mkeys)
         missing_keys = [mkeys].flatten - keys
         raise(ArgumentError, "Missing key(s): #{missing_keys.join(", ")}") unless missing_keys.empty?
       end
     end
+
+    # Rails' ActiveSupport
+    module String #:nodoc:
+      def underscore
+        # strtolower(preg_replace('/([a-z])([A-Z])/', '$1_$2', $class_name))
+        self.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+
+      def camel_case
+        self.gsub(/_([a-z])/) { $1.upcase }
+      end
+    end
   end
 end
 
 class Hash #:nodoc:
   include Sem4r::CoreExtensions::Hash
 end
+
+class String
+  include Sem4r::CoreExtensions::String
+end

data/lib/sem4r/geo_location/geo_location_account_extension.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
+
+  module GeoLocationAccountExtension
+    ############################################################################
+    # Geo Location
+
+    def geo_location
+      soap_message = service.geo_location.get(@credentials, "")
+      add_counters( soap_message.counters )
+      # cost = REXML::XPath.first( soap_message.response, "//getResponse/rval/cost")
+      # cost.text.to_i
+    end
+  end
+
+  class Account
+    include GeoLocationAccountExtension
+  end
+
+end

data/lib/sem4r/geo_location/geo_location_service.rb

@@ -28,14 +28,14 @@ module Sem4r
     def initialize(connector)
       @connector = connector
 
-      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201003"
+      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201008"
       @service_namespace = @header_namespace
 
-      @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/cm/v201003/GeoLocationService"
-      @production_service_url = "https://adwords.google.com/api/adwords/cm/v201003/GeoLocationService"
+      @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"
     end
 
-    soap_call_v2009 :get
+    soap_call_v2010 :get
 
     ################
 

data/lib/sem4r/info/info_account_extension.rb

@@ -0,0 +1,48 @@
+# -------------------------------------------------------------------------
+# 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 AccountInfoExtension
+
+    def year_unit_cost(usage_type)
+      now = Time.new
+      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)
+      add_counters( soap_message.counters )
+      # cost = REXML::XPath.first( soap_message.response, "//getResponse/rval/cost")
+      cost = soap_message.response.at_xpath("//getResponse/rval/cost")
+      cost.text.to_i
+    end
+  end
+
+  class Account
+    include AccountInfoExtension
+  end
+
+end

data/lib/sem4r/info/info_selector.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
+
+  ############################################################################
+  # Info Service
+
+  # FREE_USAGE_API_UNITS_PER_MONTH
+  #   Retrieves the number of  free API units that can be used by the developer
+  #   token being used to make the call for this month.
+  #   Specify only the apiUsageType parameter.
+  #
+  # TOTAL_USAGE_API_UNITS_PER_MONTH
+  #   Retrieves the total number of API units for this entire month that can
+  #   be used by the developer token being used to make this call. Includes
+  #   both free and paid API units.
+  #   Specify only the apiUsageType parameter.
+  #
+  # OPERATION_COUNT
+  #   Retrieves the number of operations recorded for the developer token
+  #   being used to make this call over the given date range.
+  #   The given dates
+  #   are inclusive; to get the operation count for a single day, supply it as
+  #   both the start and end date.
+  #   Specify the apiUsageType and dateRange parameters.
+  #
+  # UNIT_COUNT
+  #   Retrieves the number of API units recorded for the developer token being
+  #   used to make this call.
+  #     o Specify the apiUsageType and dateRange parameters to retrieve
+  #       the units recorded over the given date range.
+  #     o Specify the apiUsageType, serviceName, methodName, operator,
+  #       dateRange to retrieve the units recorded over the given date
+  #       range for a specified method.
+  #
+  # UNIT_COUNT_FOR_CLIENTS
+  #   Retrieves the number of API units recorded for a subset of clients over
+  #   the given date range for the developer token being used to make this
+  #   call.
+  #   The given dates are inclusive; to get the unit count for a single
+  #   day, supply it as both the start and end date.
+  #   Specify the apiUsageType, dateRange and clientEmails parameters.
+  #
+  # METHOD_COST
+  #   Retrieves the cost, in API units per operation, of the given method on
+  #   a specific date for the developer token being used to make this call.
+  #
+  #   Methods default to a cost of 1. Specify the apiUsageType, dateRange
+  #   (start date and end date should be the same), serviceName, methodName,
+  #   operator parameters.
+
+  class InfoSelector
+    include SoapAttributes
+
+    enum :UsageTypes, [
+      :FREE_USAGE_API_UNITS_PER_MONTH,
+      :UNIT_COUNT,
+      :TOTAL_USAGE_API_UNITS_PER_MONTH,
+      :OPERATION_COUNT,
+      :UNIT_COUNT_FOR_CLIENTS,
+      :METHOD_COST]
+
+    g_accessor :usage_type, { :values_in => :UsageTypes }
+    g_accessor :min
+    g_accessor :max
+
+    def initialize(&block)
+      if block_given?
+        block.arity < 1 ? instance_eval(&block) : block.call(self)
+      end
+    end
+
+    def to_xml
+      <<-EOFS
+        <s:selector>
+          <s:dateRange>
+            <min>#{min}</min>
+            <max>#{max}</max>
+          </s:dateRange>
+          <s:apiUsageType>#{usage_type}</s:apiUsageType>
+        </s:selector>
+      EOFS
+    end
+  end
+
+end

data/lib/sem4r/info/info_service.rb

@@ -21,35 +21,20 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 # -------------------------------------------------------------------
 
-#  <env:Body>
-#    <n3:get xmlns:n3="https://adwords.google.com/api/adwords/info/v200909">
-#      <n3:selector>
-#        <n3:dateRange xmlns:n4="https://adwords.google.com/api/adwords/cm/v200909">
-#          <n4:min>20090101</n4:min>
-#          <n4:max>20091030</n4:max>
-#        </n3:dateRange>
-#        <n3:apiUsageType>UNIT_COUNT</n3:apiUsageType>
-#      </n3:selector>
-#    </n3:get>
-#  </env:Body>
-#</env:Envelope>
-
-
 module Sem4r
   class InfoService
     include SoapCall
 
     def initialize(connector)
       @connector = connector
-      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201003"
-      @service_namespace = "https://adwords.google.com/api/adwords/info/v201003"
+      @header_namespace  = "https://adwords.google.com/api/adwords/cm/v201008"
+      @service_namespace = "https://adwords.google.com/api/adwords/info/v201008"
 
-      @production_service_url = "https://adwords.google.com/api/adwords/info/v201003/InfoService"
-      @sandbox_service_url    = "https://adwords-sandbox.google.com/api/adwords/info/v201003/InfoService"
+      @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"
     end
 
-
-    soap_call_v2009 :unit_cost
+    soap_call_v2010 :get, :mutate => false
 
     def _unit_cost( usage_type )
       <<-EOFS
@@ -65,51 +50,11 @@ module Sem4r
       EOFS
     end
 
-
-    # Total units used since the beginning of the year: 0
-    #    def old_unit_cost(credentials)
-    #
-    #      soap_message = @connector.message_v2009(credentials, @header_namespace, @service_namespace )
-    #      soap_message.body = "soap_body_content"
-    #
-    #
-    #      soap_message.instance_eval do
-    #        def build_soap_message
-    #          str = <<-EOFS
-    #<?xml version="1.0" encoding="utf-8" ?>
-    #  <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="https://adwords.google.com/api/adwords/cm/v200909"
-    #    xmlns:s="https://adwords.google.com/api/adwords/info/v200909">
-    #    <env:Header>
-    #      <s:RequestHeader env:mustUnderstand="0">
-    #        <authToken>#{@credentials.authentication_token}</authToken>
-    #        <userAgent>adwords4r: Sample User Agent</userAgent>
-    #        <developerToken>#{@credentials.developer_token}</developerToken>
-    #      </s:RequestHeader>
-    #    </env:Header>
-    #    <env:Body  >
-    #      <s:get>
-    #        <s:selector>
-    #          <s:dateRange>
-    #            <min>20090101</min>
-    #            <max>20091105</max>
-    #          </s:dateRange>
-    #          <s:apiUsageType>UNIT_COUNT</s:apiUsageType>
-    #        </s:selector>
-    #      </s:get>
-    #    </env:Body>
-    #  </env:Envelope>
-    #EOFS
-    #          str
-    #        end
-    #      end
-    #
-    #      result_xml = soap_message.send(@sandbox_service_url)
-    #      result_xml
-    #    end
-
+    def _get(xml)
+      <<-EOFS
+      <s:get>#{xml}</s:get>
+      EOFS
+    end
+    
   end
 end

data/lib/sem4r/{common/operation.rb → operation.rb}

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # -------------------------------------------------------------------------
 # Copyright (c) 2009-2010 Sem4r sem4ruby@gmail.com
 # 
@@ -60,7 +61,8 @@ module Sem4r
 
       xml = ""
       if tag
-        xml += "<#{tag} xsi:type='#{operation_type}'>"
+        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"
       end
       xml +=<<-EOS
         <operator>#{operator}</operator>