sem4r 0.1.2 → 0.1.3

data/lib/{sem4r/cli → sem4r_cli}/commands/cli_info.rb

@@ -23,13 +23,12 @@
 # 
 # -------------------------------------------------------------------------
 
-module Sem4r
+module Sem4rCli
 
-  CliInfo = CliCommand.define_command("info", "account info") do |account|
+  CliInfo = define_command_sem4r("info", "show account info") do |account|
     account.p_info
-    items = (Account::UsageTypes - [Account::METHOD_COST]).map do |usage_type|
+    items = (InfoSelector::UsageTypes - [InfoSelector::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)

data/lib/{sem4r/cli/commands/cli_repdef.rb → sem4r_cli/commands/cli_job.rb}

@@ -1,7 +1,7 @@
 # -*- 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
@@ -9,10 +9,10 @@
 # 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
@@ -20,27 +20,34 @@
 # 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
+module Sem4rCli
+
+  #
+  # BulkMuteteJob
+  #
+  class CliJob < CliCommand
 
     def self.command
-      "repdef"
+      "job"
+    end
+
+    def self.subcommands
+      %w{list submit submit_pending delete}
     end
 
     def self.description
-      "report definition"
+      "manage bulk mutate job (subcommands: #{subcommands.join(', ')})"
     end
 
-    def initialize(common_args)
-      @common_args = common_args
+    def initialize(sem4r_cli)
+      @sem4r_cli = sem4r_cli
     end
 
     def command_opt_parser(options)
-      opt_parser = OptionParser.new
-      opt_parser.banner = "Usage #{self.class.command} [command_options ] [fields|list|create]"
+      opt_parser        = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options ] [#{self.class.subcommands.join("|")}]"
       opt_parser.separator ""
       opt_parser.separator "#{self.class.description}"
       opt_parser.on("-h", "--help", "show this message") do
@@ -51,57 +58,52 @@ module Sem4r
 
     def parse_and_run(argv)
       options = OpenStruct.new
-      rest = command_opt_parser(options).parse( argv )
-      if options.exit
-        return false
-      end
+      rest    = command_opt_parser(options).parse(argv)
+      return false if options.exit
 
       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"
+      account         = @sem4r_cli.account
+      ret             = true
+      subcommand      = rest[0]
+      subcommand_args = rest[1..-1]
+      case subcommand
+
+        when "list"
+          Sem4rCli::report(account.jobs, :id, :status)
+
+        when "delete"
+          job_id = rest[1]
+          account.job_delete(job_id)
+
+        when "submit"
+          ret = create(account)
+
+        when "submit_pending"
+          ret = create(account, true)
+        else
+          puts "unknow subcommand '#{subcommand}'; must be one of #{self.class.subcommands.join(", ")}"
+          return false
       end
       account.adwords.p_counters
+      ret
+    end
+
+    private
+
+    def create(account, pending = false)
+      puts "creating example job"
+      campaign, ad_group = template_campaign_and_ad_group(account)
+      job = template_bulk_mutate_job(campaign, ad_group)
+      if pending
+        job.num_parts = 3
+      end
+      result_job = account.job_mutate(JobOperation.add(job))
+      puts result_job.to_s
+      account.p_jobs
       true
     end
 

data/lib/{sem4r/cli/commands/cli_list_keywords.rb → sem4r_cli/commands/cli_keywords.rb}

@@ -20,12 +20,12 @@
 # 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 Sem4rCli
 
-  CliListKeywords = CliCommand.define_command("keywords", "list keywords") do |account |
+  CliListKeywords = define_command_sem4r("keywords", "list keywords") do |account|
+    puts "Collecting keywords from account(s) - please wait"
 
     # if the account have client_accounts it is a master
     client_accounts = account.client_accounts
@@ -33,11 +33,11 @@ module Sem4r
       client_accounts = [account]
     end
 
-    items = []
+    items        = []
     need_newline = false
     client_accounts.each do |client_account|
       if need_newline
-        puts 
+        puts
         need_newline = false
       end
       puts "examinate account '#{client_account.credentials.client_email}'"
@@ -45,19 +45,19 @@ module Sem4r
         # puts "examinate campaign '#{campaign}'"
         campaign.ad_groups.each do |ad_group|
           ad_group.criterions.each do |criterion|
-          
-            row = OpenStruct.new
+
+            row          = OpenStruct.new
             row.client   = client_account.credentials.client_email
             row.campaign = campaign.name
             row.ad_group = ad_group.name
 
             row.type     = criterion.type
             case criterion.type
-            when Criterion::Keyword
-              row.text  = criterion.text
-              row.match = criterion.match
-            when Criterion::Placement
-              row.text  = criterion.url
+              when Criterion::Keyword
+                row.text  = criterion.text
+                row.match = criterion.match
+              when Criterion::Placement
+                row.text = criterion.url
             end
             items << row
             print "."
@@ -72,6 +72,7 @@ module Sem4r
     end
     report(items, :client, :campaign, :ad_group, :type, :text, :match)
     account.adwords.p_counters
+    true
   end
 
-end
+end # module Sem4rCli

data/lib/sem4r_cli/commands/cli_profile.rb

@@ -0,0 +1,138 @@
+# -*- 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 Sem4rCli
+
+  #
+  # Manage Sem4r profiles
+  #
+  class CliProfile < CliCommand
+
+    def self.command
+      "profile"
+    end
+
+    def self.subcommands
+      %w{list create}
+    end
+
+    def self.description
+      "manage sem4r profiles (subcommands: #{subcommands.join(', ')})"
+    end
+
+    def initialize(sem4r_cli)
+      @sem4r_cli = sem4r_cli
+    end
+
+    def command_opt_parser(options)
+      opt_parser        = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options] [#{self.class.subcommands.join("|")}]"
+      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)
+      return false if options.exit
+      if rest.empty?
+        puts "missing command"
+        return false
+      end
+
+      ret             = true
+      subcommand      = rest[0]
+      subcommand_args = rest[1..-1]
+      adwords         = @sem4r_cli.adwords
+      case subcommand
+        when "list"
+          puts "Profiles:"
+
+          items    = []
+          profiles = adwords.profiles
+          names    = profiles.keys.map &:to_s
+          names.sort.each do |s|
+            o             = OpenStruct.new
+            o.name        = s
+            o.email       = profiles[s]['email']
+            o.mutable     = profiles[s]['mutable']
+            o.environment = profiles[s]['environment']
+            items << o
+          end
+          Sem4rCli::report(items, :name, :environment, :email, :mutable)
+        when "create"
+          puts "Tobe done :-)"
+
+        else
+          puts "unknow subcommand '#{subcommand}'; must be one of #{self.class.subcommands.join(", ")}"
+          return false
+      end
+      ret
+    end
+
+    private
+
+    #
+    # read credentials from console (create profile?)
+    #
+    def read_credentials_from_console
+      unless @options.environment
+        # The new and improved choose()...
+        say("\nThis is the new mode (default)...")
+        choose do |menu|
+          menu.prompt = "Please choose your favorite programming language?  "
+
+          menu.choice :ruby do
+            say("Good choice!")
+          end
+          menu.choices(:python, :perl) do
+            say("Not from around here, are you?")
+          end
+        end
+      end
+
+      @options.email           ||= ask("Enter adwords email:     ")
+      @options.password        ||= ask("Enter adwords password:  ") { |q| q.echo = "x" }
+      @options.developer_token ||= ask("Enter adwords developer_token:  ")
+
+      config                   = {
+          :environment     => @options.environment,
+          :email           => @options.email,
+          :password        => @options.password,
+          :developer_token => @options.developer_token
+      }
+
+      pp config
+      unless agree("credentials are correct?")
+        exit
+      end
+      config
+    end
+
+  end
+end

data/lib/{sem4r/cli/commands/cli_report.rb → sem4r_cli/commands/cli_repdef.rb}

@@ -1,7 +1,7 @@
 # -*- 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
@@ -9,10 +9,10 @@
 # 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
@@ -20,27 +20,34 @@
 # 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
+module Sem4rCli
+
+  #
+  # Report Definition (v201008 api)
+  #
+  class CliRepDef < CliCommand
 
     def self.command
-      "report"
+      "repdef"
+    end
+
+    def self.subcommands
+      %w{fields list create}
     end
 
     def self.description
-      "manage report"
+      "manage report definition (subcommands: #{subcommands.join(", ")})"
     end
 
-    def initialize(common_args)
-      @common_args = common_args
+    def initialize(sem4r_cli)
+      @sem4r_cli = sem4r_cli
     end
 
     def command_opt_parser(options)
-      opt_parser = OptionParser.new
-      opt_parser.banner = "Usage #{self.class.command} [command_options ] [fields|list|create]"
+      opt_parser        = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options ] [#{self.class.subcommands.join("|")}]"
       opt_parser.separator ""
       opt_parser.separator "#{self.class.description}"
       opt_parser.on("-h", "--help", "show this message") do
@@ -51,26 +58,66 @@ module Sem4r
 
     def parse_and_run(argv)
       options = OpenStruct.new
-      rest = command_opt_parser(options).parse( argv )
+      rest    = command_opt_parser(options).parse(argv)
       if options.exit
         return false
       end
 
-      if rest.length != 1
+      if rest.empty?
         puts "missing command"
         return false
       end
 
-      account = @common_args.account
+      account         = @sem4r_cli.account
+      ret             = true
+      subcommand      = rest[0]
+      subcommand_args = rest[1..-1]
+      case subcommand
+        when "fields"
+          report_type = ReportDefinition::AD_PERFORMANCE_REPORT
+          puts "Fields for #{report_type}"
+          Sem4rCli::report(account.report_fields(report_type), :field_name, :field_type)
 
-      case rest[0]
-      when "list"
-        Sem4r::report(account.reports, :id, :name, :status)
+        when "list"
+          Sem4rCli::report(account.report_definitions, :id, :name)
 
-      else
-        puts "unknow command"
+        when "delete"
+          report_definition_id = rest[1]
+          account.report_definition_delete(report_definition_id)
+
+        when "create"
+          ret = create(account)
+        else
+          puts "unknow subcommand '#{subcommand}'; must be one of #{subcommands.join(", ")}"
+          return false
       end
       account.adwords.p_counters
+      ret
+    end
+
+    private
+
+    def create(account)
+      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
       true
     end
 

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

@@ -1,7 +1,7 @@
 # -*- 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
@@ -9,10 +9,10 @@
 # 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
@@ -20,45 +20,108 @@
 # 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 Sem4rCli
 
-  class CliRequestReport < CliCommand
+  #
+  # report (v13 api)
+  #
+  class CliReport < CliCommand
 
     def self.command
-      "request"
+      "report"
     end
 
     def self.description
-      "schedule a report"
+      "manage v13 report"
     end
 
-    def initialize(account)
-      @account = account
+    def initialize(common_args)
+      @common_args = common_args
+      @subcomands = %w{list download schedule}
     end
 
+    def parse_and_run(argv)
+      options = OpenStruct.new
+      rest    = command_opt_parser(options).parse(argv)
+      return false if options.exit
+
+      if rest.length == 0
+        puts "missing sub command"
+        return false
+      end
+
+      ret = true
+      subcommand = rest[0]
+      subcommand_args = rest[1..-1]
+      case subcommand
+        when "list"
+          Sem4rCli::report(@common_args.account.reports, :id, :name, :status)
+
+        when "download"
+          ret = download(subcommand_args)
+
+        when "schedule"
+          ret = schedule(subcommand_args)
+          
+        else
+          puts "unknow subcommand '#{subcommand}'; must be one of #{@subcomands.join(", ")}"
+          return false
+      end
+
+      @common_args.account.adwords.p_counters
+      ret
+    end
+
+    private
+
     def command_opt_parser(options)
-      opt_parser = OptionParser.new
-      opt_parser.banner = "Usage #{self.class.command} [command_options ] <report_id>"
+      opt_parser        = OptionParser.new
+      opt_parser.banner = "Usage #{self.class.command} [command_options ] [#{@subcomands.join("|")}]"
       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
+    #
+    # download a v13 report
+    #
+    def download(args)
+      if args.length != 1
+        puts "missing report id for 'donwload' subcommand"
+        return false
+      end
+
+      report_id = args[0].to_i
+      report    = @common_args.account.reports.find { |r| r.id == report_id }
+      if report.nil?
+        puts "report '#{report_id}' not found"
         return false
       end
 
+      if report.status != 'Completed'
+        puts "cannot donwload report with status '#{report.status}'"
+        return false
+      end
+
+      path_name = "test_report.xml"
+      puts "Download report #{report.id} in #{path_name}"
+      report.download(path_name)
+      true
+    end
+
+    #
+    # schedule and download a v13 report
+    #
+    def schedule(argv)
+
       report = @account.report do
-        name            'boh' 
+        name            'boh'
         type            'Url'
         aggregation     'Daily'
         cross_client    true
@@ -96,9 +159,9 @@ module Sem4r
       end
       puts "scheduled job"
       job = report.schedule
-      job.wait(5) { |report, status| puts "status #{status}" }
+      job.wait(10) { |report, status| puts "status #{status}" }
       report.download("test_report.xml")
-      account.adwords.p_counters
+      true
     end
 
   end