deliver 0.13.5 → 1.0.0.beta1

data/lib/deliver/deliverer.rb

@@ -1,138 +0,0 @@
-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
-      DESCRIPTION = :description
-      TITLE = :title
-      BETA_IPA = :beta_ipa
-      IS_BETA_IPA = :is_beta_ipa
-      SKIP_DEPLOY = :skip_deploy
-      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
-      PRICE_TIER = :price_tier
-      APP_ICON = :app_icon
-      APPLE_WATCH_APP_ICON = :apple_watch_app_icon
-
-      COPYRIGHT = :copyright
-      PRIMARY_CATEGORY = :primary_category
-      SECONDARY_CATEGORY = :secondary_category
-      PRIMARY_SUBCATEGORIES = :primary_subcategories
-      SECONDARY_SUBCATEGORIES = :secondary_subcategories
-      
-      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
-      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, is_beta_ipa: false, skip_deploy: false)
-      @deliver_process = DeliverProcess.new
-      @deliver_process.deploy_information[ValKey::SKIP_PDF] = true if force
-      @deliver_process.deploy_information[ValKey::IS_BETA_IPA] = is_beta_ipa
-      @deliver_process.deploy_information[ValKey::SKIP_DEPLOY] = skip_deploy
-
-      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 with new value '#{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

data/lib/deliver/deliverfile/deliverfile.rb

@@ -1,35 +0,0 @@
-require 'deliver/deliverfile/dsl'
-
-module Deliver
-  module Deliverfile
-    # Deliverfile represents a Deliverfile created by a user of this library
-    class Deliverfile
-
-      FILE_NAME = "Deliverfile"
-
-      include Deliver::Deliverfile::Deliverfile::DSL
-
-      # The path to the used Deliverfile.
-      attr_accessor :path
-
-      # Loads the Deliverfile from the given path
-      # @param deliver_data (Deliver::Deliverer) The deliverer which handles the
-      #  results of running this deliverfile
-      # @param (String) path (optional) to the file itself. This must also include the
-      #  filename itself.
-      def initialize(deliver_data, path = nil)
-        path ||= "./#{FILE_NAME}"
-        raise "#{FILE_NAME} not found at path '#{File.expand_path(path)}'".red unless File.exists?(path.to_s)
-
-        self.path = path
-        @deliver_data = deliver_data
-
-        content = File.read(path)
-
-        eval(content) # this is okay in this case
-
-        @deliver_data.finished_executing_deliver_file
-      end
-    end
-  end
-end

data/lib/deliver/deliverfile/deliverfile_creator.rb

@@ -1,135 +0,0 @@
-require 'credentials_manager/password_manager'
-require 'credentials_manager/appfile_config'
-require 'deliver/itunes_connect/itunes_connect'
-
-module Deliver
-  # Helps new user quickly adopt Deliver
-  class DeliverfileCreator
-
-    # This method will ask the user what he wants to do
-    # @param deliver_path (String) The path in which the Deliverfile should be created (this automatically takes care if it's in the fastlane folder)
-    # @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 = 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
-
-      if agree("Do you want Deliver to automatically create the Deliverfile for you based " + 
-              "on your current app? The app has to be in the App Store to use this feature. (y/n)", true)
-
-        puts "\n\nFirst, you need to login with your iTunesConnect credentials. ".yellow + 
-          "\nThis is necessary to fetch the latest metadata from your app and use it to create a Deliverfile for you." + 
-          "\nIf you have previously entered your credentials already, you will not be asked again."
-
-        if CredentialsManager::PasswordManager.shared_manager.username and CredentialsManager::PasswordManager.shared_manager.password
-          identifier = ((CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) rescue '') || '')
-          while identifier.length < 3
-            identifier = ask("\nApp Identifier of your app (e.g. com.krausefx.app_name): ")
-          end
-
-          self.create_based_on_identifier(deliver_path, identifier, project_name)
-        else
-          self.create_example_deliver_file(deliver_file_path, project_name)
-        end
-      else
-        self.create_example_deliver_file(deliver_file_path, project_name)
-      end
-    end
-
-    # This method is used, when the user does not want to automatically create the Deliverfile
-    # @param path (String) The exact path (including the file name) 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_example_deliver_file(path, project_name)
-      gem_path = Helper.gem_path('deliver')
-      example = File.read("#{gem_path}/lib/assets/DeliverfileExample")
-      example.gsub!("[[APP_NAME]]", project_name)
-      File.write(path, example)
-
-      puts "Successfully created new Deliverfile at '#{path}'".green
-    end
-
-    # This will download all the app metadata and store its data into JSON files
-    # @param deliver_path (String) The directory in which the Deliverfile should be created
-    # @param identifier (String) The app identifier we want to create Deliverfile based on
-    # @param project_name (String) The default name of the project, which is used in the generated Deliverfile
-    def self.create_based_on_identifier(deliver_path, identifier, project_name)
-      app = Deliver::App.new(app_identifier: identifier)
-      app.set_metadata_directory("/tmp") # we don't want to pollute the current folder
-      app.metadata # this will download the latest app metadata
-
-      version_number = app.metadata.fetch_value("//x:version").first["string"] # fetch the latest app version
-      
-      file_path = File.join(deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME)
-      json = generate_deliver_file(app, deliver_path, project_name, version_number)
-      File.write(file_path, json)
-
-      FileUtils.mkdir_p File.join(deliver_path, 'screenshots')
-      begin
-        Helper.log.info "Downloading all previously used app screenshots.".green
-        ItunesConnect.new.download_existing_screenshots(app, deliver_path)
-      rescue Exception => ex
-        Helper.log.error ex
-        Helper.log.error "Couldn't download already existing screenshots from iTunesConnect. You have to add them manually!".red
-      end
-
-      # Add a README to the screenshots folder
-      FileUtils.mkdir_p File.join(deliver_path, 'screenshots') # just in case the fetching didn't work
-      File.write(File.join(deliver_path, 'screenshots', 'README.txt'), File.read("#{Helper.gem_path('deliver')}/lib/assets/ScreenshotsHelp"))
-      
-      Helper.log.info "Successfully created new Deliverfile".green
-    end
-
-    private
-      # This method takes care of creating a new 'deliver' folder, containg the app metadata 
-      # and screenshots folders
-      def self.generate_deliver_file(app, path, project_name, version_number)
-        FileUtils.mkdir_p path rescue nil # never mind if it's already there
-
-        json = create_json_based_on_xml(app, path)
-
-        json.each do |language, value|
-          folder = File.join(path, "metadata", language)
-          FileUtils.mkdir_p(folder)
-          value.each do |key, content|
-            content = content.join("\n") if key == :keywords
-            File.write(File.join(folder, "#{key}.txt"), content)
-          end
-          Helper.log.info "Successfully downloaded existing metadata for language #{language}"
-        end
-        
-        puts "Successfully created new configuration files.".green
-
-        gem_path = Helper.gem_path('deliver')
-
-        # Generate the final Deliverfile here
-        deliver = File.read("#{gem_path}/lib/assets/DeliverfileDefault")
-        deliver.gsub!("[[APP_IDENTIFIER]]", app.app_identifier)
-        deliver.gsub!("[[APP_NAME]]", project_name)
-        deliver.gsub!("[[APPLE_ID]]", app.apple_id.to_s)
-        deliver.gsub!("[[EMAIL]]", CredentialsManager::PasswordManager.shared_manager.username)
-        deliver.gsub!("[[APP_VERSION]]", version_number)
-
-        return deliver
-      end
-
-      # Access the app metadata and use them to create a finished Deliverfile
-      def self.create_json_based_on_xml(app, path)
-        json = {}
-        # Access the app metadata and use them to create a finished Deliverfile
-        app_name = app.metadata.information.each do |locale, current|
-          current.each do |key, value|
-            if value and value.kind_of?Hash # that does not apply for screenshots, which is an array
-              current[key] = value[:value] 
-            else
-              current.delete(key)
-            end
-          end
-
-          json[locale] = current
-        end
-
-        return json
-      end
-  end
-end

data/lib/deliver/deliverfile/dsl.rb

@@ -1,142 +0,0 @@
-# Inspired by https://github.com/CocoaPods/Core/blob/master/lib/cocoapods-core/podfile/dsl.rb
-require 'credentials_manager/password_manager'
-
-module Deliver
-  module Deliverfile
-    class Deliverfile
-      module DSL
-        MISSING_VALUE_ERROR_MESSAGE = "You have to pass either a value or a block to the given method."
-        SPECIFY_LANGUAGE_FOR_VALUE = "You have to specify the language of the given value. Either set a default language using 'default_language \"en-US\"' on the top of the file or pass a hash containing the language codes"
-
-        MISSING_APP_IDENTIFIER_MESSAGE = "You have to pass a valid app identifier using the Deliver file. (e.g. 'app_identifier \"net.sunapps.app\"')"
-        MISSING_VERSION_NUMBER_MESSAGE = "You have to pass a valid version number using the Deliver file. (e.g. 'version \"1.0\"')"
-        INVALID_IPA_FILE_GIVEN = "The given ipa file seems to be wrong. Make sure it's a valid ipa file."
-
-        class DeliverfileDSLError < StandardError
-        end
-
-        # 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, :copyright, :primary_category, :secondary_category,
-                            :primary_subcategories, :secondary_subcategories,
-                            :automatic_release, :app_review_information, :ratings_config_path, :price_tier,
-                            :app_icon, :apple_watch_app_icon]
-
-          if allowed.include?(method_sym)
-            value = arguments.first
-            value = block.call if (value == nil and block != nil)
-
-            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)
-            end
-
-            if (not value.kind_of?Hash) and (not not_translated.include?method_sym)
-              # The user should pass a hash for multi-lang values
-              # Maybe he at least set a default language
-              if @default_language
-                value = { @default_language => value }
-              else
-                raise DeliverfileDSLError.new(SPECIFY_LANGUAGE_FOR_VALUE.red)
-              end
-            end
-
-            @deliver_data.set_new_value(method_sym, value)
-          else
-            # Check if it's a block (e.g. run tests)
-            if Deliver::Deliverer.all_available_blocks_to_set.include?method_sym
-              if block
-                @deliver_data.set_new_block(method_sym, block)
-              else
-                raise DeliverfileDSLError.new("Value for #{method_sym} must be a Ruby block. Use '#{method_sym}' do ... end.".red)
-              end
-            else
-              # Couldn't find this particular method
-              Helper.log.error("Could not find method '#{method_sym}'. Available methods: #{allowed.collect { |a| a.to_s }}")
-            end
-          end
-        end
-
-        # This method can be used to set a default language, which is used
-        # when passing a string to metadata changes, instead of a hash
-        # containing multiple languages.
-        #
-        # This is approach only is recommend for deployments where you are only
-        # supporting one language.
-        #
-        # The language itself must be included in {FastlaneCore::Languages::ALL_LANGUAGES}.
-        # @example
-        #  default_language 'en-US'
-        # @example
-        #  default_language 'de-DE'
-        def default_language(value = nil)
-          # Verify, default_language is on the top of the file
-          already_set = @deliver_data.deliver_process.deploy_information
-          minimum = (already_set[:skip_pdf] ? 4 : 3) # skip_pdf + blocks
-          if already_set.count > minimum
-            raise "'default_language' must be on the top of the Deliverfile.".red
-          end
-
-
-          @default_language = value
-          @default_language ||= yield if block_given?
-          Helper.log.debug("Set default language to #{@default_language}")
-          @deliver_data.set_new_value(:default_language, @default_language)
-        end
-
-        # Pass the path to the ipa file which should be uploaded
-        # @raise (DeliverfileDSLError) occurs when you pass an invalid path to the
-        #  IPA file.
-        def ipa(value = nil, &block)
-          DSL.validate_ipa!(value) if value # to catch errors early
-
-          @deliver_data.set_new_value(Deliverer::ValKey::IPA, (value || block))
-        end
-
-        # Pass the path to the ipa file (beta version) which should be uploaded
-        # @raise (DeliverfileDSLError) occurs when you pass an invalid path to the
-        #  IPA file.
-        def beta_ipa(value = nil, &block)
-          DSL.validate_ipa!(value) if value # to catch errors early
-
-          @deliver_data.set_new_value(Deliverer::ValKey::BETA_IPA, (value || block))
-        end
-
-        # This will set the email address of the Apple ID to be used
-        def email(value)
-          value ||= yield if block_given?
-          CredentialsManager::PasswordManager.logout # if it was logged in already (with fastlane)
-          CredentialsManager::PasswordManager.shared_manager(value)
-        end
-
-        # This will hide the output of the iTunes Connect transporter while uploading/downloading
-        def hide_transporter_output
-          ItunesTransporter.hide_transporter_output
-        end
-
-        # Set the apps new version number.
-        #
-        # If you do not set this, it will automatically being fetched from the
-        # IPA file.
-        def version(value = nil)
-          value ||= yield if block_given?
-          raise DeliverfileDSLError.new(MISSING_VALUE_ERROR_MESSAGE.red) unless value
-          raise DeliverfileDSLError.new("The app version should be a string".red) unless value.kind_of?(String)
-
-          @deliver_data.set_new_value(Deliverer::ValKey::APP_VERSION, value)
-        end
-
-        # Only verifies the file type of the ipa path and if the file can be found. Is also called from deliver_process
-        # This will raise a DeliverfileDSLError if something goes wrong
-        def self.validate_ipa!(value)
-          raise DeliverfileDSLError.new(INVALID_IPA_FILE_GIVEN.red) unless value
-          raise DeliverfileDSLError.new(INVALID_IPA_FILE_GIVEN.red) unless value.kind_of?String
-          raise DeliverfileDSLError.new(INVALID_IPA_FILE_GIVEN.red) unless value.include?".ipa"
-        end
-      end
-    end
-  end
-end