deliver 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 221e6f16252aa538e403f17cdf318edb2dd6ea20
-  data.tar.gz: fb4058c128cc42e5f871714c41c23b521949557e
+  metadata.gz: 1aa9678c4c8f492ca46805f1ac07c306a14c7675
+  data.tar.gz: eb392c8ca031399725e9a106e88599356b7ae508
 SHA512:
-  metadata.gz: 860cdd383422e8e531c73db2bc549d2a56d8db91465275b3c4266746fad5cb2dd7e65b870adf71f81aac5abfe18c387ec76b6905362b697cf725bb3dab8beb6e
-  data.tar.gz: a76927b8bbbcf2b4f63b1a10410f0b55d82c96d6a130d8eb124ed7a345b1ae462d0f6753e4cb0357ef001752c67b56761cd8e68f812d340e6b492d5729d37620
+  metadata.gz: 03ebce1c92b8cf19827ef6a70c7b6a686235e3fa424ff2ad44f46281a8f04d30d80e7077da9661448a7969b0f04afd5cf6a26e87cd4b93d0d813385138bbf0b9
+  data.tar.gz: 5400a931ee5717062c523f47e2e0d828e0f20bf29458d80ea3340b0885899bde6a043020b0d5fbc3d78e9477607469333fdc083b29fa44168393b63c301435b7

data/README.md

@@ -108,7 +108,9 @@ Run ```deliver init``` to create a new ```Deliverfile```. You can either let the
 
 Once you created your configuration, just run ```deliver```.
 
-Here are a few example files:
+All available commands with a short description can be found in [Deliverfile.md](https://github.com/KrauseFx/deliver/blob/master/Deliverfile.md).
+
+Here are a few examples:
 #### Upload screenshots to iTunes Connect
 ```ruby
 app_identifier "net.sunapps.1"
@@ -175,7 +177,7 @@ end
 ```
 
 
-#### Set a default language if you are lucky enough to only maintain one language
+#### Set a default language if you only maintain one language
 ```ruby
 default_language "en-US"
 version "1.2"
@@ -223,7 +225,7 @@ As you can see, the ```Deliverfile``` is a normal Ruby file, which is executed w
 running a deployment. Therefore it's possible to fully customise the behaviour
 on a deployment. 
 
-All available commands with a short description can be found in the [wiki](https://github.com/KrauseFx/deliver/wiki/All-available-commands-of-the-Deliverfile).
+All available commands with a short description can be found in [Deliverfile.md](https://github.com/KrauseFx/deliver/blob/master/Deliverfile.md).
 
 **Some examples:**
 

data/bin/deliver

@@ -3,31 +3,76 @@
 $:.push File.expand_path("../../lib", __FILE__)
 
 require 'deliver'
-require 'commander/import'
+require 'commander'
 
 HighLine.track_eof = false
 
+class FastlaneApplication
+  include Commander::Methods
 
-# Commander
-program :version, Deliver::VERSION
-program :description, 'CLI for \'Deliver\' - Upload screenshots, metadata and your app to the App Store using a single command'
-program :help, 'Author', 'Felix Krause <deliver@krausefx.com>'
-program :help, 'Website', 'http://fastlane.tools'
-program :help, 'GitHub', 'https://github.com/krausefx/deliver'
-program :help_formatter, :compact
+  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 :help, 'Author', 'Felix Krause <deliver@krausefx.com>'
+    program :help, 'Website', 'http://fastlane.tools'
+    program :help, 'GitHub', 'https://github.com/krausefx/deliver'
+    program :help_formatter, :compact
 
-global_option('--verbose') { $verbose = true }
+    global_option('--verbose') { $verbose = true }
 
+    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.option '--beta', 'Runs a deployment to beta build on iTunes Connect'
+      c.option '--skip-deploy', 'Skips deployment on iTunes Connect'
+      c.action do |args, 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
+        end
+      end
+    end
 
-default_command :run
+    command :init do |c|
+      c.syntax = 'deliver init'
+      c.description = "Creates a new Deliverfile in the current directory"
 
-require 'deliver/commands'
+      c.action do |args, options|
+        Deliver::DeliverfileCreator.create(enclosed_directory)
+      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
+
+    default_command :run
+
+    run!
+  end
+end
 
 def deliver_path
-  [enclosed_directory, Deliver::Deliverfile::Deliverfile::FILE_NAME].join('/')
+  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
+end
+
+FastlaneApplication.new.run

data/lib/assets/DeliverfileDefault

@@ -8,10 +8,6 @@
 # App Metadata
 ########################################
 
-# The app identifier is required
-app_identifier "[[APP_IDENTIFIER]]"
-apple_id "[[APPLE_ID]]"
-
 
 # This folder has to include one folder for each language
 # More information about automatic screenshot upload: 
@@ -23,7 +19,6 @@ screenshots_path "./deliver/screenshots/"
 
 config_json_folder './deliver'
 
-
 ########################################
 # Building and Testing
 ########################################

data/lib/deliver.rb

@@ -5,7 +5,7 @@ require 'deliver/app'
 require 'deliver/app_metadata'
 require 'deliver/metadata_item'
 require 'deliver/app_screenshot'
-require 'deliver/itunes_connect'
+require 'deliver/itunes_connect/itunes_connect'
 require 'deliver/itunes_search_api'
 require 'deliver/itunes_transporter'
 require 'deliver/deliverfile/deliverfile'

data/lib/deliver/app.rb

@@ -45,6 +45,7 @@ module Deliver
         rescue
           unless Helper.is_test?
             Helper.log.info "Could not find Apple ID based on the app identifier in the US App Store. Maybe the app is not yet in the store?".yellow
+            Helper.log.info "You can provde the Apple ID of your app using `apple_id '974739333'` in your `Deliverfile`".green
 
             while ((self.apple_id || '').to_s.length == 0) || ((self.apple_id || 0).to_i == 0)
               self.apple_id = ask("\nApple ID of your app (e.g. 284882215): ")
@@ -118,12 +119,12 @@ module Deliver
     end
 
 
-    # # Uploads a new app icon to iTunesConnect. This uses a headless browser
-    # # which makes this command quite slow.
-    # # @param (path) a path to the new app icon. The image must have the resolution of 1024x1024
-    # def update_app_icon!(path)
-    #   itc.update_app_icon!(self, path)
-    # end
+    # Uploads a new app icon to iTunesConnect. This uses a headless browser
+    # which makes this command quite slow.
+    # @param (path) a path to the new app icon. The image must have the resolution of 1024x1024
+    def upload_app_icon!(path)
+      itc.upload_app_icon!(self, path)
+    end
 
     #####################################################
     # @!group Destructive/Constructive methods

data/lib/deliver/app_metadata.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+require 'deliver/app_metadata_screenshots'
 
 module Deliver
   class AppMetadataError < StandardError
@@ -197,157 +198,16 @@ module Deliver
       end
     end
 
-    #####################################################
-    # @!group Screenshot related
-    #####################################################
-
-    # Removes all currently enabled screenshots for the given language.
-    # @param (String) language The language, which has to be in this list: {Deliver::Languages}.
-    def clear_all_screenshots(language)
-      raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
-
-      update_localized_value('software_screenshots', {language => {}}) do |field, useless, language|
-        field.children.remove # remove all the screenshots
-      end
-      information[language][:screenshots] = []
-      true
-    end
-
-    # Appends another screenshot to the already existing ones
-    # @param (String) language The language, which has to be in this list: {Deliver::Languages}.
-    # @param (Deliver::AppScreenshot) app_screenshot The screenshot you want to add to the app metadata.
-    # @raise (AppMetadataTooManyScreenshotsError) When there are already 5 screenshots (MAXIMUM_NUMBER_OF_SCREENSHOTS).
-
-    def add_screenshot(language, app_screenshot)
-      raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
-
-      create_locale_if_not_exists(language)
-
-      # Fetch the 'software_screenshots' node (array) for the specific locale
-      locales = self.fetch_value("//x:locale[@name='#{language}']")
-
-      screenshots = self.fetch_value("//x:locale[@name='#{language}']/x:software_screenshots").first
+    # Updates the price tier of the given app
+    # @param (Integer) tier The tier that should be used from now on
+    def update_price_tier(tier)
+      raise "Price Tier '#{tier}' must be of type integer".red unless tier.kind_of?Integer
+      raise "Invalid price tier '#{tier}' given, must be 0 to 94".red unless (tier.to_i >= 0 and tier.to_i <= 87)
 
-      if not screenshots or screenshots.children.count == 0
-        screenshots.remove if screenshots
-
-        # First screenshot ever
-        screenshots = Nokogiri::XML::Node.new('software_screenshots', @data)
-        locales.first << screenshots
-
-        node_set = Nokogiri::XML::NodeSet.new(@data)
-        node_set << app_screenshot.create_xml_node(@data, 1)
-        screenshots.children = node_set
-      else
-        # There is already at least one screenshot
-        next_index = 1
-        screenshots.children.each do |screen|
-          if screen['display_target'] == app_screenshot.screen_size
-            next_index += 1
-          end
-        end
-
-        if next_index > MAXIMUM_NUMBER_OF_SCREENSHOTS
-          raise AppMetadataTooManyScreenshotsError.new("Only #{MAXIMUM_NUMBER_OF_SCREENSHOTS} screenshots are allowed per language per device type (#{app_screenshot.screen_size})")
-        end
-
-        # Ready for storing the screenshot into the metadata.xml now
-        screenshots.children.after(app_screenshot.create_xml_node(@data, next_index))
-      end
-
-      information[language][:screenshots] << app_screenshot
-
-      app_screenshot.store_file_inside_package(@package_path)
+      price = fetch_value("//x:wholesale_price_tier").last
+      price.content = tier
     end
 
-    # This method will clear all screenshots and set the new ones you pass
-    # @param new_screenshots
-    #   +code+
-    #    {
-    #     'de-DE' => [
-    #       AppScreenshot.new('path/screenshot1.png', Deliver::ScreenSize::IOS_35),
-    #       AppScreenshot.new('path/screenshot2.png', Deliver::ScreenSize::IOS_40),
-    #       AppScreenshot.new('path/screenshot3.png', Deliver::ScreenSize::IOS_IPAD)
-    #     ]
-    #    }
-    # This method uses {#clear_all_screenshots} and {#add_screenshot} under the hood.
-    # @return [bool] true if everything was successful
-    # @raise [AppMetadataParameterError] error is raised when parameters are invalid
-    def set_all_screenshots(new_screenshots)
-      error_text = "Please pass a hash, containing an array of AppScreenshot objects"
-      raise AppMetadataParameterError.new(error_text) unless new_screenshots.kind_of?Hash
-
-      new_screenshots.each do |key, value|
-        if key.kind_of?String and value.kind_of?Array and value.count > 0 and value.first.kind_of?AppScreenshot
-
-          self.clear_all_screenshots(key)
-
-          value.each do |screen|
-            add_screenshot(key, screen)
-          end
-        else
-          raise AppMetadataParameterError.new(error_text)
-        end
-      end
-      true
-    end
-
-    # Automatically add all screenshots contained in the given directory to the app.
-    #
-    # This method will automatically detect which device type each screenshot is.
-    #
-    # This will also clear all existing screenshots before setting the new ones.
-    # @param (Hash) hash A hash containing a different path for each locale ({Deliver::Languages::ALL_LANGUAGES})
-    def set_screenshots_for_each_language(hash)
-      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|
-        resulting_path = "#{current_path}/**/*.{png,jpg,jpeg}"
-
-        raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
-
-        # https://stackoverflow.com/questions/21688855/
-        # File::FNM_CASEFOLD = ignore case
-        if Dir.glob(resulting_path, File::FNM_CASEFOLD).count == 0
-          Helper.log.error("No screenshots found at the given path '#{resulting_path}'")
-        else
-          self.clear_all_screenshots(language)
-
-          Dir.glob(resulting_path, File::FNM_CASEFOLD).sort.each do |path|
-            next if path.include?"_framed."
-
-            begin
-              add_screenshot(language, Deliver::AppScreenshot.new(path))
-            rescue AppMetadataTooManyScreenshotsError => ex
-              # We just use the first 5 ones
-            end
-          end
-        end
-      end
-
-      true
-    end
-
-    # 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)
-      raise AppMetadataParameterError.new("Parameter needs to be a path (string)") unless path.kind_of?String
-
-      found = false
-      Deliver::Languages::ALL_LANGUAGES.each do |language|
-        full_path = path + "/#{language}"
-        if File.directory?(full_path)
-          found = true
-          set_screenshots_for_each_language({
-            language => full_path
-          })
-        end
-      end
-      return found
-    end
-
-
     #####################################################
     # @!group Manually fetching elements from the metadata.xml
     #####################################################

data/lib/deliver/app_metadata_screenshots.rb

@@ -0,0 +1,153 @@
+module Deliver
+  class AppMetadata
+    #####################################################
+    # @!group Screenshot related
+    #####################################################
+
+    # Removes all currently enabled screenshots for the given language.
+    # @param (String) language The language, which has to be in this list: {Deliver::Languages}.
+    def clear_all_screenshots(language)
+      raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
+
+      update_localized_value('software_screenshots', {language => {}}) do |field, useless, language|
+        field.children.remove # remove all the screenshots
+      end
+      information[language][:screenshots] = []
+      true
+    end
+
+    # Appends another screenshot to the already existing ones
+    # @param (String) language The language, which has to be in this list: {Deliver::Languages}.
+    # @param (Deliver::AppScreenshot) app_screenshot The screenshot you want to add to the app metadata.
+    # @raise (AppMetadataTooManyScreenshotsError) When there are already 5 screenshots (MAXIMUM_NUMBER_OF_SCREENSHOTS).
+
+    def add_screenshot(language, app_screenshot)
+      raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
+
+      create_locale_if_not_exists(language)
+
+      # Fetch the 'software_screenshots' node (array) for the specific locale
+      locales = self.fetch_value("//x:locale[@name='#{language}']")
+
+      screenshots = self.fetch_value("//x:locale[@name='#{language}']/x:software_screenshots").first
+
+      if not screenshots or screenshots.children.count == 0
+        screenshots.remove if screenshots
+
+        # First screenshot ever
+        screenshots = Nokogiri::XML::Node.new('software_screenshots', @data)
+        locales.first << screenshots
+
+        node_set = Nokogiri::XML::NodeSet.new(@data)
+        node_set << app_screenshot.create_xml_node(@data, 1)
+        screenshots.children = node_set
+      else
+        # There is already at least one screenshot
+        next_index = 1
+        screenshots.children.each do |screen|
+          if screen['display_target'] == app_screenshot.screen_size
+            next_index += 1
+          end
+        end
+
+        if next_index > MAXIMUM_NUMBER_OF_SCREENSHOTS
+          raise AppMetadataTooManyScreenshotsError.new("Only #{MAXIMUM_NUMBER_OF_SCREENSHOTS} screenshots are allowed per language per device type (#{app_screenshot.screen_size})")
+        end
+
+        # Ready for storing the screenshot into the metadata.xml now
+        screenshots.children.after(app_screenshot.create_xml_node(@data, next_index))
+      end
+
+      information[language][:screenshots] << app_screenshot
+
+      app_screenshot.store_file_inside_package(@package_path)
+    end
+
+    # This method will clear all screenshots and set the new ones you pass
+    # @param new_screenshots
+    #   +code+
+    #    {
+    #     'de-DE' => [
+    #       AppScreenshot.new('path/screenshot1.png', Deliver::ScreenSize::IOS_35),
+    #       AppScreenshot.new('path/screenshot2.png', Deliver::ScreenSize::IOS_40),
+    #       AppScreenshot.new('path/screenshot3.png', Deliver::ScreenSize::IOS_IPAD)
+    #     ]
+    #    }
+    # This method uses {#clear_all_screenshots} and {#add_screenshot} under the hood.
+    # @return [bool] true if everything was successful
+    # @raise [AppMetadataParameterError] error is raised when parameters are invalid
+    def set_all_screenshots(new_screenshots)
+      error_text = "Please pass a hash, containing an array of AppScreenshot objects"
+      raise AppMetadataParameterError.new(error_text) unless new_screenshots.kind_of?Hash
+
+      new_screenshots.each do |key, value|
+        if key.kind_of?String and value.kind_of?Array and value.count > 0 and value.first.kind_of?AppScreenshot
+
+          self.clear_all_screenshots(key)
+
+          value.each do |screen|
+            add_screenshot(key, screen)
+          end
+        else
+          raise AppMetadataParameterError.new(error_text)
+        end
+      end
+      true
+    end
+
+    # Automatically add all screenshots contained in the given directory to the app.
+    #
+    # This method will automatically detect which device type each screenshot is.
+    #
+    # This will also clear all existing screenshots before setting the new ones.
+    # @param (Hash) hash A hash containing a different path for each locale ({Deliver::Languages::ALL_LANGUAGES})
+    def set_screenshots_for_each_language(hash)
+      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|
+        resulting_path = "#{current_path}/**/*.{png,jpg,jpeg}"
+
+        raise AppMetadataParameterError.new(INVALID_LANGUAGE_ERROR) unless Languages::ALL_LANGUAGES.include?language
+
+        # https://stackoverflow.com/questions/21688855/
+        # File::FNM_CASEFOLD = ignore case
+        if Dir.glob(resulting_path, File::FNM_CASEFOLD).count == 0
+          Helper.log.error("No screenshots found at the given path '#{resulting_path}'")
+        else
+          self.clear_all_screenshots(language)
+
+          Dir.glob(resulting_path, File::FNM_CASEFOLD).sort.each do |path|
+            next if path.include?"_framed."
+
+            begin
+              add_screenshot(language, Deliver::AppScreenshot.new(path))
+            rescue AppMetadataTooManyScreenshotsError => ex
+              # We just use the first 5 ones
+            end
+          end
+        end
+      end
+
+      true
+    end
+
+    # 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)
+      raise AppMetadataParameterError.new("Parameter needs to be a path (string)") unless path.kind_of?String
+
+      found = false
+      Deliver::Languages::ALL_LANGUAGES.each do |language|
+        full_path = path + "/#{language}"
+        if File.directory?(full_path)
+          found = true
+          set_screenshots_for_each_language({
+            language => full_path
+          })
+        end
+      end
+      return found
+    end
+  end
+end