sem4r 0.1.2 → 0.1.3

data/lib/{sem4r/cli/cli_common_args.rb → sem4r_cli/cli_sem.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,63 +20,181 @@
 # 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
+
+  #
+  # Macro helper for define new sem4r command
+  #
+  def self.define_command_sem4r(command_name, description, &block)
+    CliCommand.define_command(command_name, description) do |cli|
+      account = cli.account
+      unless account
+        puts "please select a valid account!"
+        false
+      else
+        block.call(account)
+      end
+    end
+  end
 
-  class CliCommonArgs
+  #
+  # CliSem Driver
+  #   parses common options
+  #   finds command and instantiate command
+  #   passes the unparsed parameter to command
+  #   leaves control to command
+  #
+  class CliSem < Cli
 
     def initialize
       # defaults
       @options = OpenStruct.new({
-          :verbose => true,
-          :force   => false,
-          :default_logging => true,
-          # :dump_soap_to_file => true,
-          # :dump_soap_to_directory => true,
-          :profile => 'sandbox'
-        })
+                                    :verbose         => true,
+                                    :force           => false,
+                                    :default_logging => true,
+                                    # :dump_soap_to_file => true,
+                                    # :dump_soap_to_directory => true,
+                                    :profile         => 'sandbox',
+                                    :ask_password    => false
+                                })
     end
 
-    def parse_and_run(argv)
-      parse(argv)
-    end
-
-    def parse(argv)
+    def parse_and_run(all_args)
 
       begin
-        rest = opt_parser(@options).parse(argv)
+        command_args = opt_parser(@options).order(all_args)
       rescue OptionParser::AmbiguousOption => e
         puts e.message
         return false
       end
+      return true if @options.exit
+
+      if command_args.empty?
+        puts "missing command try sem -h for help"
+        return false
+      end
+
+      command      = command_args[0]
+      command_args = command_args[1..-1]
 
-      if rest.length > 0
-        # cannot happen
-        puts "unknow options #{rest.join}"
+      # find command
+      if CliCommand.commands[command].nil?
+        puts "unknow command #{command}"
         return false
       end
 
-      if @options.list_profiles
-        puts "Profiles:"
-        profiles = Adwords.profiles( @options.config_name )
-        names = profiles.keys.map &:to_s
-        names.sort.each do |s|
-          puts "  #{s} (#{profiles[s]['email']})"
+      begin
+        cmd = CliCommand.commands[command].new(self)
+        return cmd.parse_and_run(command_args)
+      rescue Sem4rError
+        puts "I am so sorry! Something went wrong! (exception #{$!.to_s})"
+        return false
+      end
+    end
+
+    #
+    # initialize adwords according to command line options
+    # return [Sem4r::Adwords]
+    #
+    def adwords
+      return @adwords if @adwords
+
+      #
+      # select profile
+      #
+      options = {}
+      if @options.config_name
+        options[:config_file] = @options.config_name
+      end
+      @adwords = Adwords.new(@options.profile, options)
+      if @options.verbose
+        puts "using #{@adwords.profile} profile"
+        puts "config file is #{@adwords.config_file}"
+      end
+      #
+      # Extracts dump soap options
+      #
+      if @options.default_logging
+        configdir = File.join(ENV['HOME'], ".sem4r")
+        unless File.exists?(configdir)
+          puts "Directory #{configdir} not exists"
+          FileUtils.mkdir(configdir)
         end
+        dir                             = File.join(configdir, Time.new.strftime("%Y%m%d-soap-dump"))
+        @options.dump_soap_to_directory = dir
+
+        file                            = File.join(configdir, Time.new.strftime("%Y%m%d-sem4r-log"))
+        @options.logger                 = file
+      end
+
+      if @options.dump_soap_to_file
+        filename = @options.dump_soap_to_file
+        o        = {:file => filename}
+        @adwords.dump_soap_options(o)
+      end
+      if @options.dump_soap_to_directory
+        dir = @options.dump_soap_to_directory
+        o   = {:directory => dir, :format => true}
+        @adwords.dump_soap_options(o)
+      end
+      if @options.verbose and adwords.dump_soap?
+        puts "Logging soap conversation to '#{adwords.dump_soap_where}'"
+      end
+      if !@adwords.dump_soap?
+        puts "it is highly recommended to activate the dump soap log"
       end
 
-      if @options.ask_password
-        puts "ask_password"
+      #
+      # Extracts log options
+      #
+      # filename = File.join( tmp_dirname, File.basename(example_file).sub(/\.rb$/, ".log") )
+      if @options.logger
+        # filename = "sem.log"
+        @adwords.logger = @options.logger
       end
+      if @adwords.logger
+        puts "Logger is active" if @options.verbose
+      end
+      @adwords
+    end
 
-      !@options.exit
+    #
+    # select account according to the command line arguments
+    # return [Sem4r::Account]
+    #
+    def account
+      return @account if @account
+
+      adwords # initialize sem4r lib adwords
+      if @options.ask_password or !@adwords.has_password?
+        pwd               = read_password_from_terminal
+        @adwords.password = pwd
+        @adwords.save_passwords
+      end
+
+      #
+      # select account for command
+      #
+      if @options.client_email
+        account = @adwords.account.client_accounts.find { |c| c.client_email =~ /#{@options.client_email}/ }
+        if account.nil?
+          puts "client account not found"
+        else
+          puts "using client #{account.client_email}"
+        end
+      else
+        account = @adwords.account
+      end
+      @account = account
     end
 
+    private
+
     def opt_parser(options)
-      opt_parser = OptionParser.new
-      opt_parser.banner =  "Sem is a simple command line interface using the sem4r library."
+      opt_parser        = OptionParser.new
+      opt_parser.banner = "Sem is a simple command line interface using the sem4r library."
       opt_parser.separator "It's alpha software, please don't use in production or use it at your risk!"
       opt_parser.separator "Further information: http://www.sem4r.com"
       opt_parser.separator ""
@@ -113,7 +231,7 @@ module Sem4r
 
       opt_parser.on("-l", "--list-commands", "list commands") do
         puts "SEM commands are:"
-        commands = CliCommand.commands.values.sort {|a,b| a.command <=> b.command }
+        commands = CliCommand.commands.values.sort { |a, b| a.command <=> b.command }
         commands.each do |cmd|
           printf "  %-20s %s\n", cmd.command, cmd.description
         end
@@ -122,6 +240,9 @@ module Sem4r
         options.exit = true
       end
 
+      #
+      # Logging
+      #
       opt_parser.separator ""
       opt_parser.separator "logging options: "
       opt_parser.separator ""
@@ -130,171 +251,70 @@ module Sem4r
         options.logger = v
       end
 
-      opt_parser.on("-f", "--dump-file FILE", "dump soap conversation to file") do |v|
+      opt_parser.on("--dump-file FILE", "dump soap conversation to file") do |v|
         options.dump_soap_to_file = v
       end
 
       str = "dump soap conversation to directory: each \n"
       str << (" " * 37) + "request/response is in a single file"
-      opt_parser.on("-d", "--dump-dir DIRECTORY", str) do |v|
+      opt_parser.on("--dump-dir DIRECTORY", str) do |v|
         options.dump_soap_to_directory = v
       end
 
+      #
+      # Profile - Configuration
+      #
       opt_parser.separator ""
       opt_parser.separator "profile and credentials options: "
       opt_parser.separator "  credentials options overwrite profile attributes"
       opt_parser.separator ""
 
-      str =  "file where profiles are defined\n"
+      str = "file where profiles are defined\n"
       str << (" " * 37) + "(default $HOME/.sem4r/sem4r.yaml)"
       opt_parser.on("--config CONFIG", str) do |config|
         options.config_name = config
       end
 
-      opt_parser.on("--list-profiles", "list profiles") do
-        options.list_profiles = true
-        options.exit = true
-      end
-
       opt_parser.on("-p", "--profile PROFILE", "select profile (default is sandbox)") do |profile|
         options.profile = profile
       end
 
       # email
       opt_parser.on("--email EMAIL",
-        "email of adwords account") do |email|
+                    "email of adwords account") do |email|
         options.email = email
       end
 
       # password
-      opt_parser.on("--password [PASSWORD]",
-        "password of adwords account",
-        "If password is not given it's asked from the tty") do |password|
-        options.ask_password = !password
+      opt_parser.on("-a", "--ask-password",
+                    "ask password on terminal") do
+        options.ask_password = true
+      end
+
+      opt_parser.on("--password PASSWORD",
+                    "password of adwords account") do |password|
         options.password = password if password
       end
 
       # developer token
       opt_parser.on("--token TOKEN",
-        "developer token to access adwords api") do |token|
+                    "developer token to access adwords api") do |token|
         options.developer_token = token
       end
 
       # client account
       opt_parser.on("-c", "--client EMAIL",
-        "email for client account") do |email|
+                    "email for client account") do |email|
         options.client_email = email
       end
       opt_parser.separator ""
       opt_parser
     end
 
-    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
-
-    def account
-      #
-      # select profile
-      #
-      options = {}
-      if @options.config_name
-        options[:config_file] = @options.config_name
-      end
-      adwords = Adwords.new( @options.profile, options )
-      if @options.verbose
-        puts "using #{adwords.profile} profile"
-        puts "config file is #{adwords.config_file}"
-      end
-
-      #
-      # logging soap conversation
-      #
-      if @options.default_logging
-        configdir = File.join( ENV['HOME'], ".sem4r" )
-        unless File.exists?(configdir)
-          puts "Directory #{configdir} not exists"
-          FileUtils.mkdir(configdir)
-        end
-        dir = File.join(configdir, Time.new.strftime("%Y%m%d-soap-dump"))
-        @options.dump_soap_to_directory = dir
-        
-        file = File.join(configdir, Time.new.strftime("%Y%m%d-sem4r-log"))
-        @options.logger = file
-      end
-
-      if @options.dump_soap_to_file
-        filename = @options.dump_soap_to_file
-        o = { :file => filename }
-        adwords.dump_soap_options( o )
-      end
-      if @options.dump_soap_to_directory
-        dir = @options.dump_soap_to_directory
-        o = { :directory => dir, :format => true }
-        adwords.dump_soap_options( o )
-      end
-      if @options.verbose and adwords.dump_soap?
-        puts "Logging soap conversation to '#{adwords.dump_soap_where}'"
-      end
-      if !adwords.dump_soap?
-        puts "it is highly recommended to activate the dump soap log"
-      end
-
-      #
-      # logging
-      #
-      # filename = File.join( tmp_dirname, File.basename(example_file).sub(/\.rb$/, ".log") )
-      if @options.logger
-        # filename = "sem.log"
-        adwords.logger = @options.logger
-      end
-      if adwords.logger
-        puts "Logger activated"
-      end
-      # adwords.logger = Logger.new(STDOUT)
-
-      #
-      # select account for command
-      #
-      if @options.client_email
-        account = adwords.account.client_accounts.find{ |c| c.client_email =~ /^#{@options.client_email}/ }
-        if account.nil?
-          puts "client account not found"
-        else
-          puts "using client #{account.client_email}"
-        end
-      else
-        account = adwords.account
-      end
-      return account
+    def read_password_from_terminal
+      ask("Enter your password:  ") { |q| q.echo = "x" }
     end
 
   end
 
-end
+end # module Sem4rCli

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

@@ -20,13 +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
 
-  CliListAds = CliCommand.define_command("ads", "list ads") do |account|
-    puts "List AdGroup Advertising"
+  CliListAds = define_command_sem4r("ads", "list ads") do |account|
+    puts "Collecting ads from account(s) - please wait"
 
     # if the accounts have client_accounts it is a master
     client_accounts = account.client_accounts
@@ -34,7 +33,7 @@ module Sem4r
       client_accounts = [account]
     end
 
-    items = []
+    items        = []
     need_newline = false
 
     client_accounts.each do |client_account|
@@ -43,14 +42,13 @@ module Sem4r
         need_newline = false
       end
 
-      #--
-      puts "examinate account '#{client_account.credentials.client_email}'"
+      puts "look in account '#{client_account.credentials.client_email}'"
       client_account.campaigns.each do |campaign|
         # puts "examinate campaign '#{campaign}'"
         campaign.ad_groups.each do |ad_group|
           # puts "examinate adgroup '#{ad_group}'"
           ad_group.ads.each do |ad|
-            o = OpenStruct.new
+            o          = OpenStruct.new
             o.client   = client_account.credentials.client_email
             o.campaign = campaign.name
             o.ad_group = ad_group.name
@@ -62,7 +60,6 @@ module Sem4r
           need_newline = true
         end
       end
-      #--
 
     end
     if need_newline
@@ -71,5 +68,6 @@ module Sem4r
     end
     report(items, :client, :campaign, :ad_group, :url, :display_url)
     account.adwords.p_counters
+    true
   end
 end

data/lib/sem4r_cli/commands/cli_campaign.rb

@@ -0,0 +1,69 @@
+# -*- 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
+
+  CliListCampaign = define_command_sem4r("campaigns", "list campaigns") do |account|
+    puts "Collecting campaign from account(s) - please wait"
+
+    # if the accounts have client_accounts it is a master
+    client_accounts = account.client_accounts
+    if client_accounts.empty?
+      client_accounts = [account]
+    end
+
+    items        = []
+    need_newline = false
+
+    client_accounts.each do |client_account|
+      if need_newline
+        puts
+        need_newline = false
+      end
+
+      puts "look in account '#{client_account.credentials.client_email}'"
+      client_account.campaigns.each do |campaign|
+
+        o        = OpenStruct.new
+        o.client = client_account.credentials.client_email
+        o.id     = campaign.id
+        o.name   = campaign.name
+        o.status = campaign.status
+        items << o
+
+        print "."
+        need_newline = true
+      end
+    end
+
+    if need_newline
+      puts
+      need_newline = false
+    end
+    report(items, :client, :id, :name, :status)
+    account.adwords.p_counters
+    true
+  end
+
+end

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

@@ -23,9 +23,9 @@
 # 
 # -------------------------------------------------------------------------
 
-module Sem4r
+module Sem4rCli
 
-  CliListClient = CliCommand.define_command("clients", "list clients account") do |account|
+  CliListClient = define_command_sem4r("clients", "list clients account") do |account|
     puts account.adwords.to_s
     puts account.to_s
     account.p_client_accounts

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

@@ -23,8 +23,11 @@
 # 
 # -------------------------------------------------------------------------
 
-module Sem4r
+module Sem4rCli
 
+  #
+  # idea
+  #
   class CliIdeas < CliCommand
 
     def self.command
@@ -39,8 +42,29 @@ module Sem4r
       @common_args = common_args
     end
 
+    def parse_and_run(argv)
+      options = OpenStruct.new
+      rest    = opt_parser(options).parse(argv)
+      return false if options.exit
+
+      if rest.length < 1
+        puts "keyword missing; see help"
+        return false
+      end
+
+      keyword = rest[1]
+      account = @common_args.account
+      unless account
+        puts "select an account!"
+        return false
+      end
+      _run(account, keyword)
+    end
+
+    private
+
     def opt_parser(options)
-      opt_parser = OptionParser.new
+      opt_parser       = OptionParser.new
       opt_parser.banner= "#{self.class.description}"
       opt_parser.separator "Usage: sem [options] idea <keyword>"
 
@@ -53,31 +77,13 @@ module Sem4r
       end
     end
 
-    def parse_and_run(argv)
-      options = OpenStruct.new
-      rest = opt_parser(options).parse( argv )
-      return false if options.exit
-      if rest.length < 1
-        puts "keyword missing see help"
-        return false
-      end
-      
-      @keyword =  rest[1]
-      account = @common_args.account
-      unless account
-        puts "select an account!"
-      else
-        _run account
-      end
-    end
-
-    def _run(account)
-      ideas = account.targeting_idea  do
-        idea_type    "KEYWORD"
+    def _run(account, keyword)
+      ideas = account.targeting_idea do
+        idea_type "KEYWORD"
         request_type "IDEAS"
 
         related_to_keyword_search_parameter do
-          text       @keyword
+          text keyword
           match_type 'EXACT'
         end
       end
@@ -86,16 +92,18 @@ module Sem4r
       ideas.each do |i|
         i.each do |a|
           next if a.class != TKeywordAttribute
-          o = OpenStruct.new
+          o       = OpenStruct.new
           o.text  = a.text
           o.match = a.match_type
           items << o
         end
       end
 
-      Sem4r::report(items, :text, :match)
+      Sem4rCli::report(items, :text, :match)
       account.adwords.p_counters
+      true
     end
 
   end
-end
+
+end # module Sem4rCli