itunes_store_transporter 0.0.1

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

@@ -0,0 +1,103 @@
+require "optout"
+require "itunes/store/transporter"
+require "itunes/store/transporter/shell"
+require "itunes/store/transporter/errors"
+require "itunes/store/transporter/output_parser"
+require "itunes/store/transporter/command/option"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command            # :nodoc: all
+        
+        class Base
+          include Option
+
+          def initialize(config, default_options = {})
+            @config = config
+            @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
+                stdout_lines << line
+                $stdout.puts line if config[:print_stdout]
+              else
+                stderr_lines << line
+                $stderr.puts line if config[:print_stderr]
+              end
+            end
+
+            if exitcode == 0
+              handle_success(stdout_lines, stderr_lines, options)
+            else
+              handle_error(stdout_lines, stderr_lines, options, exitcode)
+            end
+          end
+
+          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"                           
+              # Optout can't do this: [a, b, c] => -X a -X b -X c
+              on :jvm, "-X" #, :multiple => true           
+            end
+          end
+
+          # TODO: conf[:warnings]
+          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)
+            errors = parser.errors.any? ? parser.errors : [ TransporterMessage.new(stderr_lines.join) ]
+            raise ITunes::Store::Transporter::ExecutionError.new(errors, exitcode)
+          end
+          
+          def create_transporter_options(optz)
+            optz[:windows] = "true" if Transporter::Shell.windows?            
+            options.argv(optz)
+          rescue Optout::OptionError => e
+            raise ITunes::Store::Transporter::OptionError, e.message
+          end
+        end
+      
+        class Mode < Base
+          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 :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
+        end
+
+      end
+    end
+  end
+end  

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

@@ -0,0 +1,55 @@
+require "fileutils"
+require "itunes/store/transporter/errors"
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command
+
+        ##
+        # Retrieve the metadata for a previously delivered package.  
+        #
+        class Lookup < Mode
+          def initialize(*config)
+            super
+            # These 2 are mutually exclusive, and one is required. 
+            # Optout has no way to denote this
+            options.on *VENDOR_ID
+            options.on *APPLE_ID
+            options.on *DESTINATION
+          end
+
+          def run(options = {})
+            options[:destination] = Dir.mktmpdir
+            super 
+          ensure
+            FileUtils.rm_rf(options[:destination])
+          end
+
+          protected
+          def handle_success(stdout_lines, stderr_lines, options)
+            id = options[:apple_id] || options[:vendor_id]
+            path = File.join(options[:destination], "#{id}.itmsp", "metadata.xml")
+
+            if !File.exists?(path)
+              raise ITunes::Store::Transporter::TransporterError, "No metadata file exists at #{path}"
+            end
+
+            begin 
+              metadata = File.read(path) 
+            rescue StandardError => e
+              raise ITunes::Store::Transporter::TransporterError, "Failed to read metadata file #{path}: #{e}"
+            end
+
+            metadata
+          end
+
+          def mode
+            "lookupMetadata"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require "optout"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command
+        module Option
+          # Common command options
+          VENDOR_ID   = [ :vendor_id, "-vendor_id", /\w/ ]
+          APPLE_ID    = [ :apple_id, "-apple_id", /\w/ ]
+          SHORTNAME   = [ :shortname, "-s", /\w/ ]
+          TRANSPORT   = [ :transport, "-t", %w|Aspera Signiant DAV| ]
+          SUCCESS     = [ :success, "-success", Optout::Dir.exists ]
+          FAILURE     = [ :failure, "-failure", Optout::Dir.exists ]         
+          PACKAGE     = [ :package, "-f", Optout::Dir.exists.named(/\.itmsp\z/), { :required => true } ]
+          DESTINATION = [ :destination, "-destination" ]          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command
+
+        ##
+        # List of Providers for whom your account is authorzed to deliver for.
+        #
+        class Providers < Mode
+          protected
+          def mode
+            "provider"
+          end
+                    
+          def handle_success(stdout_lines, stderr_lines, options)
+            providers = []
+            stdout_lines.each do |line|
+              line.chomp!
+              if line =~ /\A\d+\s+(.+?)\s+(\w+)\Z/
+                provider = {}
+                provider[:longname] = $1
+                provider[:shortname] = $2
+                providers << provider
+              end
+            end
+
+            providers
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command
+        
+        ##
+        # Download a RelaxNG schema file for a particular metadata specification.
+        #
+
+        class Schema < Mode
+          def initialize(*config)
+            super
+            options.on *DESTINATION
+            options.on :type, "-schemaType", /\A(transitional|strict)\z/i, :required => true
+            options.on :version, "-schema", /\w+/i, :required => true
+          end
+          
+          protected
+          def mode
+            "generateSchema"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command            # :nodoc:
+        
+        ##
+        # Retrieve the status of a previously uploaded package
+        #
+        class Status < Mode
+          def initialize(*config)
+            super
+            options.on *VENDOR_ID
+          end
+
+          protected 
+          def handle_success(stdout_lines, stderr_lines, options) 
+            status = {}
+            stdout_lines.each do |line|
+              next unless line =~ /\A\s*\w/
+              key, value = line.split(/:\s+/, 2).map(&:strip)
+              key.gsub!(/\s+/, "_")
+              key.downcase!
+              status[key.to_sym] = value
+            end
+            status
+          end
+        end        
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "optout"
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command            # :nodoc: all
+
+        ##
+        # Upload a package to the iTunes Store
+        #
+        class Upload < Mode
+          def initialize(*config)
+            super
+            options.on *PACKAGE
+            options.on *TRANSPORT
+            options.on *SUCCESS
+            options.on *FAILURE
+            options.on :delete, "-delete", Optout::Boolean
+            options.on :rate, "-k", Integer  # Required if TRANSPORT is Aspera or Signiant 
+            options.on :log_history, "-loghistory", Optout::Dir.exists
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require "optout"
+require "itunes/store/transporter/errors"
+require "itunes/store/transporter/command"
+require "itunes/store/transporter/output_parser"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command            # :nodoc:
+
+        ##
+        # Validate the contents of a package's metadata and assets.
+        #
+
+        class Verify < Mode
+          def initialize(*config)
+            super
+            options.on *PACKAGE
+            options.on :verify_assets, "-disableAssetVerification", Optout::Boolean  # If false verify MD only no assets
+          end
+
+          protected
+          # Verify mode returns 0 if there are no packages to verify but will emit an error message about the lack of packages
+          def handle_success(stdout_lines, stderr_lines, options)
+            parser = Transporter::OutputParser.new(stderr_lines)
+            if parser.errors.any?
+              raise ITunes::Store::Transporter::ExecutionError.new(parser.errors, 0)
+            else
+              true
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,30 @@
+require "itunes/store/transporter/command"
+
+module ITunes
+  module Store
+    class Transporter
+      module Command            # :nodoc: all
+        
+        ## 
+        # Return the +iTMSTransporter+ version.
+        #
+        class Version < Base
+          def initialize(*config)
+            super
+            options.on :version, "-version"
+          end
+
+          protected
+          def create_transporter_options(optz)
+            optz[:version] = true
+            super
+          end
+          
+          def handle_success(stdout_lines, stderr_lines, options)
+            super =~ /version\s+(\d+(?:\.\d+)*)\b/i ? $1 : "Unknown"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+
+module ITunes
+  module Store      
+    class Transporter
+
+      class TransporterError < StandardError; end
+      class OptionError < TransporterError; end
+      
+      class ExecutionError < TransporterError
+        attr :errors
+        attr :exitstatus        
+        
+        def initialize(errors, exitstatus = nil)
+          @errors = [ errors ].flatten
+          @exitstatus = exitstatus
+          super @errors.map { |e| e.to_s }.join ", "
+        end         
+      end
+      
+      class TransporterMessage
+        attr :code
+        attr :message
+        
+        def initialize(message, code = nil)
+          @message = message
+          @code = code
+        end
+
+        # 1000...2000?
+        
+        def bad_data?
+          (3000...4000).include?(code)
+        end
+
+        def invalid_data?
+          (4000...5000).include?(code)
+        end
+
+        def missing_data?
+          (5000...6000).include?(code)
+        end
+
+        def unsupported_feature?
+          (6000...7000).include?(code)
+        end
+
+        def schema_error?
+          (8000...9000).include?(code)
+        end
+
+        def asset_error?
+          (9000...10_000).include?(code)
+        end
+
+        def validation_error?
+          (3000...10_000).include?(code)
+        end
+
+        def to_s
+          s = message.dup
+          s << " (#{code})" if code
+          s
+        end
+      end
+    end
+  end
+end