motion-sparkle-sandbox 2.0.0 → 2.1.1

data/lib/motion/project/sparkle.rb

@@ -1,189 +1,358 @@
-module Motion::Project
-  class Sparkle
+# frozen_string_literal: true
+
+module Motion
+  module Project
+    # rubocop:disable Metrics/ClassLength
+    class Sparkle
+      SPARKLE_ROOT = 'sparkle'
+      CONFIG_PATH = "#{SPARKLE_ROOT}/config"
+      RELEASE_PATH = "#{SPARKLE_ROOT}/release"
+      EDDSA_PRIV_KEY = 'eddsa_priv.key'
+      DSA_PRIV_KEY = 'dsa_priv.pem'
+
+      def initialize(config)
+        @config = config
+        # verify_installation
+      end
 
-    SPARKLE_ROOT = "sparkle"
-    CONFIG_PATH = "#{SPARKLE_ROOT}/config"
-    RELEASE_PATH = "#{SPARKLE_ROOT}/release"
+      def after_initialize
+        self.feed_url = appcast.feed_url
+      end
 
-    def initialize(config)
-      @config = config
-      publish :public_key, 'dsa_pub.pem'
-      install_and_embed
-    end
+      def appcast
+        @appcast ||= Appcast.new(self)
+      end
 
-    def appcast
-      @appcast ||= Appcast.new
-    end
+      def publish(key, value)
+        return if appcast.process_option(key, value)
 
-    def publish(key, value)
-      case key
-      when :public_key
-        public_key value
-      when :base_url
-        appcast.base_url = value
-        feed_url appcast.feed_url
-      when :feed_base_url
-        appcast.feed_base_url = value
-        feed_url appcast.feed_url
-      when :feed_filename
-        appcast.feed_filename = value
-        feed_url appcast.feed_url
-      when :version
-        version value
-      when :notes_base_url, :package_base_url, :notes_filename, :package_filename
-        appcast.send "#{key}=", value
-      when :archive_folder
-        appcast.archive_folder = value
-      else
-        raise "Unknown Sparkle config option #{key}"
+        case key
+        when :public_key
+          self.public_ed_dsa_key = value
+        when :version
+          version(value)
+        else
+          raise "Unknown Sparkle config option #{key}"
+        end
       end
-    end
-    alias_method :release, :publish
+      alias release publish
 
-    def version(vstring)
-      @config.version = vstring.to_s
-      @config.short_version = vstring.to_s
-    end
+      def version(vstring)
+        @config.version = vstring.to_s
+        @config.short_version = vstring.to_s
+      end
 
-    def version_string
-      "#{@config.short_version} (#{@config.version})"
-    end
+      def version_string
+        "#{@config.short_version} (#{@config.version})"
+      end
 
-    def feed_url(url)
-      @config.info_plist['SUFeedURL'] = url
-    end
+      def feed_url
+        @config.info_plist['SUFeedURL']
+      end
 
-    def public_key(path_in_resources_folder)
-      @config.info_plist['SUPublicDSAKeyFile'] = path_in_resources_folder
-    end
+      def feed_url=(url)
+        @config.info_plist['SUFeedURL'] = url
+      end
 
-    # File manipulation and certificates
+      def public_ed_dsa_key
+        @config.info_plist['SUPublicEDKey']
+      end
+
+      def public_ed_dsa_key=(key)
+        @config.info_plist['SUPublicEDKey'] = key
+      end
+
+      # File manipulation and certificates
 
-    def add_to_gitignore
-      @ignorable = ['sparkle/release','sparkle/release/*','sparkle/config/dsa_priv.pem']
-      return unless File.exist?(gitignore_path)
-      File.open(gitignore_path, 'r') do |f|
-        f.each_line do |line|
-          @ignorable.delete(line) if @ignorable.include?(line)
+      def add_to_gitignore
+        @ignorable = ['sparkle/release', 'sparkle/release/*', private_key_path]
+        return unless File.exist?(gitignore_path)
+
+        File.open(gitignore_path, 'r') do |f|
+          f.each_line do |line|
+            @ignorable.delete(line) if @ignorable.include?(line)
+          end
+        end
+        if @ignorable.any?
+          File.open(gitignore_path, 'a') do |f|
+            @ignorable.each do |i|
+              f << "#{i}\n"
+            end
+          end
         end
+        `cat #{gitignore_path}`
+      end
+
+      def create_sparkle_folder
+        create_config_folder
+        create_release_folder
+      end
+
+      def generate_keys_app
+        "#{vendored_sparkle_path}/bin/generate_keys"
       end
-      File.open(gitignore_path, 'a') do |f|
-        @ignorable.each do |i|
-          f << "#{i}\n"
+
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def generate_keys
+        return false unless config_ok?
+
+        FileUtils.mkdir_p sparkle_config_path unless File.exist?(sparkle_config_path)
+
+        if appcast.use_exported_private_key && File.exist?(private_key_path)
+          App.info 'Sparkle', "Private key already exported at `#{private_key_path}` and will be used."
+          if public_ed_dsa_key.present?
+            App.info '', <<~EXISTS
+              SUPublicEDKey already set
+
+              Be careful not to override or lose your certificates.
+              Delete this file if you're sure.
+              Aborting (no action performed)
+            EXISTS
+              .indent(11, skip_first_line: true)
+          else
+            App.info '', <<~EXISTS
+              SUPublicEDKey NOT SET
+
+              You can easily add the `SUPublicEDKey` by publishing the key in your Rakefile:
+
+              app.sparkle do
+                ...
+                publish :public_key, 'PUBLIC_KEY'
+              end
+
+              Be careful not to override or lose your certificates.
+              Delete this file if you're sure.
+              Aborting (no action performed)
+            EXISTS
+              .indent(11, skip_first_line: true)
+          end
+
+          return
         end
-      end if @ignorable.any?
-      `cat #{gitignore_path}`
-    end
 
-    def create_sparkle_folder
-      create_config_folder
-      create_release_folder
-    end
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
-    def create_config_folder
-      FileUtils.mkdir_p(sparkle_config_path) unless File.exist?(sparkle_config_path)
-    end
+        if status.success?
+          App.info 'Sparkle', "Public/private keys found in the keychain for account #{appcast.cli_options[:account]}"
 
-    def create_release_folder
-      FileUtils.mkdir_p(sparkle_release_path) unless File.exist?(sparkle_release_path)
-    end
+          if results.strip == public_ed_dsa_key
+            App.info 'Sparkle', 'Keychain public key matches `SUPublicEDKey`'
+
+            if appcast.use_exported_private_key && !File.exist?(private_key_path)
+              # export the private key from the keychain
+            end
+          else
+            App.fail <<~NOT_MATCHED
+              Keychain public key DOES NOT match `SUPublicEDKey`
+
+                  Keychain public key:      #{results.strip}
+                  SUPublicEDKey public key: #{public_ed_dsa_key}
+
+            NOT_MATCHED
+              .indent(11, skip_first_line: true)
+          end
 
-    def generate_keys
-      return false unless config_ok?
-      unless File.exist?(sparkle_config_path)
-        FileUtils.mkdir_p sparkle_config_path
-      end
-      [dsa_param_path, private_key_path, public_key_path].each do |file|
-        if File.exist? file
-          App.info "Sparkle", "Error: file exists.
-There's already a '#{file}'. Be careful not to override or lose your certificates. \n
-Delete this file if you're sure. \n
-Aborting (no action performed)
-          "
           return
         end
+
+        create_private_key
+        export_private_key if appcast.use_exported_private_key
       end
-      `#{openssl} dsaparam 2048 < /dev/urandom > #{dsa_param_path}`
-      `#{openssl} gendsa #{dsa_param_path} -out #{private_key_path}`
-      generate_public_key
-      `rm #{dsa_param_path}`
-      App.info "Sparkle", "Generated private and public certificates.
-Details:
-  *  Private certificate: ./#{private_key_path}
-  *  Public certificate: ./#{public_key_path}
-Warning:
-ADD YOUR PRIVATE CERTIFICATE TO YOUR `.gitignore` OR EQUIVALENT AND BACK IT UP!
-KEEP IT PRIVATE AND SAFE!
-If you lose it, your users will be unable to upgrade.
-      "
-    end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
-    def generate_public_key
-      `#{openssl} dsa -in #{private_key_path} -pubout -out #{public_key_path}`
-    end
+      # Create the private key in the keychain
+      def create_private_key
+        App.info 'Sparkle',
+                 'Generating a new signing key into the Keychain. This may take a moment, depending on your machine.'
+        results, status = Open3.capture2e(generate_keys_app, '--account', appcast.cli_options[:account])
 
-    # A few helpers
+        App.fail 'Sparkle could not generate keys' unless status.success?
 
-    def openssl
-      "/usr/bin/openssl"
-    end
+        puts
+        puts results.lines[1..].join.indent(11)
 
-    def project_path
-      @project_path ||= Pathname.new(@config.project_dir)
-    end
+        # Extract the public key so we can use it in message
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
-    def vendor_path
-      @vendor_path ||= Pathname.new(project_path + 'vendor/')
-    end
+        App.fail 'Unable to read public key' unless status.success?
 
-    def gitignore_path
-      project_path + ".gitignore"
-    end
+        puts <<~KEYS
+          You can easily add the `SUPublicEDKey` by publishing the key in your Rakefile:
 
-    def sparkle_release_path
-      project_path + RELEASE_PATH
-    end
+              app.sparkle do
+                ...
+                publish :public_key, '#{results.strip}'
+              end
 
-    def sparkle_config_path
-      project_path + CONFIG_PATH
-    end
+        KEYS
+          .indent(11)
+      end
 
-    def dsa_param_path
-      sparkle_config_path + "dsaparam.pem"
-    end
+      # Export the private key from the keychain
+      def export_private_key
+        _results, status = Open3.capture2e(generate_keys_app, '-x', private_key_path.to_s, '--account', appcast.cli_options[:account])
 
-    def private_key_path
-      sparkle_config_path + "dsa_priv.pem"
-    end
+        App.fail 'Unable to export private key' unless status.success?
 
-    def public_key_path
-      pub_key_file = @config.info_plist['SUPublicDSAKeyFile']
-      project_path + "resources/#{pub_key_file}"
-    end
+        App.info 'Sparkle', 'Private key has been exported from the keychain into the file:'
+        puts <<~KEYS
 
-    def app_bundle_path
-      Pathname.new @config.app_bundle_raw('MacOSX')
-    end
+              ./#{private_key_path}
 
-    def app_release_path
-      app_bundle_path.parent.to_s
-    end
+          ADD THIS PRIVATE KEY TO YOUR `.gitignore` OR EQUIVALENT AND BACK IT UP!
+          KEEP IT PRIVATE AND SAFE!
+          If you lose it, your users will be unable to upgrade, unless you used Apple code signing.
+          See https://sparkle-project.org/documentation/ for details
+        KEYS
+          .indent(11)
+      end
 
-    def app_name
-      File.basename(app_bundle_path, '.app')
-    end
+      # copy the release notes and zip archive into the releases_folder,
+      # where the appcast will get built
+      def copy_to_release
+        path = (project_path + releases_folder).realpath
+        zip_file_path = (sparkle_release_path + zip_file).realpath
 
-    def zip_file
-      appcast.package_filename || "#{app_name}.zip"
-    end
+        [release_notes_path, zip_file_path].each do |file|
+          FileUtils.cp(file, "#{path}/")
+          App.info 'Copied', "./#{path}/#{file}"
+        end
+      end
 
-    def archive_folder
-      appcast.archive_folder
-    end
+      # Generate the appcast.
+      # Note: We do not support the old DSA keys, only the newer EdDSA keys.
+      #       See https://sparkle-project.org/documentation/eddsa-migration
+      def generate_appcast
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        path = (project_path + releases_folder).realpath
+        appcast_filename = (path + appcast.feed_filename)
+        appcast.cli_options[:output_path] = appcast_filename
 
-    def app_file
-      "#{app_name}.app"
-    end
+        FileUtils.mkdir_p(path) unless File.exist?(path)
+
+        App.info('Sparkle', "Generating appcast using `#{generate_appcast_app}`")
+        puts "from files in `#{path}`...".indent(11)
 
+        args = appcast.prepare_args
+
+        App.info 'Executing', [generate_appcast_app, *args, path.to_s].join(' ')
+
+        results, status = Open3.capture2e(generate_appcast_app, *args, path.to_s)
+
+        App.info('Sparkle', "Saved appcast to `#{appcast_filename}`") if status.success?
+        puts results.indent(11)
+
+        return unless status.success?
+
+        puts
+        puts "SUFeedURL     : #{feed_url}".indent(11)
+        puts "SUPublicEDKey : #{public_ed_dsa_key}".indent(11)
+      end
+
+      def generate_appcast_help
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        results, _status = Open3.capture2e(generate_appcast_app, '--help')
+
+        puts results
+      end
+
+      def create_release_notes
+        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}" unless File.exist?(release_notes_template_path)
+
+        create_release_folder
+
+        File.open(release_notes_path.to_s, 'w') do |f|
+          template = File.read(release_notes_template_path)
+          f << ERB.new(template).result(binding)
+        end
+
+        App.info 'Create', "./#{release_notes_path}"
+      end
+
+      def release_notes_template_path
+        sparkle_config_path.join('release_notes.template.erb')
+      end
+
+      def release_notes_content_path
+        sparkle_config_path.join('release_notes.content.html')
+      end
+
+      def release_notes_path
+        sparkle_release_path + (appcast.notes_filename || "#{app_name}.#{@config.short_version}.html")
+      end
+
+      def release_notes_content
+        if File.exist?(release_notes_content_path)
+          File.read(release_notes_content_path)
+        else
+          App.fail "Missing #{release_notes_content_path}"
+        end
+      end
+
+      def release_notes_html
+        release_notes_content
+      end
+
+      # A few helpers
+
+      def project_path
+        @project_path ||= Pathname.new(@config.project_dir)
+      end
+
+      def vendor_path
+        @vendor_path ||= project_path.join('vendor')
+      end
+
+      def gitignore_path
+        project_path.join('.gitignore')
+      end
+
+      def sparkle_release_path
+        project_path.join(RELEASE_PATH)
+      end
+
+      def sparkle_config_path
+        project_path.join(CONFIG_PATH)
+      end
+
+      def private_key_path
+        sparkle_config_path.join(EDDSA_PRIV_KEY)
+      end
+
+      def app_bundle_path
+        Pathname.new(@config.app_bundle_raw('MacOSX'))
+      end
+
+      def app_release_path
+        app_bundle_path.parent.to_s
+      end
+
+      def app_name
+        File.basename(app_bundle_path, '.app')
+      end
+
+      def zip_file
+        appcast.package_filename || "#{app_name}.#{@config.short_version}.zip"
+      end
+
+      def releases_folder
+        appcast.releases_folder
+      end
+
+      def app_file
+        "#{app_name}.app"
+      end
+
+      private
+
+      def create_config_folder
+        FileUtils.mkdir_p(sparkle_config_path) unless File.exist?(sparkle_config_path)
+      end
+
+      def create_release_folder
+        FileUtils.mkdir_p(sparkle_release_path) unless File.exist?(sparkle_release_path)
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/motion/project/templates.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'rexml/document'
 
-module Motion::Project
-  class Sparkle
-
-    TEMPLATE_PATHS = [
-      File.expand_path(File.join(__FILE__, '../appcast'))
-    ]
+module Motion
+  module Project
+    class Sparkle
+      TEMPLATE_PATHS = [
+        File.expand_path(File.join(__FILE__, '../appcast'))
+      ].freeze
 
-    def all_templates
-      @all_templates ||= begin
-        templates = {}
-        TEMPLATE_PATHS.map { |path| Dir.glob(path + '/*') }.flatten.each do |template_path|
-          templates[File.basename(template_path)] = template_path
+      def all_templates
+        @all_templates ||= begin
+          templates = {}
+          TEMPLATE_PATHS.map { |path| Dir.glob("#{path}/*") }.flatten.each do |template_path|
+            templates[File.basename(template_path)] = template_path
+          end
+          templates
         end
-        templates
       end
-    end
 
-    def copy_templates(force=false)
-      all_templates.each_pair do |tmpl, path|
-        result = "#{sparkle_config_path}/#{tmpl}"
-        if File.exist?(result) and !force
-          App.info 'Exists', result
-        else
-          FileUtils.cp(path, "#{sparkle_config_path}/")
-          App.info 'Create', "./#{sparkle_config_path}/#{tmpl.to_s}"
+      def copy_templates(force = false)
+        all_templates.each_pair do |tmpl, path|
+          result = "#{sparkle_config_path}/#{tmpl}"
+          if File.exist?(result) && !force
+            App.info 'Exists', result
+          else
+            FileUtils.cp(path, "#{sparkle_config_path}/")
+            App.info 'Create', "./#{sparkle_config_path}/#{tmpl}"
+          end
         end
       end
     end
-
   end
 end

data/lib/motion-sparkle-sandbox/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MotionSparkleSandbox
+  VERSION = '2.1.1'
+end

data/lib/motion-sparkle-sandbox.rb

@@ -1,6 +1,8 @@
-unless defined?(Motion::Project::Config)
-  raise "This file must be required within a RubyMotion project Rakefile."
-end
+# frozen_string_literal: true
+
+raise 'This file must be required within a RubyMotion project Rakefile.' unless defined?(Motion::Project::Config)
+
+require 'motion-cocoapods'
 
 require 'motion/project/sparkle'
 require 'motion/project/install'
@@ -10,3 +12,17 @@ require 'motion/project/templates'
 require 'motion/project/appcast'
 require 'motion/project/project'
 require 'motion/project/rake_tasks'
+require 'motion/project/indent_string'
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+
+POD_VERSION = '~> 2.1.0'
+
+unless @running_specs
+  Motion::Project::App.setup do |app|
+    app.files.unshift(Dir.glob(File.join(lib_dir_path, 'motion-sparkle-sandbox/**/*.rb')))
+    app.pods do
+      pod 'Sparkle', POD_VERSION
+    end
+  end
+end

data/motion-sparkle-sandbox.gemspec

@@ -1,21 +1,31 @@
-# This is just so that the source file can be loaded.
-module ::Motion; module Project; class Config
-  def self.variable(*); end
-end; end; end
+# frozen_string_literal: true
 
-require 'date'
-$:.unshift File.expand_path('../lib', __FILE__)
+module Motion
+  module Project
+    # This is just so that the source file can be loaded
+    class Config
+      def self.variable(*); end
+    end
+  end
+end
+
+# require 'date'
+# $:.unshift File.expand_path('../lib', __FILE__)
+require File.expand_path('lib/motion-sparkle-sandbox/version.rb', __dir__)
 
 Gem::Specification.new do |spec|
-  spec.name        = 'motion-sparkle-sandbox'
-  spec.version     = '2.0.0'
-  spec.date        = Date.today
-  spec.summary     = 'Sparkle (sandboxed) integration for Rubymotion projects'
-  spec.description = "motion-sparkle-sandbox makes it easy to use the sandboxed version of Sparkle in your RubyMotion OS X apps"
-  spec.author      = 'Brett Walker'
-  spec.email       = 'github@digitalmoksha.com'
-  spec.homepage    = 'https://github.com/digitalmoksha/motion-sparkle-sandbox'
-  spec.license     = 'MIT'
-  spec.files       = `git ls-files`.split("\n")
+  spec.name          = 'motion-sparkle-sandbox'
+  spec.version       = MotionSparkleSandbox::VERSION
+  spec.authors       = ['Brett Walker', 'Alexandre L. Solleiro']
+  spec.email         = ['github@digitalmoksha.com', 'alex@webcracy.org']
+  spec.summary       = 'Sparkle (sandboxed) integration for Rubymotion projects'
+  spec.description   = 'motion-sparkle-sandbox makes it easy to use the sandboxed version of Sparkle in your RubyMotion macOS apps'
+  spec.homepage      = 'https://github.com/digitalmoksha/motion-sparkle-sandbox'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = Dir.glob('spec/**/*.rb')
   spec.require_paths = ['lib']
+
+  spec.add_dependency 'motion-cocoapods'
 end

data/sample-app/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.bundle
+.repl_history
+build
+build-log
+vendor
+
+sparkle/release
+sparkle/config
+sparkle/config/eddsa_priv.key

data/sample-app/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gem 'motion-sparkle-sandbox', path: '..'
+
+gem 'pry-byebug', '~> 3.9.0', platform: :mri
+gem 'binding_of_caller'