deliver 0.0.1 → 0.1.0

data/lib/deliver/app_screenshot.rb

@@ -0,0 +1,119 @@
+require 'fastimage'
+
+
+module Deliver
+  # AppScreenshot represents one screenshots for one specific locale and 
+  # device type.
+  class AppScreenshot < MetadataItem
+    module ScreenSize
+      # iPhone 4
+      IOS_35 = "iOS-3.5-in"
+      # iPhone 5
+      IOS_40 = "iOS-4-in"
+      # iPhone 6
+      IOS_47 = "iOS-4.7-in"
+      # iPhone 6 Plus
+      IOS_55 = "iOS-5.5-in"
+      # iPad
+      IOS_IPAD = "iOS-iPad"
+    end
+
+    # @return [Deliver::ScreenSize] the screen size (device type)
+    #  specified at {Deliver::ScreenSize}
+    attr_accessor :screen_size
+
+    # @param path (String) path to the screenshot file
+    # @param screen_size (Deliver::AppScreenshot::ScreenSize) the screen size, which
+    #  will automatically be calculated when you don't set it.
+    def initialize(path, screen_size = nil)
+      super(path)
+
+      screen_size ||= self.class.calculate_screen_size(path)
+
+      self.screen_size = screen_size
+
+      Helper.log.error "Looks like the screenshot given (#{path}) does not match the requirements of #{screen_size}" unless self.is_valid?
+    end
+
+    def create_xml_node(doc, order_index)
+      node = super(doc)
+      
+      # Screenshots have a slightly different xml code
+
+      # <software_screenshot display_target="iOS-4-in" position="1">
+      #     <size>295276</size>
+      #     <file_name>1-en-4-StartScreen.png</file_name>
+      #     <checksum type="md5">c00bd122a3ffbc79e26f1ae6210c7efd</checksum>
+      # </software_screenshot>
+
+
+      node['display_target'] = self.screen_size
+      node['position'] = order_index
+
+      return node
+    end
+
+    def name_for_xml_node
+      'software_screenshot'
+    end
+
+    # Validates the given screenshots (size and format)
+    def is_valid?
+      return false unless self.path.split(".").last == "png"
+
+      size = FastImage.size(self.path)
+
+      return self.screen_size == self.class.calculate_screen_size(self.path)
+    end
+
+    def self.calculate_screen_size(path)
+      size = FastImage.size(path)
+
+      raise "Could not find or parse file at path '#{path}'" if (size == nil or size.count == 0)
+
+      devices = {
+        ScreenSize::IOS_55 => [
+          [1080, 1920],
+          [1242, 2208]
+        ],
+        ScreenSize::IOS_47 => [
+          [750, 1334]
+        ],
+        ScreenSize::IOS_40 => [
+          [640, 1136],
+          [640, 1096],
+          [1136, 600] # landscape status bar is smaller
+        ],
+        ScreenSize::IOS_35 => [
+          [640, 960],
+          [640, 920],
+          [960, 600] # landscape status bar is smaller
+        ],
+        ScreenSize::IOS_IPAD => [
+          [1024, 748],
+          [1024, 768],
+          [2048, 1496],
+          [2048, 1536],
+          [768, 1004],
+          [768, 1024],
+          [1536, 2008],
+          [1536, 2048]
+        ]
+      }
+
+      devices.each do |device_type, array|
+        array.each do |resolution|
+          if (size[0] == resolution[0] and size[1] == resolution[1]) or # portrait
+              (size[1] == resolution[0] and size[0] == resolution[1]) # landscape
+            return device_type
+          end
+        end
+      end
+
+      error = "Unsupported screen size #{size} for path '#{path}'"
+      raise error
+    end
+  end
+
+  ScreenSize = AppScreenshot::ScreenSize
+end

data/lib/deliver/commands.rb

@@ -0,0 +1,4 @@
+$:.push File.expand_path('../', __FILE__)
+
+require 'commands/init'
+require 'commands/run'

data/lib/deliver/commands/init.rb

@@ -0,0 +1,12 @@
+
+
+command :init do |c|
+  c.syntax = 'deliver init'
+  c.description = "Creates a new Deliverfile in the current directory"
+
+  c.action do |args, options|
+    Deliver::DependencyChecker.check_dependencies
+
+    Deliver::DeliverfileCreator.create(enclosed_directory)
+  end
+end

data/lib/deliver/commands/run.rb

@@ -0,0 +1,20 @@
+
+
+command :run do |c|
+  c.syntax = 'deliver'
+  c.description = 'Run a deploy process using the Deliverfile in the current folder'
+  c.option '--force', 'Runs a deployment without verifying any information (PDF file). This can be used for build servers.'
+  c.action do |args, options|
+    Deliver::DependencyChecker.check_dependencies
+
+    if File.exists?(deliver_path)
+      # Everything looks alright, use the given Deliverfile
+      Deliver::Deliverer.new(deliver_path, force: options.force)
+    else
+      Deliver::Helper.log.warn("No Deliverfile found at path '#{deliver_path}'.")
+      if agree("Do you want to create a new Deliverfile at the current directory? (y/n)", true)
+        Deliver::DeliverfileCreator.create(enclosed_directory)
+      end
+    end
+  end
+end

data/lib/deliver/deliver_process.rb

@@ -0,0 +1,241 @@
+module Deliver
+  # This class takes care of verifying all inputs and triggering the upload process
+  class DeliverProcess
+
+    # DeliverUnitTestsError is triggered, when the unit tests of the given block failed.
+    class DeliverUnitTestsError < StandardError
+    end
+
+    # @return (Deliver::App) The App that is currently being edited.
+    attr_accessor :app
+
+    # @return (Hash) All the updated/new information we got from the Deliverfile. 
+    #  is used to store the deploy information until the Deliverfile finished running.
+    attr_accessor :deploy_information
+
+    def initialize(deploy_information = nil)
+      @deploy_information = deploy_information || {}
+      @deploy_information[:blocks] ||= {}
+    end
+
+    def run
+      begin
+        run_unit_tests
+        fetch_information_from_ipa_file
+        
+        Helper.log.info("Got all information needed to deploy a new update ('#{@app_version}') for app '#{@app_identifier}'")
+
+        verify_ipa_file
+        create_app
+        verify_app_on_itunesconnect
+
+        load_metadata_from_config_json_folder # the json file generated from the quick start
+        set_app_metadata
+        set_screenshots
+        
+        verify_pdf_file
+
+        trigger_metadata_upload
+        trigger_ipa_upload
+
+        call_success_block
+      rescue Exception => ex
+        call_error_block(ex)
+      end
+    end
+
+    #####################################################
+    # @!group All the methods
+    #####################################################
+
+    def run_unit_tests
+      if @deploy_information[:blocks][:unit_tests]
+        result = @deploy_information[:blocks][:unit_tests].call
+        if result
+          Helper.log.debug("Unit tests successful".green)
+        else
+          raise DeliverUnitTestsError.new("Unit tests failed. Got result: '#{result}'. Need 'true' or 1 to succeed.".red)
+        end
+      end
+    end
+
+    def fetch_information_from_ipa_file
+      @app_version = @deploy_information[Deliverer::ValKey::APP_VERSION]
+      @app_identifier = @deploy_information[Deliverer::ValKey::APP_IDENTIFIER]
+      
+      used_ipa_file = @deploy_information[:ipa] || @deploy_information[:beta_ipa]
+
+      if used_ipa_file
+        @ipa = Deliver::IpaUploader.new(Deliver::App.new, '/tmp/', used_ipa_file, is_beta_build?)
+
+        # We are able to fetch some metadata directly from the ipa file
+        # If they were also given in the Deliverfile, we will compare the values
+        @app_identifier = verify_app_identifier(@app_identifier)
+        @app_version = verify_app_version(@app_version)
+      end
+    end
+
+    def verify_ipa_file
+      raise Deliverfile::Deliverfile::DeliverfileDSLError.new(Deliverfile::Deliverfile::MISSING_APP_IDENTIFIER_MESSAGE.red) unless @app_identifier
+      raise Deliverfile::Deliverfile::DeliverfileDSLError.new(Deliverfile::Deliverfile::MISSING_VERSION_NUMBER_MESSAGE.red) unless @app_version
+      if (@deploy_information[Deliverer::ValKey::IPA] and @deploy_information[Deliverer::ValKey::BETA_IPA])
+        raise Deliverfile::Deliverfile::DeliverfileDSLError.new("You can not set both ipa and beta_ipa in one file. Either it's a beta build or a release build".red) 
+      end
+    end
+
+    def create_app
+      @app = Deliver::App.new(app_identifier: @app_identifier,
+                                    apple_id: @deploy_information[Deliverer::ValKey::APPLE_ID])
+    end
+
+    def verify_app_on_itunesconnect
+      if @ipa and not is_beta_build?
+        # This is a real release, which should also upload the ipa file onto production
+        @app.create_new_version!(@app_version) unless Helper.is_test?
+        @app.metadata.verify_version(@app_version)
+      end
+    end
+
+    def load_metadata_from_config_json_folder
+      return unless @deploy_information[Deliverer::ValKey::CONFIG_JSON_FOLDER]
+
+      matching = {
+        'title' => Deliverer::ValKey::TITLE,
+        'description' => Deliverer::ValKey::DESCRIPTION,
+        'version_whats_new' => Deliverer::ValKey::CHANGELOG,
+        'keywords' => Deliverer::ValKey::KEYWORDS,
+        'privacy_url' => Deliverer::ValKey::PRIVACY_URL,
+        'software_url' => Deliverer::ValKey::MARKETING_URL,
+        'support_url' => Deliverer::ValKey::SUPPORT_URL
+      }
+
+      file_path = @deploy_information[:config_json_folder]
+      unless file_path.split("/").last.include?"metadata.json"
+        file_path += "/metadata.json"
+      end
+
+      raise "Could not find metadatafile at path '#{file_path}'".red unless File.exists?file_path
+
+      content = JSON.parse(File.read(file_path))
+      content.each do |language, current|
+
+        matching.each do |key, value|
+          if current[key]
+            @deploy_information[value] ||= {}
+            @deploy_information[value][language] = current[key]
+          end
+        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]
+
+      @app.metadata.update_support_url(@deploy_information[Deliverer::ValKey::SUPPORT_URL]) if @deploy_information[Deliverer::ValKey::SUPPORT_URL]
+      @app.metadata.update_changelog(@deploy_information[Deliverer::ValKey::CHANGELOG]) if @deploy_information[Deliverer::ValKey::CHANGELOG]
+      @app.metadata.update_marketing_url(@deploy_information[Deliverer::ValKey::MARKETING_URL]) if @deploy_information[Deliverer::ValKey::MARKETING_URL]
+      @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]
+    end
+
+    def set_screenshots
+      screens_path = @deploy_information[Deliverer::ValKey::SCREENSHOTS_PATH]
+      if screens_path
+        if not @app.metadata.set_all_screenshots_from_path(screens_path)
+          # This path does not contain folders for each language
+          if screens_path.kind_of?String
+            if @deploy_information[Deliverer::ValKey::DEFAULT_LANGUAGE]
+              screens_path = { @deploy_information[Deliverer::ValKey::DEFAULT_LANGUAGE] => screens_path } # use the default language
+              @deploy_information[Deliverer::ValKey::SCREENSHOTS_PATH] = screens_path
+            else
+              Helper.log.error "You must have folders for the screenshots (#{screens_path}) for each language (e.g. en-US, de-DE)."
+              screens_path = nil
+            end
+          end
+          @app.metadata.set_screenshots_for_each_language(screens_path) if screens_path
+        end
+      end
+    end
+
+    def verify_pdf_file
+      if @deploy_information[Deliverer::ValKey::SKIP_PDF] or is_beta_build?
+        Helper.log.debug "PDF verify was skipped"
+      else
+        # Everything is prepared for the upload
+        # We may have to ask the user if that's okay
+        pdf_path = PdfGenerator.new.render(self)
+        unless Helper.is_test?
+          puts "----------------------------------------------------------------------------"
+          puts "Verifying the upload via the PDF file can be disabled by either adding"
+          puts "'skip_pdf true' to your Deliverfile or using the flag --force."
+          puts "----------------------------------------------------------------------------"
+
+          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
+        end
+      end
+    end
+
+    def trigger_metadata_upload
+      result = @app.metadata.upload!
+      raise "Error uploading app metadata".red unless result == true
+    end
+
+    def trigger_ipa_upload
+      if @ipa
+        @ipa.app = @app # we now have the resulting app
+        result = @ipa.upload! # Important: this will also actually deploy the app on iTunesConnect
+        raise "Error uploading ipa file".red unless result == true
+      else
+        Helper.log.warn "No IPA file given. Only the metadata was uploaded. If you want to deploy a full update, provide an ipa file."
+      end
+    end
+
+    def call_success_block
+      @deploy_information[:blocks][:success].call if @deploy_information[:blocks][:success]
+    end
+
+    def call_error_block(ex)
+      if @deploy_information[:blocks][:error]
+        # Custom error handling, we just call this one
+        @deploy_information[:blocks][:error].call(ex)
+      else
+        # Re-Raise the exception
+        raise ex
+      end
+    end
+
+    private
+      #####################################################
+      # @!group All the helper methods
+      #####################################################
+      def verify_app_identifier(app_identifier)
+        if app_identifier
+          if @ipa.fetch_app_identifier and app_identifier != @ipa.fetch_app_identifier
+            raise Deliver::Deliverfile::Deliverfile::DeliverfileDSLError.new("App Identifier of IPA does not match with the given one ('#{app_identifier}' != '#{@ipa.fetch_app_identifier}')".red)
+          end
+        else
+          app_identifier = @ipa.fetch_app_identifier
+        end
+        return app_identifier
+      end
+
+      def verify_app_version(app_version)
+        if app_version
+          if @ipa.fetch_app_version and app_version != @ipa.fetch_app_version
+            raise Deliver::Deliverfile::Deliverfile::DeliverfileDSLError.new("App Version of IPA does not match with the given one (#{app_version} != #{@ipa.fetch_app_version})".red)
+          end
+        else
+          app_version = @ipa.fetch_app_version
+        end
+        return app_version
+      end
+
+      def is_beta_build?
+        @deploy_information[Deliverer::ValKey::BETA_IPA] != nil
+      end
+  end
+end

data/lib/deliver/deliverer.rb

@@ -0,0 +1,112 @@
+module Deliver
+  # This class will collect the deploy data from different places
+  # This will trigger:
+  # 
+  # - Parsing the Deliverfile
+  # - Temporary storing all the information got from the file, until the file finished executing
+  # - Triggering the upload process itself using the DeliverProcess class
+  class Deliverer
+    # @return (Deliver::Deliverfile::Deliverfile) A reference
+    #  to the Deliverfile which is currently being used.
+    attr_accessor :deliver_file
+
+    # @return (Deliver::DeliverProcess) The class which handels the deployment process itself
+    attr_accessor :deliver_process
+
+    module ValKey
+      APP_IDENTIFIER = :app_identifier
+      APPLE_ID = :apple_id
+      APP_VERSION = :version
+      IPA = :ipa
+      BETA_IPA = :beta_ipa
+      DESCRIPTION = :description
+      TITLE = :title
+      CHANGELOG = :changelog
+      SUPPORT_URL = :support_url
+      PRIVACY_URL = :privacy_url
+      MARKETING_URL = :marketing_url
+      KEYWORDS = :keywords
+      SCREENSHOTS_PATH = :screenshots_path
+      DEFAULT_LANGUAGE = :default_language
+      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
+    end
+
+    module AllBlocks
+      UNIT_TESTS = :unit_tests
+      SUCCESS = :success
+      ERROR = :error
+    end
+
+    
+    # Start a new deployment process based on the given Deliverfile
+    # @param (String) path The path to the Deliverfile.
+    # @param (Hash) hash You can pass a hash instead of a path to basically
+    #  give all the information required (see {Deliverer::ValKey} for available options)
+    # @param (Bool) force Runs a deployment without verifying any information. This can be 
+    # used for build servers. If this is set to false a PDF summary will be generated and opened
+    def initialize(path = nil, hash: nil, force: false)
+      @deliver_process = DeliverProcess.new
+      @deliver_process.deploy_information[ValKey::SKIP_PDF] = true if force
+
+      if hash
+        hash.each do |key, value|
+          # we still call this interface to verify the inputs correctly
+          set_new_value(key, value)
+        end
+
+        finished_executing_deliver_file
+      else
+        @deliver_file = Deliver::Deliverfile::Deliverfile.new(self, path)
+      end
+
+      # Do not put code here...
+    end
+
+    # This method is internally called from the Deliverfile DSL
+    # to set a value for a given key. This method will also verify if 
+    # the key is valid.
+    def set_new_value(key, value)
+      unless self.class.all_available_keys_to_set.include?key
+        raise "Invalid key '#{key}', must be contained in Deliverer::ValKey.".red
+      end
+
+      if @deliver_process.deploy_information[key]      
+        Helper.log.warn("You already set a value for key '#{key}'. Overwriting value '#{value}' with new value.")
+      end
+
+      @deliver_process.deploy_information[key] = value
+    end
+
+    # Sets a new block for a specific key
+    def set_new_block(key, block)
+      @deliver_process.deploy_information[:blocks][key] = block
+    end
+
+    # An array of all available options to be set a deployment_information.
+    # 
+    # Is used to verify user inputs
+    # @return (Hash) The array of symbols
+    def self.all_available_keys_to_set
+      Deliverer::ValKey.constants.collect { |a| Deliverer::ValKey.const_get(a) }
+    end
+
+    # An array of all available blocks to be set for a deployment
+    # 
+    # Is used to verify user inputs
+    # @return (Hash) The array of symbols
+    def self.all_available_blocks_to_set
+      Deliverer::AllBlocks.constants.collect { |a| Deliverer::AllBlocks.const_get(a) }
+    end
+
+    # This method will take care of the actual deployment process, after we 
+    # received all information from the Deliverfile. 
+    # 
+    # This method will be called from the {Deliver::Deliverfile} after
+    # it is finished executing the Ruby script.
+    def finished_executing_deliver_file
+      deliver_process.run
+    end
+  end
+end