deliver 0.7.13 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0add76bf74f163777d037b134df460f0302c05e7
-  data.tar.gz: 9faf0e247f17458e9e621a624e8954d66138cb46
+  metadata.gz: 9e8b78f5d2bd18344f491a53d2d2097137ca6ea5
+  data.tar.gz: a30ebf40d66983d4b1aec2a9050ffe3c33a29223
 SHA512:
-  metadata.gz: 9acc3f5094509eb5d922ffb9ef23c0669509b7f048f44fba5a77b52d4fd33fe1b0f178b8116ad00435c8990fa8fbf3b9db54142a0c901e95fca2d52ed89229ab
-  data.tar.gz: 1d02d552eca8085f8e02b92715f86d663912fa065c1853548a0a4b9549dc71fd406fcc365a20ab91e51c6516974e66af85c733a40aee89fcc83a2476ea5202f8
+  metadata.gz: e5ef73826eb558bd5c47b7ce1d63af2b1f94a980a72769af7b1145444f403edd0fc1e7dbdd5b0e84ccd88148fd5bf367f7ab5824cd82bbd56591f59f2f9c1844
+  data.tar.gz: 5f86527190c1e4457203d97652f4b301716e6b435eb746c20333c866dabc8f94f2c070152903c207d4e52130179eba8fce82b0c945511bfa34fbf8ba63857c23

data/README.md

@@ -151,6 +151,9 @@ All available commands with a short description can be found in [Deliverfile.md]
 
 Here are a few examples:
 #### Upload screenshots to iTunes Connect
+
+Remove the rest, and use just this format for your ```Deliverfile```.
+
 ```ruby
 app_identifier "net.sunapps.1"
 version "1.1"
@@ -304,7 +307,7 @@ A detailed description about your credentials is available on a [seperate repo](
 
 `deliver` is fully open source, you can take a look at its source files. It will only modify the content you want to modify using the ```Deliverfile```. Your password will be stored in the Mac OS X keychain, but can also be passed using environment variables.
 
-Before actually uploading anything to iTunes, ```Deliver``` will generate a [PDF summary](https://github.com/krausefx/deliver/blob/master/assets/PDFExample.png?raw=1) of the collected data. 
+Before actually uploading anything to iTunes, ```deliver``` will generate a [PDF summary](https://github.com/krausefx/deliver/blob/master/assets/PDFExample.png?raw=1) of the collected data. 
 
 ```deliver``` uses the following techniques under the hood:
 

data/lib/assets/DeliverfileDefault

@@ -1,4 +1,4 @@
-# For more information about each property, visit the GitHub documentation: https://github.com/krausefx/deliver
+# For more information visit the GitHub documentation: https://github.com/krausefx/deliver
 # Everything next to a # is a comment and will be ignored
 
 # hide_transporter_output # remove the '#' in the beginning of the line, to hide the output while uploading
@@ -15,9 +15,16 @@
 screenshots_path "./screenshots/"
 
 
+# More information about all available options: https://github.com/KrauseFx/deliver/blob/master/Deliverfile.md
+
+# Both lines are optional if you want to remove them:
+app_identifier "[[APP_IDENTIFIER]]"
+apple_id "[[APPLE_ID]]" # This is NOT your Apple login ID, but the App ID of your app
+email "[[EMAIL]]" # the login email address
+
 # version '1.2' # you can pass this if you want to verify the version number with the ipa file
 
-config_json_folder './deliver'
+# To update the app's description, changelog, etc. or to avoid updating it using deliver, edit the files in ./metadata/[language]
 
 ########################################
 # Building and Testing
@@ -34,6 +41,9 @@ ipa do
     # If you only want to upload app metadata, remove the complete ipa block.
 
     # system("ipa build --verbose") # build your project using Shenzhen
+
+    # ENV["IPA_OUTPUT_PATH"] # if you're using fastlane uncomment this and remove the line below
+    
     "./[[APP_NAME]].ipa" # Tell 'Deliver' where it can find the finished ipa file
 end
 
@@ -52,3 +62,5 @@ end
 success do
   # system("say 'Successfully deployed a new version.'")
 end
+
+# More information about all available options: https://github.com/KrauseFx/deliver/blob/master/Deliverfile.md

data/lib/assets/DeliverfileExample

@@ -47,6 +47,9 @@ ipa do
     # If you only want to upload app metadata, remove the complete ipa block.
 
     # system("ipa build --verbose") # build your project using Shenzhen
+
+    # ENV["IPA_OUTPUT_PATH"] # if you're using fastlane uncomment this and remove the line below
+
     "./[[APP_NAME]].ipa" # Tell 'Deliver' where it can find the finished ipa file
 end
 

data/lib/deliver/deliver_process.rb

@@ -39,7 +39,8 @@ module Deliver
         unless is_beta_build?
           # App Metdata will not be updated for beta builds
 
-          load_metadata_from_config_json_folder # the json file generated from the quick start
+          load_metadata_from_config_json_folder # the json file generated from the quick start # deprecated
+          load_metadata_folder # this is the new way of defining app metadata
           set_app_metadata
           set_screenshots
 
@@ -105,6 +106,7 @@ module Deliver
         end
         if skip_deployment?
           upload_strategy = Deliver::IPA_UPLOAD_STRATEGY_JUST_UPLOAD
+          Helper.log.info "Skipping submission of app update"
         end
 
         @ipa = Deliver::IpaUploader.new(Deliver::App.new, '/tmp/', used_ipa_file, upload_strategy)
@@ -139,10 +141,8 @@ module Deliver
       end
     end
 
-    def load_metadata_from_config_json_folder
-      return unless @deploy_information[Deliverer::ValKey::CONFIG_JSON_FOLDER]
-
-      matching = {
+    def options_mapping
+      {
         'title' => Deliverer::ValKey::TITLE,
         'description' => Deliverer::ValKey::DESCRIPTION,
         'version_whats_new' => Deliverer::ValKey::CHANGELOG,
@@ -151,6 +151,10 @@ module Deliver
         'software_url' => Deliverer::ValKey::MARKETING_URL,
         'support_url' => Deliverer::ValKey::SUPPORT_URL
       }
+    end
+
+    def load_metadata_from_config_json_folder
+      return unless @deploy_information[Deliverer::ValKey::CONFIG_JSON_FOLDER]
 
       file_path = @deploy_information[:config_json_folder]
       unless file_path.split("/").last.include?"metadata.json"
@@ -162,7 +166,7 @@ module Deliver
       content = JSON.parse(File.read(file_path))
       content.each do |language, current|
 
-        matching.each do |key, value|
+        options_mapping.each do |key, value|
           if current[key]
             @deploy_information[value] ||= {}
             @deploy_information[value][language] ||= current[key]
@@ -171,6 +175,26 @@ module Deliver
       end
     end
 
+    def load_metadata_folder
+      # Fetch the inforamtion from the ./metadata folder if it exists
+      metadata_folder = './metadata'
+      return unless File.exists?metadata_folder
+
+      Dir[File.join(metadata_folder, '*')].each do |language_folder|
+        language = File.basename(language_folder)
+
+        options_mapping.each do |key, value|
+          content = File.read(File.join(language_folder, "#{key}.txt")) rescue nil
+          next unless content
+          content = content.split("\n") if key == 'keywords'
+          @deploy_information[value] ||= {}
+          @deploy_information[value][language] ||= content
+
+          Helper.log.info "Successfully loaded content from '#{key}.txt' for language #{language_folder}"
+        end
+      end
+    end
+
     def set_app_metadata
       @app.metadata.update_title(@deploy_information[Deliverer::ValKey::TITLE]) if @deploy_information[Deliverer::ValKey::TITLE]
       @app.metadata.update_description(@deploy_information[Deliverer::ValKey::DESCRIPTION]) if @deploy_information[Deliverer::ValKey::DESCRIPTION]
@@ -227,7 +251,13 @@ module Deliver
 
           system("open '#{pdf_path}'")
           okay = agree("Does the PDF on path '#{pdf_path}' look okay for you? (blue = updated) (y/n)", true)
-          raise "Did not upload the metadata, because the PDF file was rejected by the user".yellow unless okay
+
+          unless okay
+            dir ||= app.get_metadata_directory
+            dir += "/#{app.apple_id}.itmsp"
+            FileUtils.rm_rf(dir) unless Helper.is_test?
+            raise "Did not upload the metadata, because the PDF file was rejected by the user".yellow
+          end
         end
       end
     end

data/lib/deliver/deliverfile/deliverfile_creator.rb

@@ -7,7 +7,7 @@ module Deliver
   class DeliverfileCreator
 
     # This method will ask the user what he wants to do
-    # @param deliver_path (String) The path in which the Deliverfile should be created
+    # @param deliver_path (String) The path in which the Deliverfile should be created (this automatically takes care if it's in the fastlane folder)
     # @param project_name (String) The default name of the project, which is used in the generated Deliverfile
     def self.create(deliver_path, project_name = nil)
       deliver_file_path = File.join(deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME)
@@ -58,15 +58,16 @@ module Deliver
       app.set_metadata_directory("/tmp") # we don't want to pollute the current folder
       app.metadata # this will download the latest app metadata
       
-      file_path = [deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME].join('/')
+      file_path = File.join(deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME)
       json = generate_deliver_file(app, deliver_path, project_name)
       File.write(file_path, json)
 
-      FileUtils.mkdir_p './screenshots/'
+      FileUtils.mkdir_p File.join(deliver_path, 'screenshots')
       begin
         Helper.log.info "Downloading all previously used app screenshots.".green
-        ItunesConnect.new.download_existing_screenshots(app)
-      rescue
+        ItunesConnect.new.download_existing_screenshots(app, deliver_path)
+      rescue Exception => ex
+        Helper.log.error ex
         Helper.log.error "Couldn't download already existing screenshots from iTunesConnect. You have to add them manually!".red
       end
 
@@ -81,18 +82,22 @@ module Deliver
       # This method takes care of creating a new 'deliver' folder, containg the app metadata 
       # and screenshots folders
       def self.generate_deliver_file(app, path, project_name)
-        metadata_path = File.join(path, 'deliver')
-        FileUtils.mkdir_p metadata_path rescue nil # never mind if it's already there
+        FileUtils.mkdir_p path rescue nil # never mind if it's already there
 
-        json = create_json_based_on_xml(app, metadata_path)
+        json = create_json_based_on_xml(app, path)
 
-        json.each do |key, value|
-          json[key].delete(:version_whats_new)
+        json.each do |language, value|
+          folder = File.join(path, "metadata", language)
+          FileUtils.mkdir_p(folder)
+          value.each do |key, content|
+            next if key == :version_whats_new
+            content = content.join("\n") if key == :keywords
+            File.write(File.join(folder, "#{key}.txt"), content)
+          end
+          Helper.log.info "Successfully downloaded existing metadata for language #{language}"
         end
         
-        meta_path = File.join(metadata_path, "metadata.json")
-        File.write(meta_path, JSON.pretty_generate(json))
-        puts "Successfully created new metadata JSON file at '#{meta_path}'".green
+        puts "Successfully created new configuration files at '#{File.join(path, 'metadata')}'".green
 
         gem_path = Helper.gem_path('deliver')
 

data/lib/deliver/itunes_connect/itunes_connect_app_rating.rb

@@ -39,21 +39,25 @@ module Deliver
 
 
       # Apple, doing some extra thingy for the kids section
-      val = config.last['level'].to_i
-      Helper.log.info "Setting kids mode to #{val}".green
-      currently_enabled = (all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > input").last.value != "")
-      if val > 0
-        if not currently_enabled
-          all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > a").last.click
-        end
-
-        # Kids is enabled, check mode
-        first("select[ng-model='tempRatings.ageBand'] > option[value='#{val - 1}']").select_option # -1 since 0 is no kids mode
-      else
-        if currently_enabled
-          # disable kids mode
-          all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > a").last.click
+      begin
+        val = config.last['level'].to_i
+        currently_enabled = (all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > input").last.value != "")
+        Helper.log.info "Setting kids mode to #{val}".green
+        if val > 0
+          if not currently_enabled
+            all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > a").last.click
+          end
+
+          # Kids is enabled, check mode
+          first("select[ng-model='tempRatings.ageBand'] > option[value='#{val - 1}']").select_option # -1 since 0 is no kids mode
+        else
+          if currently_enabled
+            # disable kids mode
+            all("div[itc-checkbox='tempPageContent.ratingDialog.madeForKidsChecked'] > * > a").last.click
+          end
         end
+      rescue 
+        Helper.log.warn "Couldn't set kids mode because of other options."
       end
 
       # Check if there is a warning or error message because of this rating

data/lib/deliver/itunes_connect/itunes_connect_screenshot_fetcher.rb

@@ -7,10 +7,11 @@ module Deliver
 
     # This method will download all existing app screenshots
     # @param app (Deliver::App) the app you want this information from
+    # @param folder_path (String) the path to store the screenshots in
     # @raise [ItunesConnectGeneralError] General error while executing 
     #  this action
     # @raise [ItunesConnectLoginError] Login data is wrong
-    def download_existing_screenshots(app)
+    def download_existing_screenshots(app, folder_path)
       languages = JSON.parse(File.read(File.join(Helper.gem_path('deliver'), "lib", "assets", "DeliverLanguageMapping.json")))
 
       begin
@@ -40,7 +41,7 @@ module Deliver
               file_name = [screenshot['value']['sortOrder'], type, screenshot['value']['originalFileName']].join("_")
               Helper.log.info "Downloading existing screenshot '#{file_name}' of device type: '#{type}'"
 
-              containing_folder = File.join(".", "screenshots", language_code)
+              containing_folder = File.join(folder_path, "screenshots", language_code)
               FileUtils.mkdir_p containing_folder rescue nil # if it's already there
               path = File.join(containing_folder, file_name)
               File.write(path, open(url).read)

data/lib/deliver/itunes_transporter.rb

@@ -18,7 +18,9 @@ module Deliver
     OUTPUT_REGEX = />\s+(.+)/
     RETURN_VALUE_REGEX = />\sDBG-X:\sReturning\s+(\d+)/
 
-    private_constant :ERROR_REGEX, :WARNING_REGEX, :OUTPUT_REGEX, :RETURN_VALUE_REGEX
+    SKIP_ERRORS = [ "ERROR: An exception has occurred: Scheduling automatic restart in 1 minute" ]
+
+    private_constant :ERROR_REGEX, :WARNING_REGEX, :OUTPUT_REGEX, :RETURN_VALUE_REGEX, :SKIP_ERRORS
 
     # This will be called from the Deliverfile, and disables the logging of the transporter output
     def self.hide_transporter_output
@@ -54,7 +56,10 @@ module Deliver
       if result and File.directory?itmsp_path
         Helper.log.info "Successfully downloaded the latest package from iTunesConnect.".green
       else
-        Helper.log.fatal "Could not download metadata from iTunes Connect. Do you have special characters in your password (Like ' or \")?"
+        unless /^[0-9a-zA-Z\.\$\_]*$/ === @password
+          Helper.log.fatal "Password contains special characters, which may not be handled properly by iTMSTransporter. If you experience problems uploading to iTunes Connect, please consider changing your password to something with only alphanumeric characters.".red
+        end
+        Helper.log.fatal "Could not download metadata from iTunes Connect! It's probably related to your password or your internet connection."
       end
 
       result
@@ -128,7 +133,12 @@ module Deliver
         # Taken from https://github.com/sshaw/itunes_store_transporter/blob/master/lib/itunes/store/transporter/output_parser.rb
 
         output_done = false
-        if line =~ ERROR_REGEX
+
+        re = Regexp.union(SKIP_ERRORS)
+        if line.match(re)
+          # Those lines will not be handle like errors or warnings
+
+        elsif line =~ ERROR_REGEX
           @errors << $1
           Helper.log.error "[Transporter Error Output]: #{$1}".red
 

data/lib/deliver/testflight.rb

@@ -9,9 +9,9 @@ module Deliver
       ItunesTransporter.hide_transporter_output
 
       app_identifier = IpaFileAnalyser.fetch_app_identifier(ipa_path)
-      app_identifier ||= ask("Could not automatically find the app identifier, please enter the app's bundle identifier: ")
+      app_identifier ||= ENV["TESTFLIGHT_APP_IDENTITIFER"] || ask("Could not automatically find the app identifier, please enter the app's bundle identifier: ")
       app_id ||= (Deliver::ItunesSearchApi.fetch_by_identifier(app_identifier)['trackId'] rescue nil)
-      app_id ||= ask("Could not automatically find the app ID, please enter it here (e.g. 956814360): ")
+      app_id ||= ENV["TESTFLIGHT_APPLE_ID"] || ask("Could not automatically find the app ID, please enter it here (e.g. 956814360): ")
       strategy = (skip_deploy ? Deliver::IPA_UPLOAD_STRATEGY_JUST_UPLOAD : Deliver::IPA_UPLOAD_STRATEGY_BETA_BUILD)
 
       Helper.log.info "Ready to upload new build to TestFlight (#{app_identifier} - #{app_id})".green

data/lib/deliver/version.rb

@@ -1,3 +1,3 @@
 module Deliver
-  VERSION = "0.7.13"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deliver
 version: !ruby/object:Gem::Version
-  version: 0.7.13
+  version: 0.8.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core