deliver 0.0.1 → 0.1.0

data/lib/deliver/itunes_search_api.rb

@@ -0,0 +1,48 @@
+require 'open-uri'
+
+module Deliver
+  # A wrapper around the Apple iTunes Search API to access app information like
+  # the app identifier of an app.
+  class ItunesSearchApi
+
+    # Fetch all information you can get from a specific AppleID of an app
+    # @param id (int) The AppleID of the given app. This usually consists of 9 digits.
+    # @return (Hash) the response of the first result from Apple (https://itunes.apple.com/lookup?id=284882215)
+    # @example Response of Facebook App: https://itunes.apple.com/lookup?id=284882215
+    #  { 
+    #   ...
+    #   artistName: "Facebook, Inc.",
+    #   price: 0,
+    #   version: "14.9",
+    #   ...
+    #  }
+    def self.fetch(id)
+      # Example: https://itunes.apple.com/lookup?id=284882215
+      fetch_url("https://itunes.apple.com/lookup?id=#{id.to_s}")
+    end
+
+    def self.fetch_by_identifier(app_identifier)
+      # Example: http://itunes.apple.com/lookup?bundleId=net.sunapps.1
+      fetch_url("https://itunes.apple.com/lookup?bundleId=#{app_identifier}")
+    end
+      
+
+    # This method only fetches the bundle identifier of a given app
+    # @param id (int) The AppleID of the given app. This usually consists of 9 digits.
+    # @return (String) the Bundle identifier of the app
+    def self.fetch_bundle_identifier(id)
+      self.fetch(id)['bundleId']
+    end
+
+    private
+      def self.fetch_url(url)
+        response = JSON.parse(open(url).read)
+        return nil if response['resultCount'] == 0
+
+        return response['results'].first
+      rescue
+        Helper.log.error "Could not find object '#{url}' using the iTunes API"
+        nil
+      end
+  end
+end

data/lib/deliver/itunes_transporter.rb

@@ -0,0 +1,154 @@
+require 'pty'
+
+require 'deliver/password_manager'
+
+
+module Deliver
+  # The TransporterInputError occurs when you passed wrong inputs to the {Deliver::ItunesTransporter}
+  class TransporterInputError < StandardError 
+  end
+  # The TransporterTransferError occurs when some error happens
+  # while uploading or downloading something from/to iTC
+  class TransporterTransferError < StandardError
+  end
+
+  class ItunesTransporter
+    ERROR_REGEX = />\s*ERROR:\s+(.+)/  
+    WARNING_REGEX = />\s*WARN:\s+(.+)/
+    OUTPUT_REGEX = />\s+(.+)/
+
+    private_constant :ERROR_REGEX, :WARNING_REGEX, :OUTPUT_REGEX
+    
+    # Returns a new instance of the iTunesTranspoter.
+    # If no username or password given, it will be taken from
+    # the #{Deliver::PasswordManager}
+    def initialize(user = nil, password = nil)
+      @user = (user || PasswordManager.new.username)
+      @password = (password || PasswordManager.new.password)
+    end
+
+    # Downloads the latest version of the app metadata package from iTC.
+    # @param app [Deliver::App] The app you want to download the data for
+    # @param dir [String] the path to the package file
+    # @return (Bool) True if everything worked fine
+    # @raise [Deliver::TransporterTransferError] when something went wrong
+    #   when transfering
+    # @raise [Deliver::TransporterInputError] when passing wrong inputs
+    def download(app, dir = nil)
+      raise TransporterInputError.new("No valid Deliver::App given") unless app.kind_of?Deliver::App
+
+      Helper.log.info "Going to download app metadata from iTunesConnect"
+      dir ||= app.get_metadata_directory
+      command = build_download_command(@user, @password, app.apple_id, dir)
+
+      result = execute_transporter(command)
+
+      if result
+        Helper.log.info "Successfully downloaded the latest package from iTunesConnect.".green
+      end
+
+      result
+    end
+
+    # Uploads the modified package back to iTunesConnect
+    # @param app [Deliver::App] The app you want to download the data for
+    # @param dir [String] the path in which the package file is located
+    # @return (Bool) True if everything worked fine
+    # @raise [Deliver::TransporterTransferError] when something went wrong
+    #   when transfering
+    # @raise [Deliver::TransporterInputError] when passing wrong inputs
+    def upload(app, dir)
+      raise TransporterInputError.new("No valid Deliver::App given") unless app.kind_of?Deliver::App
+
+      dir ||= app.get_metadata_directory
+      dir += "/#{app.apple_id}.itmsp"
+
+      Helper.log.info "Going to upload updated app to iTunesConnect"
+      
+      command = build_upload_command(@user, @password, dir)
+      result = execute_transporter(command)
+
+      if result
+        Helper.log.info "Successfully uploaded package to iTunesConnect. It might take a few minutes until it's visible online.".green
+      end
+
+      result
+    end
+
+    private
+      def execute_transporter(command)
+        @errors = []
+        @warnings = []
+
+        begin
+          PTY.spawn(command) do |stdin, stdout, pid|
+            stdin.each do |line|
+              parse_line(line) # this is where the parsing happens
+            end
+          end
+        rescue Exception => ex
+          Helper.log.fatal(ex.to_s)
+          @errors << ex.to_s
+        end
+
+        if @errors.count > 0
+          raise TransporterTransferError.new(@errors.join("\n"))
+        end
+
+        if @warnings.count > 0
+          Helper.log.warn(@warnings.join("\n"))
+        end
+
+        true
+      end
+
+      def parse_line(line)
+        # Taken from https://github.com/sshaw/itunes_store_transporter/blob/master/lib/itunes/store/transporter/output_parser.rb
+
+        if line =~ ERROR_REGEX
+          @errors << $1
+
+          # Check if it's a login error
+          if $1.include?"Your Apple ID or password was entered incorrectly" or
+             $1.include?"This Apple ID has been locked for security reasons"
+
+            Deliver::PasswordManager.new.password_seems_wrong
+          end
+
+        elsif line =~ WARNING_REGEX
+          @warnings << $1
+        end
+
+        if line =~ OUTPUT_REGEX
+          # General logging for debug purposes
+          Helper.log.debug "[Transpoter Output]: #{$1}"
+        end
+      end
+
+      def build_download_command(username, password, apple_id, destination = "/tmp")
+        [
+          Helper.transporter_path,
+          "-m lookupMetadata",
+          "-u \"#{username}\"",
+          "-p '#{escaped_password(password)}'",
+          "-apple_id #{apple_id}",
+          "-destination '#{destination}'"
+        ].join(' ')
+      end
+
+      def build_upload_command(username, password, source = "/tmp")
+        [
+          Helper.transporter_path,
+          "-m upload",
+          "-u \"#{username}\"",
+          "-p '#{escaped_password(password)}'",
+          "-f '#{source}'"
+        ].join(' ')
+      end
+
+      def escaped_password(password)
+        password.gsub('$', '\\$')
+      end
+
+  end
+end

data/lib/deliver/languages.rb

@@ -0,0 +1,6 @@
+module Deliver
+  module Languages
+    # These are all the languages which are available to use to upload app metadata and screenshots
+    ALL_LANGUAGES = ["da-DK", "de-DE", "el-GR", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi-FI", "fr-CA", "fr-FR", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "no-NO", "pt-BR", "pt-PT", "ru-RU", "sv-SE", "th-TH", "tr-TR", "vi-VI", "cmn-Hans", "zh_CN", "cmn-Hant"]
+  end
+end

data/lib/deliver/metadata_item.rb

@@ -0,0 +1,94 @@
+require 'nokogiri'
+
+module Deliver
+  # This class represents a file, included in the metadata.xml
+  # 
+  # It takes care of calculating the file size and md5 value.
+  class MetadataItem
+    # @return [String] The path to this particular asset
+    attr_accessor :path
+
+    # Returns a new instance of MetadataItem
+    # @param path [String] the path to the real world file
+    # @param custom_node_name [String] You can set a custom name
+    #  for the newly created node.
+    def initialize(path, custom_node_name = nil)
+      raise "File not found at path '#{path}'" unless File.exists?path
+
+      self.path = path
+      @custom_node_name = custom_node_name
+    end
+
+    # This method is called when storing this item into the metadata.xml file
+    # 
+    # This method will calculate the md5 hash and exact file size
+    # Generates XML code that looks something like this
+    # +code+
+    #   <data_file>
+    #     <size>11463227</size>
+    #     <file_name>myapp.54.56.ipa</file_name>
+    #     <checksum type="md5">9d6b7b0e20bde9a3c831db89563e949f</checksum>
+    #   </data_file>
+    # Take a look at the subclass {Deliver::AppScreenshot#create_xml_node} for a
+    # screenshot specific implementation
+    # @param doc [Nokogiri::XML::Document] The document this node
+    #  should be added to
+    # @return [Nokogiri::XML::Node] the resulting XML node
+    def create_xml_node(doc)
+      screenshot = Nokogiri::XML::Node.new(name_for_xml_node, doc)
+
+      node_set = Nokogiri::XML::NodeSet.new(doc)
+      
+      # File Size
+      size = Nokogiri::XML::Node.new('size', doc)
+      size.content = File.size(self.path)
+      node_set << size
+
+      # File Name
+      file_name = Nokogiri::XML::Node.new('file_name', doc)
+      file_name.content = resulting_file_name
+      node_set << file_name
+
+      # md5 Checksum
+      checksum = Nokogiri::XML::Node.new('checksum', doc)
+      checksum.content = md5_value
+      checksum['type'] = 'md5'
+      node_set << checksum
+
+
+      screenshot.children = node_set
+
+      return screenshot
+    end
+
+    # We also have to copy the file itself, since it has to be *inside* the package
+    # You don't have to call this method manually.
+    def store_file_inside_package(path_to_package)
+      # This will also rename the resulting file to not have any spaces or other
+      # illegal characters in the file name
+      
+      FileUtils.cp(self.path, "#{path_to_package}/#{resulting_file_name}")
+    end
+
+    private
+      def name_for_xml_node
+        @custom_node_name || 'data_file'
+      end
+
+      # The file name which is used inside the package
+      def resulting_file_name
+        extension = File.extname(self.path)
+        "#{file_name_for_element}#{extension}"
+      end
+
+      def md5_value
+        Digest::MD5.hexdigest(File.read(self.path))
+      end
+
+      # This method will also take some other things into account to generate a truly unique
+      # file name. This will enable using the same screenshots multiple times
+      def file_name_for_element
+        Digest::MD5.hexdigest([File.read(self.path), self.path].join("-"))
+      end
+  end
+end

data/lib/deliver/password_manager.rb

@@ -0,0 +1,86 @@
+require 'security'
+require 'highline/import' # to hide the entered password
+
+module Deliver
+  # Handles reading out the password from the keychain or asking for login data
+  class PasswordManager
+    # @return [String] The username / email address of the currently logged in user
+    attr_accessor :username
+    # @return [String] The password of the currently logged in user
+    attr_accessor :password
+
+    HOST = "itunesconnect.apple.com"
+    private_constant :HOST
+
+    # A new instance of PasswordManager.
+    # 
+    # This already check the Keychain if there is a username and password stored.
+    # If that's not the case, it will ask for login data via stdin
+    def initialize
+      self.username ||= ENV["DELIVER_USER"] || load_from_keychain[0]
+      self.password ||= ENV["DELIVER_PASSWORD"] || load_from_keychain[1]
+
+      if (self.username || '').length == 0 or (self.password || '').length == 0
+        puts "No username or password given. You can set environment variables:"
+        puts "DELIVER_USER, DELIVER_PASSWORD"
+
+        ask_for_login
+      end
+    end
+
+    # This method is called, when the iTunes backend returns that the login data is wrong
+    # This will ask the user, if he wants to re-enter the password
+    def password_seems_wrong
+      return false if Helper.is_test?
+      
+      puts "It seems like the username or password for the account '#{self.username}' is wrong."
+      reenter = agree("Do you want to re-enter your username and password? (y/n)", true)
+      if reenter
+        @username = nil
+        @password = nil
+        remove_from_keychain
+
+        puts "You will have to re-run the recent command to use the new username/password."
+        return true
+      else
+        return false
+      end
+    end
+
+    private
+      def ask_for_login
+        puts "--------------------------------------------------------------------------".green
+        puts "The login information you enter now will be stored in your keychain       ".green
+        puts "More information about that on GitHub: https://github.com/krausefx/deliver".green
+        puts "--------------------------------------------------------------------------".green
+
+        while (self.username || '').length == 0
+          self.username = ask("Username: ")
+        end
+
+        while (self.password || '').length == 0
+          self.password = ask("Password: ") { |q| q.echo = "*" }
+        end
+
+        # Now we store this information in the keychain
+        # Example usage taken from https://github.com/nomad/cupertino/blob/master/lib/cupertino/provisioning_portal/commands/login.rb
+        if Security::InternetPassword.add(HOST, self.username, self.password)
+          return true
+        else
+          Helper.log.error "Could not store password in keychain"
+          return false
+        end
+      end
+
+      def remove_from_keychain
+        Security::InternetPassword.delete(:server => HOST)
+      end
+    
+      def load_from_keychain
+        pass = Security::InternetPassword.find(:server => HOST)
+        
+        return [pass.attributes['acct'], pass.password] if pass
+        return [nil, nil]
+      end
+  end
+end

data/lib/deliver/pdf_generator.rb

@@ -0,0 +1,131 @@
+require 'prawn'
+
+require 'pry'
+
+module Deliver
+  class PdfGenerator
+
+    # Renders all data available in the Deliverer to quickly see if everything was correctly generated.
+    # @param deliverer [Deliver::Deliverer] The deliver process on which based the PDF file should be generated
+    # @param export_path (String) The path to a folder where the resulting PDF file should be stored. 
+    def render(deliverer, export_path = nil)
+      export_path ||= '/tmp'
+      
+      pdf = Prawn::Document.new(:margin => [0, 0, 0, 0])
+      
+      resulting_path = "#{export_path}/#{Time.now.to_i}.pdf"
+      Prawn::Document.generate(resulting_path) do
+
+        counter = 0
+        deliverer.app.metadata.information.each do |language, content|
+          title = content[:title][:value] rescue ''
+
+          Helper.log.info("[PDF] Exporting locale '#{language}' for app with title '#{title}'")
+
+          font_size 20
+          text "#{language}: #{title}"
+          stroke_horizontal_rule
+          font_size 14
+
+          move_down 30
+
+
+
+          col1 = 200
+          modified_color = '0000AA'
+          standard_color = '000000'
+
+
+          prev_cursor = cursor.to_f
+          # Description on right side
+          bounding_box([col1, cursor], width: 340.0) do
+            if content[:description] and content[:description][:value]
+              text content[:description][:value], size: 6, color: (content[:description][:modified] ? modified_color : standard_color)
+            end
+            move_down 10
+            stroke_horizontal_rule
+            move_down 10
+            text "Changelog:", size: 8
+            move_down 5
+            if content[:version_whats_new] and content[:version_whats_new][:value]
+              text content[:version_whats_new][:value], size: 6, color: (content[:version_whats_new][:modified] ? modified_color : standard_color)
+            end
+          end
+          title_bottom = cursor.to_f
+
+          move_cursor_to prev_cursor
+
+
+          all_keys = [:support_url, :privacy_url, :software_url, :keywords]
+
+          all_keys.each_with_index do |key, index|
+            value = content[key][:value] rescue nil
+            
+            color = (content[key][:modified] ? modified_color : standard_color rescue standard_color)
+
+            bounding_box([0, cursor], width: col1) do
+              key = key.to_s.gsub('_', ' ').capitalize
+
+              width = 200
+              size = 10
+
+              if value.kind_of?Array
+                # Keywords only
+                text "#{key}:", color: color, width: width, size: size
+                move_down 2
+
+                keywords_padding_left = 5
+                bounding_box([keywords_padding_left, cursor], width: (col1 - keywords_padding_left)) do
+                  value.each do |item|
+                    text "- #{item}", color: color, width: width, size: (size - 2)
+                  end
+                end
+              else
+                # Everything else
+                next if value == nil or value.length == 0
+                
+                text "#{key}: #{value}", color: color, width: width, size: size
+              end
+            end
+          end
+
+          image_width = 60
+          padding = 10
+          last_size = nil
+          top = [cursor, title_bottom].min - padding
+          index = 0
+          previous_image_height = 0
+          if (content[:screenshots] || []).count > 0
+            content[:screenshots].sort{ |a, b| a.screen_size <=> b.screen_size }.each do |screenshot|
+              
+              if last_size and last_size != screenshot.screen_size
+                # Next row (other simulator size)
+                top -= (previous_image_height + padding)
+                index = 0
+              end
+
+              image screenshot.path, width: image_width, 
+                                        at: [(index * (image_width + padding)), top]
+
+              original_size = FastImage.size(screenshot.path)
+              previous_image_height = (image_width.to_f / original_size[0].to_f) * original_size[1].to_f
+
+              last_size = screenshot.screen_size
+              index += 1
+            end
+          else
+            move_cursor_to top
+            text "No screenshots passed. Is this correct? They will get removed from iTunesConnect."
+          end
+
+          counter += 1
+          if counter < deliverer.app.metadata.information.count
+            start_new_page
+          end
+        end
+      end
+
+      return resulting_path
+    end
+  end
+end