deliver 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a3a8eed44f8084c64b1f4947a3e5c6158fb0582
-  data.tar.gz: 0d6a5d848a43ccac5c447a8f0f5b627615a4953d
+  metadata.gz: 6827a727bec1ffe3eb9e9aa53db1f744ce70037c
+  data.tar.gz: 861e402152acd6b7153cb4cfb0001167575ebfc1
 SHA512:
-  metadata.gz: 405185ddfcf48f78757938756dc8391dfa484a88b613629a4c4fa5d9035555583bcfe6deb7307c5907303378e8883a749c8a39e2a72e1d87808efad846fb9f78
-  data.tar.gz: 9b20f456befe9309d76efe6d88c884264c51f6cc58fbf957775f2dc4a298948d56268e3f2430016b7c83e432de18d0fda2d2c30ab06efc770c045dbfcf5b9150
+  metadata.gz: b6451cbde937213b378b598c63085fcac77e6f24210e75fc93c6eba5a01c66eb3ddb69c0e1297207df99f4e5522325af1f668f3d927cb4b8c30bb5a8c515efbc
+  data.tar.gz: 9f4fc188af8db6f38c39de3f077a256b496604e0d2614a8d2dbb8375b7210f52b7693bc3bb7bc137685ca8bd8c08c04725172a3b5845ab93bfbf1956d7be941f

data/README.md

@@ -290,13 +290,13 @@ This project is well documented, check it out on [Rubydoc](http://www.rubydoc.in
 
 # Credentials
 
-A detailed description about your credentials is available on a [separate repo](https://github.com/KrauseFx/CredentialsManager).
+A detailed description about your credentials is available on a [separate repo](https://github.com/fastlane/CredentialsManager).
 
 
 # Can I trust `deliver`? 
 ###How does this thing even work? Is magic involved? 🎩###
 
-`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.
+`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. (More information available on [CredentialsManager](https://github.com/fastlane/CredentialsManager))
 
 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. 
 
@@ -323,7 +323,7 @@ Before actually uploading anything to iTunes, ```deliver``` will generate a [PDF
 
 ## Available language codes
 ```ruby
-["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"]
+["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", "cmn-Hant"]
 ```
 
 ## Use a clean status bar

data/bin/deliver

@@ -28,7 +28,21 @@ class FastlaneApplication
       c.syntax = 'deliver'
       c.description = 'Run a deploy process using the Deliverfile in the current folder'
       c.action do |args, options|
-        path = (Deliver::Helper.fastlane_enabled?? './fastlane' : '.')
+        run_deliver(options)
+      end
+    end
+
+    command :upload_metadata do |c|
+      c.syntax = 'deliver upload_metadata'
+      c.description = "Uploads new app metadata only. No binary will be uploaded"
+      c.action do |args, options|
+        ENV["DELIVER_SKIP_BINARY"] = "1"
+        run_deliver(options)
+      end
+    end
+
+    def run_deliver(options)
+      path = (Deliver::Helper.fastlane_enabled?? './fastlane' : '.')
         Dir.chdir(path) do # switch the context
           if File.exists?(deliver_path)
             # Everything looks alright, use the given Deliverfile
@@ -41,7 +55,6 @@ class FastlaneApplication
             end
           end
         end
-      end
     end
 
     command :init do |c|

data/lib/deliver/app_metadata_screenshots.rb

@@ -101,7 +101,9 @@ module Deliver
     #
     # This will also clear all existing screenshots before setting the new ones.
     # @param (Hash) hash A hash containing a different path for each locale ({FastlaneCore::Languages::ALL_LANGUAGES})
-    def set_screenshots_for_each_language(hash)
+    # @param (Bool) Use the framed screenshots? Only use it if you use frameit 2.0
+
+    def set_screenshots_for_each_language(hash, use_framed = false)
       raise AppMetadataParameterError.new("Parameter needs to be an hash, containg strings with the new description") unless hash.kind_of?Hash
 
       hash.each do |language, current_path|
@@ -117,7 +119,11 @@ module Deliver
           self.clear_all_screenshots(language)
 
           Dir.glob(resulting_path, File::FNM_CASEFOLD).sort.each do |path|
-            next if path.include?"_framed."
+            if use_framed
+              next unless path.include?"_framed."
+            else
+              next if path.include?"_framed."
+            end
 
             begin
               add_screenshot(language, Deliver::AppScreenshot.new(path))
@@ -134,7 +140,8 @@ module Deliver
     # This method will run through all the available locales, check if there is
     # a folder for this language (e.g. 'en-US') and use all screenshots in there
     # @param (String) path A path to the folder, which contains a folder for each locale
-    def set_all_screenshots_from_path(path)
+    # @param (Bool) Use the framed screenshots? Only use it if you use frameit 2.0
+    def set_all_screenshots_from_path(path, use_framed = false)
       raise AppMetadataParameterError.new("Parameter needs to be a path (string)") unless path.kind_of?String
 
       found = false
@@ -144,7 +151,7 @@ module Deliver
           found = true
           set_screenshots_for_each_language({
             language => full_path
-          })
+          }, use_framed)
         end
       end
       return found

data/lib/deliver/deliver_process.rb

@@ -26,33 +26,36 @@ module Deliver
 
     def run
       begin
-        run_unit_tests
-        fetch_information_from_ipa_file
-
-        verify_ipa_file
-
-        Helper.log.info("Got all information needed to deploy a new update ('#{@app_version}') for app '#{@app_identifier}'")
+        unless metadata_only?
+          run_unit_tests
+          fetch_app_key_information
+          fetch_information_from_ipa_file
 
+          @app_version ||= get_latest_version
+          verify_ipa_file
+        else
+          fetch_app_key_information
+          @app_identifier ||= ask("App Identifier (e.g. com.krausefx.app): ")
+          @app_version ||= get_latest_version || ask("Which version number should be updated? ")
+        end
         create_app
-        verify_app_on_itunesconnect
-
-        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 # deprecated
-          load_metadata_folder # this is the new way of defining app metadata
-          set_app_metadata
-          set_screenshots
+        Helper.log.info("Got all information needed to deploy a new update ('#{@app_version}') for app '#{@app_identifier}'")
 
-          verify_pdf_file
+        verify_app_on_itunesconnect unless metadata_only?
 
-          additional_itc_information # e.g. copyright, age rating
+        if ready_for_sale?
+          raise "Cannot update metadata of apps 'Ready for Sale'. You can dupe: http://www.openradar.appspot.com/18263306".red 
+        end
 
-          trigger_metadata_upload
+        if is_beta_build?
+          Helper.log.info "Beta builds don't upload new metadata to iTunesConnet".yellow
+        else
+          upload_metadata
         end
 
         # Always upload a new ipa (except if none was given)
-        trigger_ipa_upload
+        trigger_ipa_upload unless metadata_only?
 
         call_success_block
       rescue => ex
@@ -60,6 +63,53 @@ module Deliver
       end
     end
 
+    def upload_metadata
+      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
+
+      verify_pdf_file
+
+      additional_itc_information # e.g. copyright, age rating
+
+      trigger_metadata_upload
+    end
+
+    #####################################################
+    # @!group What kind of release
+    #####################################################
+
+    # Deployment = Submission of the binary
+    def skip_deployment?
+      @deploy_information[Deliverer::ValKey::SKIP_DEPLOY]
+    end
+
+    # Release = App Store and not TestFlight
+    def is_release_build?
+      is_beta_build? == false
+    end
+
+    # TestFlight Buil
+    def is_beta_build?
+      @deploy_information[Deliverer::ValKey::IS_BETA_IPA]
+    end
+
+    # Only upload metadata and no binary
+    def metadata_only?
+      ENV["DELIVER_SKIP_BINARY"]
+    end
+
+    # Is the app already ready for sale?
+    # if so, we can't update the app metadata: http://www.openradar.appspot.com/18263306
+    def ready_for_sale?
+      return false if Helper.is_test?
+      return @ready if @checked_for_ready
+
+      @checked_for_ready = true
+      @ready = (app.get_app_status == App::AppStatus::READY_FOR_SALE)
+    end
+
     #####################################################
     # @!group All the methods
     #####################################################
@@ -75,10 +125,24 @@ module Deliver
       end
     end
 
-    def fetch_information_from_ipa_file
+    # Tries to fetch app version and app identifier from Deliverfile
+    def fetch_app_key_information
       @app_version = @deploy_information[Deliverer::ValKey::APP_VERSION]
       @app_identifier = @deploy_information[Deliverer::ValKey::APP_IDENTIFIER]
+      fetch_app_identifier_from_app_file
+    end
+
+    # returns the latest app version from iTunes Connect
+    def get_latest_version
+      return nil if Helper.is_test?
 
+      data = itc.get_app_information(Deliver::App.new(app_identifier: @app_identifier))
+      return (data['version']['value'] rescue nil)
+    rescue
+      return nil
+    end
+
+    def fetch_information_from_ipa_file
       used_ipa_file = ENV["IPA_OUTPUT_PATH"]# if (ENV["IPA_OUTPUT_PATH"] and File.exists?(ENV["IPA_OUTPUT_PATH"]))
 
       if is_release_build?
@@ -125,7 +189,7 @@ module Deliver
     end
 
     def fetch_app_identifier_from_app_file
-      @app_identifier = (CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) rescue nil)
+      @app_identifier ||= (CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) rescue nil)
     end
 
     def verify_ipa_file
@@ -216,20 +280,25 @@ module Deliver
       @app.metadata.update_price_tier(@deploy_information[Deliverer::ValKey::PRICE_TIER]) if @deploy_information[Deliverer::ValKey::PRICE_TIER]
     end
 
+    def screenshots_path
+      return @screens_path if @screens_path
 
-    def set_screenshots
-      screens_path = @deploy_information[Deliverer::ValKey::SCREENSHOTS_PATH]
-
+      @screens_path = @deploy_information[Deliverer::ValKey::SCREENSHOTS_PATH]
       if (ENV["DELIVER_SCREENSHOTS_PATH"] || '').length > 0
-        Helper.log.warn "Overwriting screenshots path from config (#{screens_path}) with (#{ENV["DELIVER_SCREENSHOTS_PATH"]})".yellow
-        screens_path = ENV["DELIVER_SCREENSHOTS_PATH"]
+        Helper.log.warn "Overwriting screenshots path from config (#{@screens_path}) with (#{ENV["DELIVER_SCREENSHOTS_PATH"]})".yellow
+        @screens_path = ENV["DELIVER_SCREENSHOTS_PATH"]
       end
 
-      screens_path ||= "./screenshots/" # default value
-      
+      @screens_path ||= "./screenshots/" # default value
+
+      return @screens_path
+    end
+
+    def set_screenshots
+      screens_path = screenshots_path
       if screens_path
         # Not using Snapfile. Not a good user.
-        if not @app.metadata.set_all_screenshots_from_path(screens_path)
+        if not @app.metadata.set_all_screenshots_from_path(screens_path, use_framed_screenshots?)
           # This path does not contain folders for each language
           if screens_path.kind_of?String
             if @deploy_information[Deliverer::ValKey::DEFAULT_LANGUAGE]
@@ -240,11 +309,18 @@ module Deliver
               screens_path = nil
             end
           end
-          @app.metadata.set_screenshots_for_each_language(screens_path) if screens_path
+          @app.metadata.set_screenshots_for_each_language(screens_path, use_framed_screenshots?) if screens_path
         end
       end
     end
 
+    # Should _framed screenshots be used for the screenshot upload?
+    # This will only be true if there is a Framefile, as this makes the screenshots valid
+    # since the resolution is only correct when using a background + title using frameit 2.0
+    def use_framed_screenshots?
+      return Dir[screenshots_path + "**/Framefile.json"].count > 0
+    end
+
     def verify_pdf_file
       if @deploy_information[Deliverer::ValKey::SKIP_PDF]
         Helper.log.debug "PDF verify was skipped"
@@ -276,9 +352,12 @@ module Deliver
       raise "Error uploading app metadata".red unless result == true
     end
 
+    def itc
+      @itc ||= ItunesConnect.new
+    end
+
     def additional_itc_information
       # e.g. rating or copyright
-      itc = ItunesConnect.new
       itc.set_copyright!(@app, @deploy_information[Deliverer::ValKey::COPYRIGHT]) if @deploy_information[Deliverer::ValKey::COPYRIGHT]
       itc.set_app_review_information!(@app, @deploy_information[Deliverer::ValKey::APP_REVIEW_INFORMATION]) if @deploy_information[Deliverer::ValKey::APP_REVIEW_INFORMATION]
       itc.set_release_after_approval!(@app, @deploy_information[Deliverer::ValKey::AUTOMATIC_RELEASE]) if @deploy_information[Deliverer::ValKey::AUTOMATIC_RELEASE] != nil
@@ -362,17 +441,5 @@ module Deliver
         end
         return app_version
       end
-
-      def skip_deployment?
-        @deploy_information[Deliverer::ValKey::SKIP_DEPLOY]
-      end
-
-      def is_release_build?
-        is_beta_build? == false
-      end
-
-      def is_beta_build?
-        @deploy_information[Deliverer::ValKey::IS_BETA_IPA]
-      end
   end
 end

data/lib/deliver/ipa_uploader.rb

@@ -91,6 +91,9 @@ module Deliver
           return publish_production_build(submit_information)
         elsif @publish_strategy == IPA_UPLOAD_STRATEGY_BETA_BUILD
           return publish_beta_build
+        else
+          Helper.log.info "deliver will **not** submit the app for Review or for TestFlight distribution".yellow
+          Helper.log.info "If you want to distribute the binary, don't define `skip_deploy` ".yellow
         end
         return true
       end

data/lib/deliver/itunes_connect/itunes_connect.rb

@@ -8,4 +8,5 @@ require 'deliver/itunes_connect/itunes_connect_app_icon'
 require 'deliver/itunes_connect/itunes_connect_apple_watch_app_icon'
 require 'deliver/itunes_connect/itunes_connect_app_rating'
 require 'deliver/itunes_connect/itunes_connect_additional'
-require 'deliver/itunes_connect/itunes_connect_screenshot_fetcher'
+require 'deliver/itunes_connect/itunes_connect_screenshot_fetcher'
+require 'deliver/itunes_connect/itunes_connect_information'

data/lib/deliver/itunes_connect/itunes_connect_information.rb

@@ -0,0 +1,34 @@
+require 'open-uri'
+
+module Deliver
+  # For all the information reading (e.g. version number)
+  class ItunesConnect < FastlaneCore::ItunesConnect
+    ALL_INFORMATION_URL = "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/"
+
+    # This method will download information for a given app
+    # @param app (Deliver::App) the app you want this information from
+    # @raise [ItunesConnectGeneralError] General error while executing 
+    #  this action
+    # @raise [ItunesConnectLoginError] Login data is wrong
+    def get_app_information(app)
+      begin
+        verify_app(app)
+
+        url = ALL_INFORMATION_URL + app.apple_id.to_s
+
+        # Turn off/on the async mode of jQuery
+        evaluate_script("jQuery.ajaxSetup({async:false});")
+        response = evaluate_script("$.get('#{url}').responseText")
+        evaluate_script("jQuery.ajaxSetup({async:true});")
+
+        raise "Could not fetch data for app" unless response
+
+        data = JSON.parse(response)
+
+        return data['data']
+      rescue Exception => ex
+        error_occured(ex)
+      end
+    end
+  end
+end

data/lib/deliver/itunes_connect/itunes_connect_screenshot_fetcher.rb

@@ -3,8 +3,6 @@ require 'open-uri'
 module Deliver
   # For all the information reading (e.g. version number)
   class ItunesConnect < FastlaneCore::ItunesConnect
-    ALL_INFORMATION_URL = "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/"
-
     # 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

data/lib/deliver/itunes_connect/itunes_connect_submission.rb

@@ -67,12 +67,22 @@ module Deliver
         build_url = "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/#{app.apple_id}/trains/#{current_build['trainVersion']}/builds/#{current_build['buildVersion']}/testInformation"
         build_info = JSON.parse(Excon.get(build_url, headers: { "Cookie" => cookie_string } ).body)['data']
 
+        Helper.log.info "Setting the following information for this build:".yellow
+        Helper.log.info "DELIVER_WHAT_TO_TEST: '#{ENV['DELIVER_WHAT_TO_TEST']}'"
+        Helper.log.info "DELIVER_BETA_DESCRIPTION: '#{ENV['DELIVER_BETA_DESCRIPTION']}'"
+        Helper.log.info "DELIVER_BETA_FEEDBACK_EMAIL: '#{ENV['DELIVER_BETA_FEEDBACK_EMAIL']}'"
+
         build_info['details'][0]['whatsNew']['value'] = ENV["DELIVER_WHAT_TO_TEST"]
         build_info['details'][0]['description']['value'] = ENV["DELIVER_BETA_DESCRIPTION"]
         build_info['details'][0]['feedbackEmail']['value'] = ENV["DELIVER_BETA_FEEDBACK_EMAIL"]
-        Excon.post(build_url, body: build_info.to_json, headers: { "Cookie" => cookie_string } )
+        h = Excon.post(build_url, body: build_info.to_json, headers: { "Cookie" => cookie_string } )
 
-        Helper.log.info "Successfully distributed latest beta build 🚀".green
+        if h.status == 200
+          Helper.log.info "Successfully distributed latest beta build 🚀".green
+        else
+          Helper.log.info h.data
+          Helper.log.info "Some error occured marking the new builds as TestFlight build. Please do it manually on '#{current_url}'.".green
+        end
 
         return true
       rescue => ex

data/lib/deliver/version.rb

@@ -1,3 +1,3 @@
 module Deliver
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deliver
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -94,20 +94,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: prawn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +244,7 @@ files:
 - lib/deliver/itunes_connect/itunes_connect_app_icon.rb
 - lib/deliver/itunes_connect/itunes_connect_app_rating.rb
 - lib/deliver/itunes_connect/itunes_connect_apple_watch_app_icon.rb
+- lib/deliver/itunes_connect/itunes_connect_information.rb
 - lib/deliver/itunes_connect/itunes_connect_new_version.rb
 - lib/deliver/itunes_connect/itunes_connect_reader.rb
 - lib/deliver/itunes_connect/itunes_connect_screenshot_fetcher.rb