deliver 0.13.5 → 1.0.0.beta1

data/lib/deliver/app_screenshot.rb

@@ -1,10 +1,9 @@
 require 'fastimage'
 
-
 module Deliver
-  # AppScreenshot represents one screenshots for one specific locale and 
+  # AppScreenshot represents one screenshots for one specific locale and
   # device type.
-  class AppScreenshot < MetadataItem
+  class AppScreenshot
     module ScreenSize
       # iPhone 4
       IOS_35 = "iOS-3.5-in"
@@ -16,8 +15,8 @@ module Deliver
       IOS_55 = "iOS-5.5-in"
       # iPad
       IOS_IPAD = "iOS-iPad"
-      #  Watch
-      IOS_APPLE_WATCH= "iOS-Apple-Watch"
+      # Apple Watch
+      IOS_APPLE_WATCH = "iOS-Apple-Watch"
       # Mac
       MAC = "Mac"
     end
@@ -26,12 +25,17 @@ module Deliver
     #  specified at {Deliver::ScreenSize}
     attr_accessor :screen_size
 
+    attr_accessor :path
+
+    attr_accessor :language
+
     # @param path (String) path to the screenshot file
+    # @param path (String) Language of this screenshot (e.g. English)
     # @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)
-
+    def initialize(path, language, screen_size = nil)
+      self.path = path
+      self.language = language
       screen_size ||= self.class.calculate_screen_size(path)
 
       self.screen_size = screen_size
@@ -39,41 +43,47 @@ module Deliver
       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
+    # The iTC API requires a different notation for the device
+    def device_type
+      matching = {
+        ScreenSize::IOS_35 => "iphone35",
+        ScreenSize::IOS_40 => "iphone4",
+        ScreenSize::IOS_47 => "iphone6",
+        ScreenSize::IOS_55 => "iphone6Plus",
+        ScreenSize::IOS_IPAD => "ipad",
+        ScreenSize::MAC => "mac",
+        ScreenSize::IOS_APPLE_WATCH => "Watch"
+      }
+      return matching[self.screen_size]
     end
 
-    def name_for_xml_node
-      'software_screenshot'
+    # Nice name
+    def formatted_name
+      matching = {
+        ScreenSize::IOS_35 => "iPhone 4",
+        ScreenSize::IOS_40 => "iPhone 5",
+        ScreenSize::IOS_47 => "iPhone 6",
+        ScreenSize::IOS_55 => "iPhone 6 Plus",
+        ScreenSize::IOS_IPAD => "iPad",
+        ScreenSize::MAC => "Mac",
+        ScreenSize::IOS_APPLE_WATCH => "Watch"
+      }
+      return matching[self.screen_size]
     end
 
     # Validates the given screenshots (size and format)
+    # rubocop:disable Style/PredicateName
     def is_valid?
-      return false unless ["png", "PNG", "jpg", "JPG", "jpeg", "JPEG"].include? self.path.split(".").last
-
-      size = FastImage.size(self.path)
+      return false unless ["png", "PNG", "jpg", "JPG", "jpeg", "JPEG"].include?(self.path.split(".").last)
 
       return self.screen_size == self.class.calculate_screen_size(self.path)
     end
+    # rubocop:enable Style/PredicateName
 
     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)
+      raise "Could not find or parse file at path '#{path}'" if size.nil? or size.count == 0
 
       devices = {
         ScreenSize::IOS_55 => [
@@ -109,7 +119,7 @@ module Deliver
           [2880, 1800],
           [2560, 1600]
         ],
-        ScreenSize::IOS_APPLE_WATCH=> [
+        ScreenSize::IOS_APPLE_WATCH => [
           [312, 390]
         ]
       }
@@ -117,7 +127,7 @@ module Deliver
       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
+             (size[1] == resolution[0] and size[0] == resolution[1]) # landscape
             return device_type
           end
         end
@@ -128,4 +138,4 @@ module Deliver
   end
 
   ScreenSize = AppScreenshot::ScreenSize
-end
+end

data/lib/deliver/commands_generator.rb

@@ -7,149 +7,71 @@ module Deliver
   class CommandsGenerator
     include Commander::Methods
 
-    def self.start(def_command = nil)
-      begin
-        FastlaneCore::UpdateChecker.start_looking_for_update('deliver')
-        Deliver::DependencyChecker.check_dependencies
-        self.new.run(def_command)
-      ensure
-        FastlaneCore::UpdateChecker.show_update_status('deliver', Deliver::VERSION)
-      end
+    def self.start
+      FastlaneCore::UpdateChecker.start_looking_for_update('deliver')
+      self.new.run
+    ensure
+      FastlaneCore::UpdateChecker.show_update_status('deliver', Deliver::VERSION)
     end
 
-    def run(def_command = nil)
-      def_command ||= :run
+    def run
       program :version, Deliver::VERSION
-      program :description, 'CLI for \'deliver\' - Upload screenshots, metadata and your app to the App Store using a single command'
+      program :description, Deliver::DESCRIPTION
       program :help, 'Author', 'Felix Krause <deliver@krausefx.com>'
       program :help, 'Website', 'https://fastlane.tools'
       program :help, 'GitHub', 'https://github.com/krausefx/deliver'
       program :help_formatter, :compact
 
-      always_trace!
+      FastlaneCore::CommanderGenerator.new.generate(Deliver::Options.available_options)
 
-      global_option '-f', '--force', 'Runs a deployment without verifying any information (PDF file). This can be used for build servers.'
-      global_option '--beta', 'Upload a beta build to iTunes Connect. This uses the `beta_ipa` block.'
-      global_option '--skip-deploy', 'Skips submission of the build on iTunes Connect. This will only upload the ipa and/or metadata.'
-
-      def show_itc_error
-        Helper.log.fatal "A big iTunes Connect Update was released on 24th September".red
-        Helper.log.fatal "Most parts of `deliver` don't work with it (yet)".red
-        Helper.log.fatal "I'm working on an update for deliver to push a new version ASAP".red
-        Helper.log.fatal "More information about the current status on GitHub".red
-        Helper.log.fatal "https://github.com/KrauseFx/deliver/issues/337".red
-        Helper.log.fatal "https://github.com/KrauseFx/deliver/pull/259".red
-        sleep 5
-      end
+      global_option('--verbose') { $verbose = true }
 
-      show_itc_error
+      always_trace!
 
       command :run do |c|
         c.syntax = 'deliver'
-        c.description = 'Run a deploy process using the Deliverfile in the current folder'
-        c.action do |args, options|
-          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.description = 'Upload metadata and binary to iTunes Connect'
         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
-            options.default :beta => false, :skip_deploy => false
-            Deliver::Deliverer.new(deliver_path, force: options.force, is_beta_ipa: options.beta, skip_deploy: options.skip_deploy)
-          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
+          options = FastlaneCore::Configuration.create(Deliver::Options.available_options, options.__hash__)
+          options.load_configuration_file("Deliverfile")
+          Deliver::Runner.new(options).run
         end
       end
 
       command :init do |c|
         c.syntax = 'deliver init'
-        c.option '-u', '--username String', String, 'Your Apple ID'
-        c.description = "Creates a new Deliverfile in the current directory"
-
+        c.description = 'Create the initial `deliver` configuration based on an existing app'
         c.action do |args, options|
-          set_username(options.username)
+          if File.exist?("Deliverfile") or File.exist?("fastlane/Deliverfile")
+            Helper.log.info "You already got a running deliver setup in this directory".yellow
+            return 0
+          end
 
-          path = (Deliver::Helper.fastlane_enabled?? './fastlane' : '.')
-          Deliver::DeliverfileCreator.create(path)
+          require 'deliver/setup'
+          options = FastlaneCore::Configuration.create(Deliver::Options.available_options, options.__hash__)
+          Deliver::Runner.new(options) # to login...
+          Deliver::Setup.new.run(options)
         end
       end
 
       command :download_screenshots do |c|
         c.syntax = 'deliver download_screenshots'
         c.description = "Downloads all existing screenshots from iTunes Connect and stores them in the screenshots folder"
-        c.option '-a', '--app_identifier String', String, 'The App Identifier (e.g. com.krausefx.app)'
-        c.option '-u', '--username String', String, 'Your Apple ID'
-        c.action do |args, options|
-          set_username(options.username)
-
-          app_identifier = options.app_identifier || CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) || ask("Please enter the app's bundle identifier: ")
-          app = Deliver::App.new(app_identifier: app_identifier)
-
-          path = (Deliver::Helper.fastlane_enabled?? './fastlane' : '.')
-          path = File.join(path, "deliver")
-
-          Deliver::DownloadScreenshots.run(app, path)
-        end
-      end
-
-      command :testflight do |c|
-        c.syntax = 'deliver testflight'
-        c.description = "Uploads a given ipa file to the new Apple TestFlight"
-        c.option '-a', '--app_id String', String, 'The App ID (numeric, like 956814360)'
-        c.option '-u', '--username String', String, 'Your Apple ID'
 
         c.action do |args, options|
-          ipa_path = (args.first || determine_ipa) + '' # unfreeze the string
+          options = FastlaneCore::Configuration.create(Deliver::Options.available_options, options.__hash__)
+          options.load_configuration_file("Deliverfile")
+          Deliver::Runner.new(options) # to login...
 
-          set_username(options.username)
+          path = (FastlaneCore::Helper.fastlane_enabled? ? './fastlane' : '.')
 
-          Deliver::Testflight.upload!(ipa_path, options.app_id, options.skip_deploy)
+          Deliver::DownloadScreenshots.run(options, path)
         end
       end
 
-      def set_username(username)
-        user = username
-        user ||= ENV["DELIVER_USERNAME"]
-        user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
-        CredentialsManager::PasswordManager.shared_manager(user) if user
-      end
-
-      def determine_ipa
-        return Dir['*.ipa'].first if Dir["*.ipa"].count == 1
-        loop do
-          path = ask("Path to IPA file to upload: ".green)
-          return path if File.exists?(path)
-        end
-      end
-
-      def deliver_path
-        File.join(enclosed_directory, Deliver::Deliverfile::Deliverfile::FILE_NAME)
-      end
-
-      # The directoy in which the Deliverfile and metadata should be created
-      def enclosed_directory
-        "."
-      end
-
-      default_command def_command
+      default_command :run
 
       run!
     end
   end
-end
+end

data/lib/deliver/detect_values.rb

@@ -0,0 +1,23 @@
+module Deliver
+  class DetectValues
+    def run!(options)
+      find_app(options)
+      find_folders(options)
+    end
+
+    def find_app(options)
+      search_by = options[:app_identifier]
+      search_by = options[:app] if search_by.to_s.length == 0
+      options[:app] = Spaceship::Application.find(search_by)
+    end
+
+    def find_folders(options)
+      containing = Helper.fastlane_enabled? ? './fastlane' : '.'
+      options[:screenshots_path] ||= File.join(containing, 'screenshots')
+      options[:metadata_folder] ||= File.join(containing, 'metadata')
+
+      FileUtils.mkdir_p(options[:screenshots_path])
+      FileUtils.mkdir_p(options[:metadata_folder])
+    end
+  end
+end

data/lib/deliver/download_screenshots.rb

@@ -1,14 +1,35 @@
 module Deliver
   class DownloadScreenshots
-    def self.run(app, path)
-      begin
-        Helper.log.info "Downloading all existing screenshots...".green
-        ItunesConnect.new.download_existing_screenshots(app, path)
-        Helper.log.info "Successfully downloaded all existing screenshots".green
-      rescue Exception => ex
-        Helper.log.error ex
-        Helper.log.error "Couldn't download already existing screenshots from iTunesConnect.".red
+    def self.run(options, path)
+      Helper.log.info "Downloading all existing screenshots...".green
+      download(options, path)
+      Helper.log.info "Successfully downloaded all existing screenshots".green
+    rescue => ex
+      Helper.log.error ex
+      Helper.log.error "Couldn't download already existing screenshots from iTunesConnect.".red
+    end
+
+    def self.download(options, folder_path)
+      v = options[:app].latest_version
+
+      v.screenshots.each do |language, screenshots|
+        screenshots.each do |screenshot|
+          file_name = [screenshot.sort_order, screenshot.device_type, screenshot.sort_order].join("_")
+          original_file_extension = File.basename(screenshot.original_file_name)
+          file_name += "." + original_file_extension
+
+          Helper.log.info "Downloading existing screenshot '#{file_name}'"
+
+          containing_folder = File.join(folder_path, "screenshots", screenshot.language)
+          begin
+            FileUtils.mkdir_p(containing_folder)
+          rescue
+            # if it's already there
+          end
+          path = File.join(containing_folder, file_name)
+          File.write(path, open(screenshot.url).read)
+        end
       end
     end
   end
-end
+end

data/lib/deliver/html_generator.rb

@@ -1,21 +1,20 @@
 module Deliver
   class HtmlGenerator
-    # 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 HTML file should be generated
-    # @param export_path (String) The path to a folder where the resulting HTML file should be stored. 
-    def render(deliverer, export_path = nil)
+    # Renders all data available to quickly see if everything was correctly generated.
+    # @param export_path (String) The path to a folder where the resulting HTML file should be stored.
+    def render(options, screenshots, export_path = nil)
       lib_path = Helper.gem_path('deliver')
-      
-      @data = deliverer.app.metadata.information
+
+      @screenshots = screenshots || []
+      @options = options
 
       html_path = File.join(lib_path, "lib/assets/summary.html.erb")
       html = ERB.new(File.read(html_path)).result(binding) # http://www.rrn.dk/rubys-erb-templating-system
 
-      export_path ||= ENV["DELIVER_HTML_EXPORT_PATH"] || '.' # DELIVER_HTML_EXPORT_PATH used in tests to use /tmp
       export_path = File.join(export_path, "Preview.html")
       File.write(export_path, html)
 
       return export_path
     end
   end
-end
+end

data/lib/deliver/options.rb

@@ -0,0 +1,126 @@
+require 'fastlane_core'
+require 'credentials_manager'
+
+module Deliver
+  class Options
+    def self.available_options
+      @options ||= [
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "DELIVER_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)),
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "DELIVER_APP_IDENTIFIER",
+                                     description: "The bundle identifier of your app",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
+        FastlaneCore::ConfigItem.new(key: :app,
+                                     short_option: "-p",
+                                     env_name: "DELIVER_APP_ID",
+                                     description: "The app ID of the app you want to use/modify",
+                                     is_string: false), # don't add any verification here, as it's used to store a spaceship ref
+        FastlaneCore::ConfigItem.new(key: :ipa,
+                                     short_option: "-i",
+                                     optional: true,
+                                     env_name: "DELIVER_IPA_PATH",
+                                     description: "Path to your ipa file",
+                                     default_value: Dir["*.ipa"].first,
+                                     verify_block: proc do |value|
+                                       raise "Could not find ipa file at path '#{value}'".red unless File.exist?(value)
+                                       raise "'#{value}' doesn't seem to be an ipa file".red unless value.end_with?(".ipa")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :metadata_folder,
+                                     short_option: '-m',
+                                     description: "Path to the folder containing the metadata files",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :screenshots_path,
+                                     short_option: '-w',
+                                     description: "Path to the folder containing the screenshots",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :skip_metadata,
+                                     description: "Only upload the build - no metadata",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :force,
+                                     short_option: "-f",
+                                     description: "Skip the HTML file verification",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :submit_for_review,
+                                     description: "Submit the new version for Review after uploading everything",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :price_tier,
+                                     short_option: "-r",
+                                     description: "The price tier of this application",
+                                     is_string: false,
+                                     optional: true),
+
+        # App Metadata
+        # Non Localised
+        FastlaneCore::ConfigItem.new(key: :app_icon,
+                                     description: "Metadata: The path to the app icon",
+                                     optional: true,
+                                     short_option: "-l",
+                                     verify_block: proc do |value|
+                                       raise "Could not find png file at path '#{value}'".red unless File.exist?(value)
+                                       raise "'#{value}' doesn't seem to be a png file".red unless value.end_with?(".png")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :apple_watch_app_icon,
+                                     description: "Metadata: The path to the Apple Watch app icon",
+                                     optional: true,
+                                     short_option: "-q",
+                                     verify_block: proc do |value|
+                                       raise "Could not find png file at path '#{value}'".red unless File.exist?(value)
+                                       raise "'#{value}' doesn't seem to be a png file".red unless value.end_with?(".png")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :copyright,
+                                     description: "Metadata: The copyright notice",
+                                     optional: true,
+                                     is_string: true),
+        FastlaneCore::ConfigItem.new(key: :primary_category,
+                                     description: "Metadata: The english name of the primary category(e.g. `Business`, `Books`)",
+                                     optional: true,
+                                     is_string: true),
+        FastlaneCore::ConfigItem.new(key: :secondary_category,
+                                     description: "Metadata: The english name of the secondary category(e.g. `Business`, `Books`)",
+                                     optional: true,
+                                     is_string: true),
+        FastlaneCore::ConfigItem.new(key: :app_review_information,
+                                     description: "Metadata: A hash containing the review information",
+                                     optional: true,
+                                     is_string: false),
+        # Localised
+        FastlaneCore::ConfigItem.new(key: :description,
+                                     description: "Metadata: The localised app description",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :name,
+                                     description: "Metadata: The localised app name",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :keywords,
+                                     description: "Metadata: An array of localised keywords",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :release_notes,
+                                     description: "Metadata: Localised release notes for this version",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :privacy_url,
+                                     description: "Metadata: Localised privacy url",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :support_url,
+                                     description: "Metadata: Localised support url",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :marketing_url,
+                                     description: "Metadata: Localised marketing url",
+                                     optional: true,
+                                     is_string: false)
+      ]
+    end
+  end
+end