deliver 0.5.0 → 0.6.0

data/lib/deliver/deliver_process.rb

@@ -42,6 +42,8 @@ module Deliver
 
         verify_pdf_file
 
+        additional_itc_information # e.g. copyright, age rating
+
         trigger_metadata_upload
         trigger_ipa_upload
 
@@ -173,8 +175,11 @@ module Deliver
       @app.metadata.update_privacy_url(@deploy_information[Deliverer::ValKey::PRIVACY_URL]) if @deploy_information[Deliverer::ValKey::PRIVACY_URL]
 
       @app.metadata.update_keywords(@deploy_information[Deliverer::ValKey::KEYWORDS]) if @deploy_information[Deliverer::ValKey::KEYWORDS]
+
+      @app.metadata.update_price_tier(@deploy_information[Deliverer::ValKey::PRICE_TIER]) if @deploy_information[Deliverer::ValKey::PRICE_TIER]
     end
 
+
     def set_screenshots
       screens_path = @deploy_information[Deliverer::ValKey::SCREENSHOTS_PATH]
 
@@ -226,6 +231,25 @@ module Deliver
       raise "Error uploading app metadata".red unless result == true
     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]
+
+      # Categories
+      primary = @deploy_information[Deliverer::ValKey::PRIMARY_CATEGORY]
+      secondary = @deploy_information[Deliverer::ValKey::SECONDARY_CATEGORY]
+      itc.set_categories!(@app, primary, secondary) if (primary or secondary)
+
+      # App Rating
+      itc.set_app_rating!(@app, @deploy_information[Deliverer::ValKey::RATINGS_CONFIG_PATH]) if @deploy_information[Deliverer::ValKey::RATINGS_CONFIG_PATH]
+
+      # App Icon
+      itc.upload_app_icon!(@app, @deploy_information[Deliverer::ValKey::APP_ICON]) if @deploy_information[Deliverer::ValKey::APP_ICON]
+    end
+
     def trigger_ipa_upload
       if @ipa
         @ipa.app = @app # we now have the resulting app

data/lib/deliver/deliverer.rb

@@ -33,6 +33,25 @@ module Deliver
       CONFIG_JSON_FOLDER = :config_json_folder # Path to a folder containing a configuration file and including screenshots
       SKIP_PDF = :skip_pdf
       SUBMIT_FURTHER_INFORMATION = :submit_further_information # export compliance, content rights and advertising identifier
+      PRICE_TIER = :price_tier
+      APP_ICON = :app_icon
+      
+      COPYRIGHT = :copyright
+      PRIMARY_CATEGORY = :primary_category
+      SECONDARY_CATEGORY = :secondary_category
+      
+      AUTOMATIC_RELEASE = :automatic_release # should the update go live after approval
+      RATINGS_CONFIG_PATH = :ratings_config_path # a path to the configuration for the app's ratings
+
+      APP_REVIEW_INFORMATION = :app_review_information
+      # Supported
+        # first_name
+        # last_name
+        # phone_number
+        # email_address
+        # demo_user
+        # demo_password
+        # notes
     end
 
     module AllBlocks

data/lib/deliver/deliverfile/deliverfile_creator.rb

@@ -9,7 +9,7 @@ module Deliver
     # @param deliver_path (String) The path in which the Deliverfile should be created
     # @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 = [deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME].join("/")
+      deliver_file_path = File.join(deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME)
       raise "Deliverfile already exists at path '#{deliver_file_path}'. Run 'deliver' to use Deliver.".red if File.exists?(deliver_file_path)
 
       project_name ||= Dir.pwd.split("/").last

data/lib/deliver/deliverfile/dsl.rb

@@ -18,12 +18,16 @@ module Deliver
         # Setting all the metadata
         def method_missing(method_sym, *arguments, &block)
           allowed = Deliver::Deliverer.all_available_keys_to_set
-          not_translated = [:ipa, :app_identifier, :apple_id, :screenshots_path, :config_json_folder, :submit_further_information]
+          not_translated = [:ipa, :app_identifier, :apple_id, :screenshots_path, :config_json_folder, 
+                            :submit_further_information, :copyright, :primary_category, :secondary_category,
+                            :automatic_release, :app_review_information, :ratings_config_path, :price_tier,
+                            :app_icon]
 
           if allowed.include?(method_sym)
-            value = arguments.first || block.call
+            value = arguments.first
+            value = block.call if (value == nil and block != nil)
 
-            unless value
+            if value == nil
               Helper.log.error(caller)
               Helper.log.fatal("No value or block passed to method '#{method_sym}'")
               raise DeliverfileDSLError.new(MISSING_VALUE_ERROR_MESSAGE.red)

data/lib/deliver/itunes_connect/itunes_connect.rb

@@ -0,0 +1,72 @@
+require 'capybara'
+require 'capybara/poltergeist'
+require 'fastimage'
+require 'credentials_manager/password_manager'
+
+# Import all the actions
+require 'deliver/itunes_connect/itunes_connect_submission'
+require 'deliver/itunes_connect/itunes_connect_reader'
+require 'deliver/itunes_connect/itunes_connect_helper'
+require 'deliver/itunes_connect/itunes_connect_new_version'
+require 'deliver/itunes_connect/itunes_connect_login'
+require 'deliver/itunes_connect/itunes_connect_app_icon'
+require 'deliver/itunes_connect/itunes_connect_app_rating'
+require 'deliver/itunes_connect/itunes_connect_additional'
+
+module Deliver
+  # Everything that can't be achived using the {Deliver::ItunesTransporter}
+  # will be scripted using the iTunesConnect frontend.
+  # 
+  # Every method you call here, might take a time
+  class ItunesConnect
+    # This error occurs only if there is something wrong with the given login data
+    class ItunesConnectLoginError < StandardError 
+    end
+
+    # This error can occur for many reaons. It is
+    # usually raised when a UI element could not be found
+    class ItunesConnectGeneralError < StandardError
+    end
+
+    include Capybara::DSL
+
+    ITUNESCONNECT_URL = "https://itunesconnect.apple.com/"
+    APP_DETAILS_URL = "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app/[[app_id]]"
+
+    BUTTON_STRING_NEW_VERSION = "New Version"
+    BUTTON_STRING_SUBMIT_FOR_REVIEW = "Submit for Review"
+    BUTTON_ADD_NEW_BUILD = 'Click + to add a build before you submit your app.'
+
+    WAITING_FOR_REVIEW = "Waiting For Review"
+    PROCESSING_TEXT = "Processing"
+    
+    def initialize
+      super
+
+      return if Helper.is_test?
+
+      DependencyChecker.check_dependencies
+      
+      Capybara.run_server = false
+      Capybara.default_driver = :poltergeist
+      Capybara.javascript_driver = :poltergeist
+      Capybara.current_driver = :poltergeist
+      Capybara.app_host = ITUNESCONNECT_URL
+
+      # Since Apple has some SSL errors, we have to configure the client properly:
+      # https://github.com/ariya/phantomjs/issues/11239
+      Capybara.register_driver :poltergeist do |a|
+        conf = ['--debug=no', '--ignore-ssl-errors=yes', '--ssl-protocol=TLSv1']
+        Capybara::Poltergeist::Driver.new(a, {
+          phantomjs_options: conf,
+          phantomjs_logger: File.open("/tmp/poltergeist_log.txt", "a"),
+          js_errors: false
+        })
+      end
+
+      page.driver.headers = { "Accept-Language" => "en" }
+
+      login
+    end
+  end
+end

data/lib/deliver/itunes_connect/itunes_connect_additional.rb

@@ -0,0 +1,90 @@
+module Deliver  
+  class ItunesConnect
+    # This file sets additional information like copyright and age rating
+
+    def set_copyright!(app, text)
+      verify_app(app)
+      open_app_page(app)
+
+      Helper.log.info "Setting copyright to '#{text}'".green
+
+      first("input[ng-model='versionInfo.copyright.value']").set text
+      
+      (click_on "Save" rescue nil) # if nothing has changed, there is no back button and we don't care
+    rescue => ex
+      error_occured(ex)
+    end
+
+    def set_app_review_information!(app, hash)
+      verify_app(app)
+      open_app_page(app)
+
+      Helper.log.info "Setting review information: #{hash}"
+
+      first("input[ng-model='versionInfo.appReviewInfo.firstName.value']").set                     hash[:first_name]
+      first("input[ng-model='versionInfo.appReviewInfo.lastName.value']").set                      hash[:last_name]
+      first("input[ng-model='versionInfo.appReviewInfo.phoneNumber.value']").set                   hash[:phone_number]
+      first("input[ng-model='versionInfo.appReviewInfo.emailAddress.value']").set                  hash[:email_address]
+      first("input[ng-model='versionInfo.appReviewInfo.userName.value']").set                      hash[:demo_user]
+      first("input[ng-model='versionInfo.appReviewInfo.password.value']").set                      hash[:demo_password]
+      first("span[ng-show='versionInfo.appReviewInfo.reviewNotes.isEditable'] > * > textarea").set hash[:notes]
+
+      (click_on "Save" rescue nil) # if nothing has changed, there is no back button and we don't care
+
+      Helper.log.info "Successfully saved review information".green
+    rescue => ex
+      error_occured(ex)
+    end
+
+    def set_release_after_approval!(app, automatic_release)
+      verify_app(app)
+      open_app_page(app)
+
+      Helper.log.info "Setting automatic release to '#{automatic_release}'".green
+
+      # Find the correct radio button
+      first("div[itc-radio='versionInfo.releaseOnApproval.value'][radio-value='#{automatic_release.to_s}'] > * > a").click
+
+      (click_on "Save" rescue nil) # if nothing has changed, there is no back button and we don't care
+    rescue => ex
+      error_occured(ex)
+    end
+
+    def set_categories!(app, primary, secondary)
+      verify_app(app)
+      open_app_page(app)
+
+      Helper.log.info "Setting primary/secondary category.'".green
+      if primary
+        all("select[ng-model='versionInfo.primaryCategory.value'] > option").each do |category|
+          if category.text.to_s == primary.to_s
+            category.select_option
+            primary = nil
+            break
+          end
+        end
+        if primary
+          Helper.log.info "Could not find category '#{primary}'. Make sure it's available on iTC".red
+        end
+      end
+
+      if secondary
+        all("select[ng-model='versionInfo.secondaryCategory.value'] > option").each do |category|
+          if category.text.to_s == secondary.to_s
+            category.select_option
+            secondary = nil
+            break
+          end
+        end
+        if secondary
+          Helper.log.info "Could not find category '#{secondary}'. Make sure it's available on iTC".red
+        end
+      end
+
+
+      (click_on "Save" rescue nil) # if nothing has changed, there is no back button and we don't care
+    rescue => ex
+      error_occured(ex)
+    end
+  end
+end

data/lib/deliver/itunes_connect/itunes_connect_app_icon.rb

@@ -0,0 +1,35 @@
+require 'fastimage'
+
+module Deliver  
+  class ItunesConnect
+    # Uploading a new full size app icon
+
+    def upload_app_icon!(app, path)
+      path = File.expand_path(path)
+      raise "Could not find app icon at path '#{path}'".red unless File.exists?path
+
+      size = FastImage.size(path)
+      raise "App icon must have the resolution of 1024x1024px".red unless (size[0] == 1024 and size[1] == 1024)
+
+      begin
+        verify_app(app)
+        open_app_page(app)
+
+        Helper.log.info "Starting upload of new app icon".green
+
+        evaluate_script("$('.appversionicon > .ios7-style-icon').prev().click()") # delete button
+        evaluate_script("$('[style-class=\"appversionicon rounded\"] [itc-launch-filechooser] + input').attr('id', 'deliverFileUploadInput')") # set div
+        evaluate_script("URL = webkitURL; URL.createObjectURL = function(){return 'blob:abc'}"); # shim URL
+        page.attach_file("deliverFileUploadInput", path) # add file
+
+        sleep 10
+
+        click_on "Save"
+
+        Helper.log.info "Finished uploading the new app icon".green
+      rescue => ex
+        error_occured(ex)
+      end
+    end
+  end
+end

data/lib/deliver/itunes_connect/itunes_connect_app_rating.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+module Deliver  
+  class ItunesConnect
+    # Setting the app's age restrictions
+
+    def set_app_rating!(app, path_to_json)
+      path_to_json = File.expand_path(path_to_json)
+      raise "Could not find app rating JSON file" unless File.exists?(path_to_json)
+
+      config = JSON.parse(File.read(path_to_json))
+
+      verify_app(app)
+      open_app_page(app)
+
+      Helper.log.info "Updating the app's rating".green
+
+      first("a[ng-show='versionInfo.ratings.isEditable']").click # open the ratings screen
+
+      rows = wait_for_elements(".defaultTable.ratingsTable > tbody > tr.ng-scope") # .ng-scope, since there is one empty row
+
+      if rows.count != config.count
+        raise "The number of options passed in the config file does not match the number of options available on iTC!".red
+      end
+
+
+
+      # Setting all the values based on config file
+      rows.each_with_index do |row, index|
+        current = config[index]
+
+        level = name_for_level(current['level'], current['type'] == 'boolean')
+
+        Helper.log.info "Setting '#{current['comment']}' to #{level}.".green
+
+        radio_value = "ITC.apps.ratings.level.#{level}"
+
+        row.first("td > div[radio-value='#{radio_value}']").click
+      end
+
+      # Check if there is a warning or error message because of this rating
+      error_message = first("p[ng-show='tempPageContent.ratingDialog.showErrorMessage']")
+      Helper.log.error error_message.text if error_message
+
+      Helper.log.info "Finished setting updated app rating"
+      
+      (click_on "Done" rescue nil)
+
+      (click_on "Save" rescue nil) # if nothing has changed, there is no back button and we don't care
+    rescue => ex
+      error_occured(ex)
+    end
+
+    private
+      def name_for_level(level, is_boolean)
+        if is_boolean
+          return "NO" if level == 0
+          return "YES" if level == 1
+        else
+          return "NONE" if level == 0
+          return "INFREQUENT_MILD" if level == 1
+          return "FREQUENT_INTENSE" if level == 2
+        end
+
+        raise "Unknown level '#{level}' - must be 0, 1 or 2".red
+      end
+  end
+end

data/lib/deliver/itunes_connect/itunes_connect_helper.rb

@@ -0,0 +1,83 @@
+module Deliver  
+  class ItunesConnect
+    # All the private helpers
+    private
+      # Opens the app details page of the given app.
+      # @param app (Deliver::App) the app that should be opened
+      # @return (bool) true if everything worked fine
+      # @raise [ItunesConnectGeneralError] General error while executing 
+      #  this action
+      # @raise [ItunesConnectLoginError] Login data is wrong
+      def open_app_page(app)
+          verify_app(app)
+
+          Helper.log.info "Opening detail page for app #{app}"
+
+          visit APP_DETAILS_URL.gsub("[[app_id]]", app.apple_id.to_s)
+
+          wait_for_elements('.page-subnav')
+          sleep 5
+
+          if current_url.include?"wa/defaultError" # app could not be found
+            raise "Could not open app details for app '#{app}'. Make sure you're using the correct Apple ID and the correct Apple developer account (#{CredentialsManager::PasswordManager.shared_manager.username}).".red
+          end
+
+          true
+      rescue => ex
+        error_occured(ex)
+      end
+
+      
+      def verify_app(app)
+        raise ItunesConnectGeneralError.new("No valid Deliver::App given") unless app.kind_of?Deliver::App
+        raise ItunesConnectGeneralError.new("App is missing information (apple_id not given)") unless (app.apple_id || '').to_s.length > 5
+      end
+
+      def error_occured(ex)
+        snap
+        raise ex # re-raise the error after saving the snapshot
+      end
+
+      def snap
+        path = "Error#{Time.now.to_i}.png"
+        save_screenshot(path, :full => true)
+        system("open '#{path}'")
+      end
+
+      # Since Apple takes for ages, after the upload is properly processed, we have to wait here
+      def wait_for_preprocessing
+        started = Time.now
+
+        # Wait, while iTunesConnect is processing the uploaded file
+        while page.has_content?"Uploaded"
+          # iTunesConnect is super slow... so we have to wait...
+          Helper.log.info("Sorry, we have to wait for iTunesConnect, since it's still processing the uploaded ipa file\n" + 
+            "If this takes longer than 45 minutes, you have to re-upload the ipa file again.\n" + 
+            "You can always open the browser page yourself: '#{current_url}'\n" +
+            "Passed time: ~#{((Time.now - started) / 60.0).to_i} minute(s)")
+          sleep 60
+          visit current_url
+          sleep 10
+        end
+      end
+
+      def wait_for_elements(name)
+        counter = 0
+        results = all(name)
+        while results.count == 0      
+          # Helper.log.debug "Waiting for #{name}"
+          sleep 0.2
+
+          results = all(name)
+
+          counter += 1
+          if counter > 100
+            Helper.log.debug page.html
+            Helper.log.debug caller
+            raise ItunesConnectGeneralError.new("Couldn't find element '#{name}' after waiting for quite some time")
+          end
+        end
+        return results
+      end
+  end
+end