itunes_store_transporter 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 603cbf0b2fe54965a1fcd25315fc2434f9987188
-  data.tar.gz: 4c197138304f80f540f508c8a8f09910532ceef6
+  metadata.gz: 1706c7254e4158ee42930c52f11f48bd22ddb409
+  data.tar.gz: fb2b7760daa79915b5628f3631b622a4d978b375
 SHA512:
-  metadata.gz: 57b4de9c4cc1571829c9151ec91e8b0773d094299454252ff40d348faed32100d65e242a1dcd322c014347d4167e5c9a3f93a6373e3ba7f7e8578d1ebda769af
-  data.tar.gz: 812887659a510890d27f5e4a497b96463dca4ffe371e281e9be9b50a613e0bff3d2cd4a2df53eae8b82bd395ec4990f5240a6639b22b986efe58d975fb829809
+  metadata.gz: 2fb763cde86787bb12b99fdf3e1cebf2e7213d0458cccef43f9c17edbf8903ca32244829d403672ce813f5027c93882b8635a6288f5fb8bdf89645152c934a37
+  data.tar.gz: b3b59d68150bb088732c2c9a6f0822b59e843cdebd7e13a7439c54070baa855bb0e3da3e88fe4a43e39f8215afef7204b8b44253eedaca821132be88b414dd47

data/Changes

@@ -1,7 +1,27 @@
+v0.2.0    2017-02-07
+--------------------
+Changes:
+* Drop support for Ruby 1.8.7
+* Status command returns an Array of Hashes
+* Upload command returns true on success, not the command's output
+
+Enhancements:
+* Support for statusAll mode
+* Status command XML parser
+
+Bug Fixes:
+* Status command only returned a single component status
+
+This release was brought to you by press9 media solutions berlin - http://press9.de.
+Thanks press9!
+
 v0.1.3    2015-03-31
 --------------------
 Enhancements:
-* Add the :batch option to support batch operations (thanks to press9 media solutions berlin - press9.de)
+* Add the :batch option to support batch operations
+
+This release was brought to you by press9 media solutions berlin - http://press9.de.
+Thanks press9!
 
 v0.1.2    2015-03-07
 --------------------

data/README.rdoc

@@ -1,6 +1,7 @@
 = iTunes::Store::Transporter
 
 {<img src="https://secure.travis-ci.org/sshaw/itunes_store_transporter.svg"/>}[http://travis-ci.org/sshaw/itunes_store_transporter]
+{<img src="https://ci.appveyor.com/api/projects/status/k6w6ob5f7s9j8pv8?svg=true"/>}[https://ci.appveyor.com/project/sshaw/itunes-store-transporter]
 {<img src="https://codeclimate.com/github/sshaw/itunes_store_transporter.svg" />}[https://codeclimate.com/github/sshaw/itunes_store_transporter]
 
 Upload and manage your assets in the iTunes Store using the iTunes Store's Transporter (+iTMSTransporter+).
@@ -9,8 +10,8 @@ Upload and manage your assets in the iTunes Store using the iTunes Store's Trans
 
  require "itunes/store/transporter"
 
- itms = iTunes::Store::Transporter.new(:username => "CouchCaster",
-                                       :shortname => "bigtimer",
+ itms = iTunes::Store::Transporter.new(:username => "SomeUser",
+                                       :shortname => "shrt",
                                        :password => "w3c@llYoU!")
 
  itms.upload("/path/to/yourpackage.itmsp")
@@ -165,14 +166,14 @@ As you can see, command options are turned into template variables.
 
 === More Info
 
-* Docs: http://ruby-doc.org/gems/docs/i/itunes_store_transporter-0.1.1/README_rdoc.html
+* Docs: http://www.rubydoc.info/gems/itunes_store_transporter
 * 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
+* Transporter GUI: http://github.com/sshaw/itunes_store_transporter_web
 
 === Author
 
-Skye Shaw [sshaw AT gmail.com]
+Skye Shaw [skye.shaw AT gmail.com]
 
 === License
 

data/lib/itunes/store/transporter.rb

@@ -3,6 +3,7 @@ require "itunes/store/transporter/command/lookup"
 require "itunes/store/transporter/command/providers"
 require "itunes/store/transporter/command/schema"
 require "itunes/store/transporter/command/status"
+require "itunes/store/transporter/command/status_all"
 require "itunes/store/transporter/command/upload"
 require "itunes/store/transporter/command/verify"
 require "itunes/store/transporter/command/version"

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

@@ -35,6 +35,7 @@ module ITunes
               end
             end
 
+            # TODO: problem as some errors exit 0, e.g., account locked
             if exitcode == 0
               handle_success(stdout_lines, stderr_lines, options)
             else
@@ -57,13 +58,14 @@ module ITunes
           end
 
           # TODO: conf[:warnings]
+          # TODO: Need to check for errors here too, 0 doesn't always mean success, e.g., account locked
           def handle_success(stdout_lines, stderr_lines, options)
-            stdout_lines.join
+            stdout_lines.join("\n")
           end
 
           def handle_error(stdout_lines, stderr_lines, options, exitcode)
             parser = OutputParser.new(stderr_lines)
-            errors = parser.errors.any? ? parser.errors : [ TransporterMessage.new(stderr_lines.join) ]
+            errors = parser.errors.any? ? parser.errors : [ TransporterMessage.new(stderr_lines.join("\n")) ]
             raise ExecutionError.new(errors, exitcode)
           end
 

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

@@ -10,10 +10,11 @@ module ITunes
         #
         class Providers < Mode
           protected
+
           def mode
             "provider"
           end
-                    
+
           def handle_success(stdout_lines, stderr_lines, options)
             providers = []
             stdout_lines.each do |line|

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

@@ -4,7 +4,7 @@ module ITunes
   module Store
     module Transporter
       module Command
-        
+
         ##
         # Download a RelaxNG schema file for a particular metadata specification.
         #
@@ -16,8 +16,9 @@ module ITunes
             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

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

@@ -1,4 +1,5 @@
 require "itunes/store/transporter/command"
+require "itunes/store/transporter/xml/status"
 
 module ITunes
   module Store
@@ -6,40 +7,32 @@ module ITunes
       module Command            # :nodoc:
 
         ##
-        # Retrieve the status of a previously uploaded package
+        # Retrieve the most recent status of previously uploaded packages
         #
         class Status < Mode
           def initialize(*config)
             super
-            options.on *VENDOR_ID
+            options.on :vendor_id, "-vendor_ids", /\w/, :multiple => true
+            options.on :apple_id, "-apple_ids", /\w/, :multiple => true
+            options.on :format, "-outputFormat", %w[xml]
           end
 
           protected
-          def handle_success(stdout_lines, stderr_lines, options)
-            status = {}
-            while line = stdout_lines.shift
-              next unless line =~ /\S+/
-              if line =~ /\A--+/
-                entry = {}
-                while line = stdout_lines.shift
-                  break unless line =~ /\A\s*\w/
-                  key, value = parse_line(line)
-                  entry[key] = value
-                end
-                (status[:status] ||= []) << entry
-              else
-                key, value = parse_line(line)
-                status[key] = value
-              end
-            end
-            status
+
+          def create_transporter_options(optz)
+            optz[:format] = "xml"
+            super
           end
 
-          def parse_line(line)
-            key, value = line.split(/:\s+/, 2).map(&:strip)
-            key.gsub!(/\s+/, "_")
-            key.downcase!
-            [key.to_sym, value]
+          def handle_success(stdout_lines, stderr_lines, options)
+            # Pre-XML behavior. Not sure if it should be kept.
+            return [] if stdout_lines.empty?
+
+            begin
+              XML::Status.new.parse(stdout_lines.join(""))
+            rescue ParseError => e
+              raise TransporterError, e.message
+            end
           end
         end
       end

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

@@ -0,0 +1,21 @@
+require "itunes/store/transporter/command/status"
+
+module ITunes
+  module Store
+    module Transporter
+      module Command            # :nodoc:
+
+        ##
+        # Retrieve the full status history of previously uploaded packages
+        #
+        class StatusAll < Status
+          protected
+
+          def mode
+            "statusAll"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,12 @@ module ITunes
             options.on :streams, "-numStreams", Integer  # Only valid if TRANSPORT is Signiant
             options.on :log_history, "-loghistory", Optout::Dir.exists
           end
+
+          protected
+
+          def handle_success(stdout_lines, stderr_lines, options)
+            true
+          end
         end
       end
     end

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

@@ -18,6 +18,7 @@ module ITunes
           end
 
           protected
+
           def create_transporter_options(optz)
             # Include the option if false
             optz[:verify_assets] = !optz[:verify_assets] if optz.include?(:verify_assets)

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

@@ -1,33 +1,34 @@
 
 module ITunes
-  module Store      
+  module Store
     module Transporter
 
       class TransporterError < StandardError; end
       class OptionError < TransporterError; end
-      
+      class ParseError < TransporterError; end
+
       class ExecutionError < TransporterError
         attr :errors
-        attr :exitstatus        
-        
+        attr :exitstatus
+
         def initialize(errors, exitstatus = nil)
           @errors = [ errors ].flatten
           @exitstatus = exitstatus
           super @errors.map { |e| e.to_s }.join ", "
-        end         
+        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

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

@@ -102,7 +102,7 @@ module ITunes
         ##
         # :method: status
         # :call-seq:
-        #   status(options = {})
+        #   status(options)
         #
         # Retrieve the status of a previously uploaded package.
         #
@@ -200,11 +200,18 @@ module ITunes
           end
         end
 
-        %w|lookup providers schema status version|.each do |command|
+        %w|lookup providers schema version|.each do |command|
           define_method(command) { |*options| run_command(command, options.shift) }
         end
 
+        def status(options)
+          options = create_options(options)
+          command = options.delete(:all) ? Command::StatusAll : Command::Status
+          command.new(@config, @defaults).run(options)
+        end
+
         private
+
         def run_command(name, options)
           Command.const_get(name.capitalize).new(@config, @defaults).run(create_options(options))
         end

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

@@ -37,6 +37,7 @@ module ITunes
         end
 
         private
+
         def parse_output(output)
           output.each do |line|
             if line =~ ERROR_LINE

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

@@ -11,8 +11,11 @@ module ITunes
         EXE_NAME = "iTMSTransporter"
         WINDOWS_EXE = "#{EXE_NAME}.CMD"
         DEFAULT_UNIX_PATH = "/usr/local/itms/bin/#{EXE_NAME}"
-        DEFAULT_OSX_PATHS = ["/Developer/Applications/Utilities/Application Loader.app/Contents/MacOS/itms/bin/#{EXE_NAME}",
-                             "/Applications/Xcode.app/Contents/Applications/Application Loader.app/Contents/MacOS/itms/bin/#{EXE_NAME}"]
+
+        OSX_APPLICATION_LOADER_PATHS = [
+          "/Applications/Application Loader.app/Contents/MacOS/itms/bin/#{EXE_NAME}",
+          "/Developer/Applications/Utilities/Application Loader.app/Contents/MacOS/itms/bin/#{EXE_NAME}"
+        ]
 
         class << self
           def windows?
@@ -33,7 +36,17 @@ module ITunes
                 root = ENV["PROGRAMFILES(x86)"] || ENV["PROGRAMFILES"] # Need C:\ in case?
                 File.join(root, "itms", WINDOWS_EXE)
               when osx?
-                DEFAULT_OSX_PATHS.find { |path| File.exist?(path) } || DEFAULT_UNIX_PATH
+                paths = OSX_APPLICATION_LOADER_PATHS.dup
+                root  = `xcode-select --print-path`.chomp rescue ""
+
+                if !root.empty?
+                  ["/Applications/Application Loader.app/Contents/MacOS/itms/bin/#{EXE_NAME}",
+                   "/Applications/Application Loader.app/Contents/itms/bin/#{EXE_NAME}"].each do |path|
+                    paths << File.join(root, "..", path)
+                  end
+                end
+
+                paths.find { |path| File.exist?(path) } || DEFAULT_UNIX_PATH
               else
                 DEFAULT_UNIX_PATH
             end
@@ -76,6 +89,7 @@ module ITunes
         end
 
         private
+
         def poll(stdout, stderr)
           read = [ stdout, stderr ]
 

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

@@ -1,7 +1,7 @@
 module ITunes
   module Store
     module Transporter
-      VERSION = "0.1.3"
+      VERSION = "0.2.0"
     end
   end
 end

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

@@ -0,0 +1,145 @@
+require "rexml/document"
+require "itunes/store/transporter/errors"
+
+module ITunes
+  module Store
+    module Transporter
+      module XML
+
+        ##
+        # XML parser for the status and statusAll commands XML output
+        #
+        class Status
+          NA = "N/A".freeze
+
+          ##
+          #
+          # Parse status or statusAll XML
+          #
+          # === Arguments
+          #
+          # [xml (String|IO)] The XML
+          #
+          # === Errors
+          #
+          # ParseError, ExecutionError
+          #
+          # An ExecutionError is raised if the XML contains iTMSTransporter error messages.
+          #
+          # === Returns
+          #
+          # A Hash representation of the XML output.
+          # Hash keys and values are slightly different (better, I hope) than the
+          # elements and attributes returned by Apple. See the documentation for
+          # ITunes::Store::Transporter::ITMSTransporter#status
+          #
+          def parse(xml)
+            doc = _parse(xml)
+            status = []
+
+            # No elements means there's just text nodes with an error message
+            raise self, doc.root.get_text.to_s unless doc.root.has_elements?
+
+            doc.root.each_element do |e|
+              next unless e.node_type == :element
+              status << upload_status(e)
+            end
+
+            status
+          end
+
+          private
+
+          def _parse(xml)
+            begin
+              doc = REXML::Document.new(xml)
+            rescue REXML::ParseException => e
+              raise ParseError, sprintf("%s, caused by line %s: %s",
+                                        "XML is not well-formed", e.line, e.source.buffer[0..32])
+            # For the other tricks REXML has up its sleeve :)
+            rescue => e
+              raise ParseError, "XML parsing failed: #{e}"
+            end
+
+            raise ParseError, "Invalid XML document: '#{xml[0..32]}'" unless doc.root
+            doc
+          end
+
+          def upload_status(e)
+            {
+              :apple_id => e.attributes["apple_identifier"],
+              :vendor_id => e.attributes["vendor_identifier"],
+              :content_status => content_status(e),
+              :info => upload_info(e)
+            }
+          end
+
+          def upload_info(e)
+            e.get_elements("upload_status_info").map do |info|
+              info.attributes.each_with_object({}) do |(name, value), hash|
+                hash[name.to_sym] = value
+              end
+            end
+          end
+
+          def content_status(e)
+            e = e.get_elements("content_status_info").first
+            return unless e
+
+            {
+              :status => e.attributes["content_status"],
+              :review_status => e.attributes["content_review_status"],
+              :itunes_connect_status => e.attributes["itunes_connect_status"],
+              :store_status => store_status(e),
+              :video_components => video_components(e)
+            }
+          end
+
+          def store_status(e)
+            e = e.get_elements("store_status").first
+            return unless e
+
+            e.attributes.each_with_object({}) do |(name, value), status|
+              status[name.to_sym] = territory_list(value)
+            end
+          end
+
+          def video_components(video)
+            video.get_elements("video_components/video_component").map do |e|
+              hash = { :name => e.attributes["component_name"] }
+
+              [:locale, :status, :delivered].each do |name|
+                value = e.attributes["component_#{name}"]
+                value = nil if value == NA
+                hash[name] = value
+              end
+
+              hash
+            end
+          end
+
+          def territory_list(value)
+            value && value != NA ? value.split(/\s*,\s*/) : []
+          end
+
+          def exception(text)
+            # Some overlap here with OutputParser, may want to create ErrorParser
+            text.sub!(/^\s*Error Summary\s*/, "")
+            text.strip!
+
+            errors = text.split(/\n\s*/).map do |line|
+              message, code = line, nil
+              if message =~ /(.+)\((-?\d+)\)\Z/
+                message, code = $1, $2.to_i
+              end
+
+              TransporterMessage.new(message.strip, code)
+            end
+
+            ExecutionError.new(errors)
+          end
+        end
+      end
+    end
+  end
+end