deliver 0.0.1 → 0.1.0

data/lib/deliver/deliverfile/deliverfile.rb

@@ -0,0 +1,35 @@
+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 '#{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

@@ -0,0 +1,115 @@
+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
+    # @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("/")
+      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? (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 Deliver::PasswordManager.new.username and Deliver::PasswordManager.new.password
+          identifier = ''
+          while identifier.length < 3
+            identifier = ask("\nApp Identifier of your app (e.g. at.felixkrause.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)
+      example = File.read("#{gem_path}/lib/assets/DeliverfileExample")
+      example.gsub!("[[APP_NAME]]", project_name)
+      File.write(path, example)
+
+      FileUtils.mkdir_p './screenshots/'
+
+      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
+      
+      file_path = [deliver_path, Deliver::Deliverfile::Deliverfile::FILE_NAME].join('/')
+      json = generate_deliver_file(app, deliver_path, project_name)
+      File.write(file_path, json)
+      
+      puts "Successfully created new Deliverfile at '#{file_path}'".green
+    end
+
+    private
+      def self.gem_path
+        Gem::Specification.find_by_name("deliver").gem_dir
+      end
+
+      # 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)
+        metadata_path = "#{path}/deliver/"
+        FileUtils.mkdir_p metadata_path
+
+        json = create_json_based_on_xml(app, metadata_path)
+        
+        meta_path = "#{metadata_path}metadata.json"
+        File.write(meta_path, JSON.pretty_generate(json))
+        puts "Successfully created new metadata JSON file at '#{meta_path}'".green
+
+        # Add a README to the screenshots folder
+        File.write("#{metadata_path}screenshots/README.txt", File.read("#{gem_path}/lib/assets/ScreenshotsHelp"))
+
+        # 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)
+
+        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
+
+          # Create an empty folder for the screenshots too
+          FileUtils.mkdir_p "#{path}screenshots/#{locale}/"
+        end
+
+        return json
+      end
+  end
+end

data/lib/deliver/deliverfile/dsl.rb

@@ -0,0 +1,124 @@
+# Inspired by https://github.com/CocoaPods/Core/blob/master/lib/cocoapods-core/podfile/dsl.rb
+
+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\"' 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, :beta_ipa, :app_identifier, :apple_id, :screenshots_path, :config_json_folder, :submit_further_information]
+
+          if allowed.include?(method_sym)
+            value = arguments.first || block.call
+
+            unless value
+              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 value.kind_of?String 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 {Deliver::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] ? 2 : 1) # 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)
+          value ||= yield if block_given?
+          validate_ipa(value)
+
+          @deliver_data.set_new_value(Deliverer::ValKey::IPA, value)
+        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)
+          value ||= yield if block_given?
+          validate_ipa(value)
+
+          @deliver_data.set_new_value(Deliverer::ValKey::BETA_IPA, value)
+        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
+        
+        private
+          def validate_ipa(value)
+            raise DeliverfileDSLError.new(INVALID_IPA_FILE_GIVEN.red) unless value
+            raise DeliverfileDSLError.new(INVALID_IPA_FILE_GIVEN.red) unless value.include?".ipa"
+          end
+      end
+    end
+  end
+end

data/lib/deliver/dependency_checker.rb

@@ -0,0 +1,32 @@
+module Deliver
+  class DependencyChecker
+    def self.check_dependencies
+      self.check_phantom_js
+      self.check_xcode_select
+    end
+    
+    def self.check_phantom_js
+      if `which phantomjs`.length == 0
+        # Missing brew dependency
+        Helper.log.fatal '#############################################################'
+        Helper.log.fatal "# You have to install phantomjs to use deliver"
+        Helper.log.fatal "# phantomjs is used to control the iTunesConnect frontend"
+        Helper.log.fatal "# Install Homebrew using http://brew.sh/" if `which brew`.length == 0
+        Helper.log.fatal "# Run 'brew update && brew install phantomjs' and start deliver again"
+        Helper.log.fatal '#############################################################'
+        raise "Run 'brew update && brew install phantomjs' and start deliver again"
+      end
+    end
+
+    def self.check_xcode_select
+      unless `xcode-select -v`.include?"xcode-select version "
+        Helper.log.fatal '#############################################################'
+        Helper.log.fatal "# You have to install the Xcode commdand line tools to use deliver"
+        Helper.log.fatal "# Install the latest version of Xcode from the AppStore"
+        Helper.log.fatal "# Run xcode-select --install to install the developer tools"
+        Helper.log.fatal '#############################################################'
+        raise "Run 'xcode-select --install' and start deliver again"
+      end
+    end
+  end
+end

data/lib/deliver/helper.rb

@@ -0,0 +1,55 @@
+require 'logger'
+
+module Deliver
+  module Helper
+
+    # Logging happens using this method
+    def self.log
+      if is_test?
+        @@log ||= Logger.new(nil) # don't show any logs when running tests
+      else
+        @@log ||= Logger.new(STDOUT)
+      end
+
+      @@log.formatter = proc do |severity, datetime, progname, msg|
+        string = "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N')}]: "
+        second = "#{msg}\n"
+
+        if severity == "DEBUG"
+          string = string.magenta
+        elsif severity == "INFO"
+          string = string.white
+        elsif severity == "WARN"
+          string = string.yellow
+        elsif severity == "ERROR"
+          string = string.red
+        elsif severity == "FATAL"
+          string = string.red.bold
+        end
+
+
+        [string, second].join("")
+      end
+
+      @@log
+    end
+
+    # @return true if the currently running program is a unit test
+    def self.is_test?
+      defined?SpecHelper
+    end
+
+    # @return the full path to the Xcode developer tools of the currently
+    #  running system
+    def self.xcode_path
+      return "" if self.is_test? and not OS.mac?
+      `xcode-select -p`.gsub("\n", '') + "/"
+    end
+
+    # @return the full path to the iTMSTransporter executable
+    def self.transporter_path
+      self.xcode_path + '../Applications/Application\ Loader.app/Contents/MacOS/itms/bin/iTMSTransporter'
+    end
+    
+  end
+end

data/lib/deliver/ipa_uploader.rb

@@ -0,0 +1,160 @@
+require 'zip'
+require 'plist'
+
+module Deliver
+  class IpaUploaderError < StandardError 
+  end
+
+  # This class takes care of preparing and uploading the given ipa file
+  # Metadata + IPA file can not be handled in one file
+  class IpaUploader < AppMetadata
+    attr_accessor :app
+
+    # Create a new uploader for one ipa file. This will only upload the ipa and no
+    # other app metadata.
+    # @param app (Deliver::App) The app for which the ipa should be uploaded for
+    # @param dir (String) The path to where we can store (copy) the ipa file. Usually /tmp/
+    # @param ipa_path (String) The path to the IPA file which should be uploaded
+    # @param is_beta_build (Bool) If it's a beta build, it will be released to the testers, otherwise into production
+    # @raise (IpaUploaderError) Is thrown when the ipa file was not found or is not valid
+    def initialize(app, dir, ipa_path, is_beta_build)
+      ipa_path.strip! # remove unused white spaces
+      raise IpaUploaderError.new("IPA on path '#{ipa_path}' not found") unless File.exists?(ipa_path)
+      raise IpaUploaderError.new("IPA on path '#{ipa_path}' is not a valid IPA file") unless ipa_path.include?".ipa"
+
+      super(app, dir, false)
+
+      @ipa_file = Deliver::MetadataItem.new(ipa_path)
+      @is_beta_build = is_beta_build
+    end
+
+    # Fetches the app identifier (e.g. com.facebook.Facebook) from the given ipa file.
+    def fetch_app_identifier
+      plist = fetch_info_plist_file
+      return plist['CFBundleIdentifier'] if plist
+      return nil
+    end
+
+    # Fetches the app version from the given ipa file.
+    def fetch_app_version
+      plist = fetch_info_plist_file
+      return plist['CFBundleShortVersionString'] if plist
+      return nil
+    end
+
+
+    #####################################################
+    # @!group Uploading the ipa file
+    #####################################################
+
+    # Actually upload the ipa file to Apple
+    # @param submit_information (Hash) A hash containing submit information (export, content rights)
+    def upload!(submit_information = nil)
+      Helper.log.info "Uploading ipa file to iTunesConnect"
+      build_document
+
+      # Write the current XML state to disk
+      folder_name = "#{@app.apple_id}.itmsp"
+      path = "#{@metadata_dir}/#{folder_name}/"
+      FileUtils.mkdir_p path
+
+      File.write("#{path}/#{METADATA_FILE_NAME}", @data.to_xml)
+
+      @ipa_file.store_file_inside_package(path)
+
+      is_okay = true
+      begin
+        transporter.upload(@app, @metadata_dir)
+      rescue Exception => ex
+        is_okay = ex.to_s.include?"ready exists a binary upload with build" # this just means, the ipa is already online
+      end
+
+      if is_okay
+        unless Helper.is_test?
+          return publish_on_itunes_connect(submit_information)
+        end
+      end
+
+      return is_okay
+    end
+
+    
+
+    private
+      # This method will trigger the iTunesConnect class to choose the latest build
+      def publish_on_itunes_connect(submit_information = nil)
+        if not @is_beta_build
+          return publish_production_build(submit_information)
+        else
+          return publish_beta_build
+        end
+        return false
+      end
+
+      def publish_beta_build
+        # Distribute to beta testers
+        Helper.log.info "Distributing the latest build to Beta Testers."
+        if self.app.itc.put_build_into_beta_testing!(self.app, self.fetch_app_version)
+          Helper.log.info "Successfully distributed a new beta build of your app.".green
+          return true
+        end
+        return false
+      end
+
+      def publish_production_build(submit_information)
+        # Publish onto Production
+        Helper.log.info "Putting the latest build onto production."
+        if self.app.itc.put_build_into_production!(self.app, self.fetch_app_version)
+          if self.app.itc.submit_for_review!(self.app, submit_information)
+            Helper.log.info "Successfully deployed a new update of your app. You can now enjoy a good cold Club Mate.".green
+            return true
+          end
+        end
+        return false
+      end
+
+
+      def build_document
+        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml.package(xmlns: "http://apple.com/itunes/importer", version: "software4.7") {
+            xml.software_assets(apple_id: @app.apple_id) {
+              xml.asset(type: 'bundle') {
+
+              }
+            }
+          }
+        end
+
+        @data = builder.doc
+        asset = @data.xpath('//x:asset', "x" => Deliver::AppMetadata::ITUNES_NAMESPACE).first
+        asset << @ipa_file.create_xml_node(@data)
+      end
+
+      def fetch_info_plist_file
+        Zip::File.open(@ipa_file.path) do |zipfile|
+          zipfile.each do |file|
+            if file.name.include?'.plist'
+              # We can not be completely sure, that's the correct plist file, so we have to try
+              begin
+                # The XML file has to be properly unpacked first
+                tmp_path = "/tmp/deploytmp.plist"
+                File.write(tmp_path, zipfile.read(file))
+                system("plutil -convert xml1 #{tmp_path}")
+                result = Plist::parse_xml(tmp_path)
+                File.delete(tmp_path)
+
+                if result['CFBundleIdentifier'] or result['CFBundleVersion']
+                  return result
+                end
+              rescue
+                # We don't really care, look for another XML file
+              end
+            end
+          end
+        end
+
+        nil
+      end
+
+  end
+end