itunes_store_transporter 0.0.1 → 0.0.2

data/Changes

@@ -0,0 +1,12 @@
+v0.0.2    2012-09-23
+--------------------
+Enhancements:
+* `itms` added --no-config option
+* `itms` allow boolean options to be set to false via --no-XXXX, e.g., --no-print-stderr
+
+Bug Fixes: 
+* `itms status` passed the wrong arguments to the underlying method
+* `itms` failed when the config file was empty
+* Verify command :verify_assets => true would disable asset verification
+* Status command ignored multiple status lines
+* Lookup command failed to create tempdir

data/README.rdoc

@@ -1,5 +1,8 @@
 = iTunes::Store::Transporter
 
+{<img src="https://secure.travis-ci.org/sshaw/itunes_store_transporter.png"/>}[http://travis-ci.org/sshaw/itunes_store_transporter]
+{<img src="https://codeclimate.com/badge.png"/>}[https://codeclimate.com/github/sshaw/itunes_store_transporter]
+
 Upload and manage your assets in the iTunes Store using the iTunes Store's Transporter (+iTMSTransporter+).
 
 === Overview
@@ -36,7 +39,7 @@ supports the following operations:
 * List providers
 * Retrieve iTunes metadata schemas
 
-It also includes +itms+, an executable that's sorta like using +iTMSTransporter+ directly, except 
+It also includes +itms+, an executable that's sorta like using +iTMSTransporter+ directly except
 that it can send email notifications and allows one to set global/per-command defaults via <code>$HOME/.itms</code>.
 
 === Requirements
@@ -47,7 +50,7 @@ that it can send email notifications and allows one to set global/per-command de
 === Running on Windows
 
 On Windows +iTMSTransporter+ is called via the +iTMSTransporter.CMD+ batch file. This file does not handle the
-+iTMSTransporter+'s exit status correctly, causing <code>iTunes::Store::Transporter</code> to report everything as a success. 
++iTMSTransporter+'s exit status correctly, causing <code>iTunes::Store::Transporter</code> to report everything as a success.
 
 This can be fixed by modifying +iTMSTransporter.CMD+ (note that the following does not mimic the batch file exactly):
 
@@ -68,18 +71,18 @@ This can be fixed by modifying +iTMSTransporter.CMD+ (note that the following do
 <code>itms COMMAND [OPTIONS]</code>
 
 * +COMMAND+ - The command (<code>iTunes::Store::Transporter</code> method) to run
-* +OPTIONS+ - These are equivalent to the given +COMMAND+'s options except they must be given in long option format. For example <code>:apple_id => "X123"</code> would be <code>--apple-id=X123</code>.
+* +OPTIONS+ - These are quivalent to the given +COMMAND+'s options except they must be given in long option format. For example <code>:apple_id => "X123"</code> would be <code>--apple-id=X123</code>. Boolean options can be negated with the <code>--no-</code> prefix.
 
 ==== Config file
 
-Default options and email notifications can be placed in a YAML file at <code>$HOME/.itms</code>. 
+Default options and email notifications can be placed in a YAML file at <code>$HOME/.itms</code>. To skip loading the config file use the <code>--no-config</code> option.
 
     # Global command defaults
     path: /usr/bin
     username: sshaw
     password: Pa55W0rd!
 
-    # Global email defaults    
+    # Global email defaults
     email:
       to: everyone@example.com
       from: no-reply@example.com
@@ -93,30 +96,34 @@ Default options and email notifications can be placed in a YAML file at <code>$H
     upload:
       shortname: enc0d3rz
       transport: Aspera
-      rate: 750_000
+      rate: 750000
       # Email notifications for the upload command
       email:
         success:
           cc: assets@example.com
           subject: iTunes Upload <%= @apple_id %>
-          message: |        
-            <% @username > uploaded it using <%= @transport %>
+          message: |
+            <%= @username %> uploaded it using <%= @transport %>
 
             Bye!
         failure:
           to: support@example.com
           subject: Upload Failed!
           message: |
-            Here's the problem: 
+            Here's the problem:
 
-            <%= @error %>	
+            <%= @error %>
 
             Fix it!
 
+As you can see, command options are turned into template variables.
+
 === More Info
 
-* Source Code: http://github.com/sshaw/itunes_store_transporter
+* Docs: http://ruby-doc.org/gems/docs/i/itunes_store_transporter-0.0.2/README_rdoc.html
 * Bugs: http://github.com/sshaw/itunes_store_transporter/issues
+* Source Code: http://github.com/sshaw/itunes_store_transporter
+* Web Based GUI: http://github.com/sshaw/itunes_store_transporter_web
 
 === Author
 

data/bin/itms

@@ -5,7 +5,7 @@ require "yaml"
 require "net/smtp"
 require "itunes/store/transporter"
 
-# Command line interface to the ITunes::Store::Transporter library. 
+# Command line interface to the ITunes::Store::Transporter library.
 # Using this is sorta like using iTMSTransporter except it can send email notifications and allows
 # one to set global/per-command defaults via $HOME/.itms
 
@@ -14,13 +14,13 @@ module Command
   class << self
     def execute(name, options, argv)
       name = name.capitalize
-      # Avoid Ruby 1.8/1.9 String/Symbol/const_defined? differences      
+      # Avoid Ruby 1.8/1.9 String/Symbol/const_defined? differences
       unless constants.include?(name) || constants.include?(name.to_sym)
         raise ArgumentError, "unknown command '#{name}'"
       end
 
       command = const_get(name).new(options)
-      command.execute(argv) 
+      command.execute(argv)
     end
   end
 
@@ -30,7 +30,7 @@ module Command
       @options = options
     end
   end
-  
+
   class Providers < Base
     def initialize(options)
       # Let iTMSTransporter print the providers
@@ -51,7 +51,7 @@ module Command
       puts "Metadata saved to #{filename}"
     end
   end
-  
+
   class Schema < Base
     def execute(args = [])
       filename = "#{@options[:version]}-#{@options[:type]}.rng"
@@ -60,22 +60,41 @@ module Command
       puts "Schema saved to #{filename}"
     end
   end
-  
+
   class Status < Base
     def initialize(options)
-      # Let iTMSTransporter print the status
-      options[:print_stdout] = true
+      # It's preferable to let iTMSTransporter output the status but unlike other commands
+      # it summarizes errors on stdout. This results in redundant error messages since we summarize
+      # errors too. To avoid this, and keep our error messages consistant, we reprint the status below.
+      options[:print_stdout] = false unless options.include?(:print_stdout)
       super
     end
 
-    def execute(args = [])
-      @itms.status(args.shift)
+    def execute(args = [])      
+      info = @itms.status
+      info.each do |k, v|
+        next if k == :status
+        say(k, v, 21)
+      end
+
+      info[:status].each_with_index do |status, i|
+        pos = info[:status].size - i
+        puts "\n#{'-' * 15} Upload ##{pos} #{'-' * 15}"
+        status.each do |k, v|
+          say(k, v, 18)
+        end
+      end
+    end
+
+    def say(k, v, width)
+      k = k.to_s.capitalize.gsub("_", " ")
+      printf "%-#{width}s %s\n", k, v
     end
   end
 
   class Upload < Base
     def initialize(options)
-      # These can take a while so we let the user know what's going on 
+      # These can take a while so we let the user know what's going on
       options[:print_stderr] = true unless options.include?(:print_stderr)
       super
     end
@@ -98,9 +117,9 @@ module Command
       puts @itms.version
     end
   end
-end  
+end
 
-class Email  
+class Email
   Binding = Class.new do
     def initialize(options = {})
       options.each do |k, v|
@@ -109,19 +128,19 @@ class Email
       end
     end
   end
-  
+
   def initialize(config = {})
     unless config["to"]
-      raise "No email recipeints provided, you must specify at least one" 
+      raise "No email recipeints provided, you must specify at least one"
     end
 
     @config = config
   end
-  
-  def send(params = {})    
+
+  def send(params = {})
     to      = @config["to"].to_s.split /,/
     host    = @config["host"] || "localhost"
-    from    = @config["from"] || "#{ENV["USER"]}@#{host}"
+    from    = @config["from"] || "#{user}@#{host}"
     params  = params.merge(@config)
     message = ::ERB.new(build_template).def_class(Binding).new(params).result
 
@@ -132,6 +151,10 @@ class Email
   end
 
   protected
+  def user
+    ENV["USER"] || ENV["USERNAME"]
+  end
+
   def build_template
     %w[to from subject cc bcc].inject("") do |t, key|
       t << "#{key}: #{@config[key]}\n" if @config[key]
@@ -141,7 +164,7 @@ class Email
 end
 
 COMMANDS = ITunes::Store::Transporter.instance_methods(false).map(&:to_s)
-RC_FILE_NAME = ".itms"
+CONFIG_FILE_NAME = ".itms"
 
 def home
   ENV["HOME"] || ENV["USERPROFILE"]
@@ -149,28 +172,28 @@ end
 
 # Should probably create a class for the options
 def load_config(command)
-  config = {}
-  return config unless home
+  return {} unless home
+
+  path = File.join(home, CONFIG_FILE_NAME)
+  return {} unless File.file?(path)
 
-  path = File.join(home, RC_FILE_NAME)
-  return config unless File.file?(path)
+  config = YAML.load_file(path)
+  return {} unless config
 
-  config = YAML.load_file(path) 
-  
   # Get the global defaults. select() returns an aray on Ruby < 1.9
-  defaults = config.select { |k,v| !v.is_a?(Hash) } 
-  defaults = Hash[defaults] unless defaults.is_a?(Hash) 
+  defaults = config.select { |k,v| !v.is_a?(Hash) }
+  defaults = Hash[defaults] unless defaults.is_a?(Hash)
 
   config[command] = defaults.merge(config[command] || {})
-  
+
   # Normalize the email config
   email = Hash.new { |h, k| h[k] = {} }
 
-  %w[success failure].each do |type|  
-    email[type] = (config[command]["email"] ||= {})[type]    
+  %w[success failure].each do |type|
+    email[type] = (config[command]["email"] ||= {})[type]
     next unless email[type]
 
-    # Merge the global email options & the command's "global" options with the success/failure options 
+    # Merge the global email options & the command's "global" options with the success/failure options
     settings = (config["email"].to_a + config[command]["email"].to_a).reject { |k, v| k == "success" or k == "failure" }
     settings.each do |k, v|
       email[type][k] = email[type][k] ? "#{email[type][k]}, #{v}" : v
@@ -178,9 +201,9 @@ def load_config(command)
   end
 
   # ITunes::Store::Transporter uses Symbols for options
-  config[command] = config[command].inject({}) do |cfg, (k,v)| 
+  config[command] = config[command].inject({}) do |cfg, (k,v)|
     cfg[k.to_sym] = v unless k.empty? # Avoid intern empty string errors in 1.8
-    cfg 
+    cfg
   end
 
   config[command][:email] = email
@@ -206,19 +229,24 @@ command = ARGV.shift
 abort("usage: itms command [options]") unless command
 abort("invalid command '#{command}', valid commands are: #{COMMANDS.sort.join(', ')}") unless COMMANDS.include?(command)
 
-options = load_config(command)
+options = ARGV.delete("--no-config") ? {} : load_config(command)
 
-while ARGV.any?   
+while ARGV.any?
   opt = ARGV.first.dup
   break unless opt.sub!(/\A--(?=\w)/, "")
-  
+
   key, val = opt.split(/=/, 2)
   key.gsub!(/-/, "_")
-  # TODO: false, --no-xxxx
-  val = true unless val
-  val = val.to_i if val =~ /\A\d+\z/                         
-  options[key.to_sym] = val                        
-  ARGV.shift                         
+
+  if val
+    val = val.to_i if val =~ /\A\d+\z/
+  else
+    # Boolean option
+    val = key.sub!(/\Ano_(?=\w)/, "") ? false : true
+  end
+
+  options[key.to_sym] = val
+  ARGV.shift
 end
 
 # Keys for this are strings
@@ -227,11 +255,11 @@ command_options = options.dup
 options[:argv] = ARGV.dup
 options[:command] = command
 
-begin 
-  puts "Running command '#{command}'"
+begin
+  puts "Running command '#{command}'\n\n"
   Command.execute(command, command_options, ARGV)
   send_email(email_options["success"], options)
-rescue ITunes::Store::Transporter::ExecutionError => e 
+rescue ITunes::Store::Transporter::ExecutionError => e
   print_errors(e)
   options[:error] = e
   send_email(email_options["failure"], options)
@@ -240,4 +268,3 @@ rescue ITunes::Store::Transporter::TransporterError => e
   $stderr.puts e
   exit 2
 end
-

data/lib/itunes/store/transporter.rb

@@ -1,4 +1,3 @@
-require "itunes/store/transporter/command"
 require "itunes/store/transporter/command/lookup"
 require "itunes/store/transporter/command/providers"
 require "itunes/store/transporter/command/schema"

data/lib/itunes/store/transporter/command.rb

@@ -1,5 +1,4 @@
 require "optout"
-require "itunes/store/transporter"
 require "itunes/store/transporter/shell"
 require "itunes/store/transporter/errors"
 require "itunes/store/transporter/output_parser"
@@ -9,7 +8,7 @@ module ITunes
   module Store
     class Transporter
       module Command            # :nodoc: all
-        
+
         class Base
           include Option
 
@@ -18,13 +17,13 @@ module ITunes
             @shell = Shell.new(@config[:path])
             @default_options = default_options
           end
-          
+
           def run(options = {})
             options = default_options.merge(options)
             argv = create_transporter_options(options)
             stdout_lines = []
             stderr_lines = []
-           
+
             # TODO: hooks
             exitcode = @shell.exec(argv) do |line, name|
               if name == :stdout
@@ -46,13 +45,13 @@ module ITunes
           protected
           attr :config
           attr :default_options
-          
+
           def options
             @options ||= Optout.options do
               # On Windows we must include this else the Transporter batch script will call `pause` after the Transporter exits
-              on :windows, "-WONoPause"                           
+              on :windows, "-WONoPause"
               # Optout can't do this: [a, b, c] => -X a -X b -X c
-              on :jvm, "-X" #, :multiple => true           
+              on :jvm, "-X" #, :multiple => true
             end
           end
 
@@ -60,38 +59,38 @@ module ITunes
           def handle_success(stdout_lines, stderr_lines, options)
             stdout_lines.join
           end
-          
+
           def handle_error(stdout_lines, stderr_lines, options, exitcode)
-            parser = Transporter::OutputParser.new(stderr_lines)
+            parser = OutputParser.new(stderr_lines)
             errors = parser.errors.any? ? parser.errors : [ TransporterMessage.new(stderr_lines.join) ]
-            raise ITunes::Store::Transporter::ExecutionError.new(errors, exitcode)
+            raise ExecutionError.new(errors, exitcode)
           end
-          
+
           def create_transporter_options(optz)
-            optz[:windows] = "true" if Transporter::Shell.windows?            
+            optz[:windows] = "true" if Shell.windows?
             options.argv(optz)
           rescue Optout::OptionError => e
-            raise ITunes::Store::Transporter::OptionError, e.message
+            raise OptionError, e.message
           end
         end
-      
+
         class Mode < Base
-          def initialize(*config)          
-            super 
+          def initialize(*config)
+            super
             options.on :log, "-o", Optout::File
-            options.on :verbose, "-v", %w|informational critical detailed eXtreme| # Since log output is critical to determining what's going on we can't include "off" 
+            options.on :verbose, "-v", %w|informational critical detailed eXtreme| # Since log output is critical to determining what's going on we can't include "off"
+            options.on :summary, "-summaryFile", Optout::File
+            options.on :mode, "-m", /\w+/, :required => true
             options.on :username, "-u", :required => true
             options.on :password, "-p", :required => true
-            options.on :summary, "-summaryFile", Optout::File
-            options.on :mode, "-m", /\w+/, :required => true    
             options.on *SHORTNAME
           end
-        
+
           def create_transporter_options(optz)
             optz[:mode] = mode
             super
           end
-        
+
           def mode
             self.class.to_s.split("::")[-1].gsub(/([a-z])([A-Z])/, "\1_\2").downcase
           end
@@ -100,4 +99,4 @@ module ITunes
       end
     end
   end
-end  
+end