motion-sparkle 0.0.1

data/lib/motion/project/package.rb

@@ -0,0 +1,44 @@
+module Motion::Project
+  class Sparkle
+
+    def package
+      return unless setup_ok?
+      create_release_folder
+      @config.build_mode = :release
+      return unless create_zip_file
+      App.info "Release", version_string
+      App.info "Version", @config.version
+      App.info "Build", @config.short_version || 'unspecified in Rakefile'
+      App.info "Size", @package_size.to_s
+      sign_package
+      create_appcast
+      create_release_notes
+      `open #{sparkle_release_path}`
+    end
+
+    def create_zip_file
+      unless File.exist?(app_bundle_path)
+        App.fail "You need to build your app with the Release target to use Sparkle"
+      end
+      if File.exist?("#{sparkle_release_path}/#{zip_file}")
+        App.fail "Release already exists at ./#{sparkle_release_path}/#{zip_file} (remove it manually with `rake sparkle:clean`)"
+      end
+      FileUtils.cd(app_release_path) do
+        `zip -r #{zip_file} "#{app_file}"`
+      end
+      FileUtils.mv "#{app_release_path}/#{zip_file}", "./#{sparkle_release_path}/"
+      App.info "Create", "./#{sparkle_release_path}/#{zip_file}"
+      @package_file = zip_file
+      @package_size = File.size "./#{sparkle_release_path}/#{zip_file}"
+    end
+
+    def sign_package
+      package = "./#{sparkle_release_path}/#{zip_file}"
+      @package_signature = `#{openssl} dgst -sha1 -binary < "#{package}" | #{openssl} dgst -dss1 -sign "#{private_key_path}" | #{openssl} enc -base64`
+      @package_signature = @package_signature.strip
+      App.info "Signature", "\"#{@package_signature}\""
+    end
+
+
+  end
+end

data/lib/motion/project/project.rb

@@ -0,0 +1,47 @@
+module Motion::Project
+
+  class Config
+    variable :sparkle
+
+    def sparkle(&block)
+      @sparkle ||= Motion::Project::Sparkle.new(self)
+      if block
+        @sparkle.instance_eval &block
+      end
+      @sparkle
+    end
+  end
+
+  class App
+    class << self
+      def build_with_sparkle(platform, opts = {})
+        if App.config.sparkle.setup_ok?
+          App.info "Sparkle", "Setup OK"
+        else
+          exit 1
+        end
+        build_without_sparkle(platform, opts)
+      end
+
+      alias_method "build_without_sparkle", "build"
+      alias_method "build", "build_with_sparkle"
+    end
+  end
+
+  # In 10.9, `codesign` no longer uses the `--deep` flag by default
+  # To make sure `Sparkle.framework` is signed, we need to override 
+  # this part of the RubyMotion build process to pass it
+  # FIXME: this will probably be taken care of upstream
+  class Builder
+    def codesign(config, platform)
+      app_bundle = config.app_bundle_raw('MacOSX')
+      entitlements = File.join(config.versionized_build_dir(platform), "Entitlements.plist")
+      if File.mtime(config.project_file) > File.mtime(app_bundle) \
+          or !system("/usr/bin/codesign --verify \"#{app_bundle}\" >& /dev/null")
+        App.info 'Codesign', app_bundle
+        File.open(entitlements, 'w') { |io| io.write(config.entitlements_data) }
+        sh "/usr/bin/codesign --deep --force --sign \"#{config.codesign_certificate}\" --entitlements \"#{entitlements}\" \"#{app_bundle}\""
+      end
+    end
+  end
+end

data/lib/motion/project/rake_tasks.rb

@@ -0,0 +1,72 @@
+# Rake tasks
+namespace :sparkle do 
+
+  desc "Setup Sparkle configuration"
+  task :setup do
+    sparkle = App.config.sparkle
+    sparkle.setup
+  end
+
+  desc "Create a ZIP file with you application .app release build"
+  task :package do
+    sparkle = App.config.sparkle
+    sparkle.package
+  end
+
+  task :setup_certificates do
+    sparkle = App.config.sparkle
+    sparkle.generate_keys
+  end
+
+  desc "Sign the ZIP file with appropriate certificates"
+  task :sign do
+    sparkle = App.config.sparkle
+    sparkle.sign_package
+  end
+
+  task :recreate_public_key do
+    sparkle = App.config.sparkle
+    sparkle.generate_public_key
+  end
+
+  task :copy_release_notes_templates do
+    sparkle = App.config.sparkle
+    sparkle.copy_templates(force = true)
+  end
+
+  desc "Generate the appcast xml feed"
+  task :feed do
+    sparkle = App.config.sparkle
+    sparkle.create_appcast
+  end
+
+  desc "Update the release notes of this build"
+  task :release_notes do
+    sparkle = App.config.sparkle
+    sparkle.create_release_notes
+  end
+
+  desc "Upload to configured location"
+  task :upload do
+  end
+
+  desc "Clean the Sparkle release folder"
+  task :clean do
+    dir = Motion::Project::Sparkle::RELEASE_PATH
+    if File.exist?("./#{dir}")
+      App.info 'Delete', "./#{dir}"
+      rm_rf dir
+    end
+  end
+end
+
+namespace :clean do
+  # Delete Sparkle release folder when cleaning all
+  task :all do
+    dir = Motion::Project::Sparkle::RELEASE_PATH
+    if File.exist?("./#{dir}")
+      App.info 'Delete', "./#{dir}"
+      rm_rf dir
+    end
+  end
+end

data/lib/motion/project/setup.rb

@@ -0,0 +1,79 @@
+module Motion::Project
+  class Sparkle
+
+    def setup_ok?
+      config_ok?
+      certificates_ok?
+    end
+
+    def config_ok?
+      base_url_check = appcast.base_url.to_s
+      if base_url_check.nil? or base_url_check.empty?
+        App.fail "Sparkle :base_url missing. Use `release :base_url, 'http://example.com/your_app_folder'` in your Rakefile's `app.sparkle` block"
+      end
+      feed_url_check = @config.info_plist['SUFeedURL']
+      feed_filename_check = appcast.feed_filename
+      if feed_url_check.nil? or feed_url_check.empty? or feed_filename_check.nil? or feed_filename_check.empty?
+        App.fail "Sparkle :feed_filename is nil or blank. Please check your Rakefile."
+      end
+      public_key_check = @config.info_plist['SUPublicDSAKeyFile'].to_s
+      if public_key_check.nil? or public_key_check.empty?
+        App.fail "Sparkle :public_key is nil or blank. Please check your Rakefile."
+      end
+      true
+    end
+
+    def certificates_ok?(silence=false)
+      unless File.exist?("./#{Sparkle::CONFIG_PATH}")
+        if silence
+          return false
+        else
+          App.fail "Missing `#{Sparkle::CONFIG_PATH}`. Run `rake sparkle:setup` to get started" 
+        end
+      end
+      unless File.exist?(private_key_path)
+        if silence
+          return false
+        else
+          App.fail "Missing `#{private_key_path}`. Please run `rake sparkle:setup_certificates` or check the docs to know where to put them."
+        end
+      end
+      unless File.exist?(public_key_path)
+        if silence
+          return false
+        else
+          App.fail "Missing `#{public_key_path}`. Did you configure `release :public_key` correctly in the Rakefile? Advanced: recreate your public key with `rake sparkle:recreate_public_key`"
+        end
+      end
+      true
+    end
+
+    def setup
+      create_sparkle_folder
+      copy_templates
+      if config_ok?
+        App.info "Sparkle", "Config found"
+      else
+        return false
+      end
+
+      silence = true
+      if certificates_ok?(silence)
+        App.info "Sparkle", "Certificates found"
+      else
+        App.info "Sparkle", "Certificates not found
+Please generate your private and public keys with
+    `rake sparkle:setup_certificates`
+If you already have your certificates and only need to include them in the project, follow these steps:
+    1. Rename your private key to `./#{private_key_path}`
+    2. Place your public key in `./#{public_key_path}`
+    3. If you wish to use a different name or location for your public key within the resources dir, 
+       make sure you add `publish :public_key, 'folder/new_name.pem'` to the sparkle config in your Rakefile
+        "
+        return false
+      end
+      App.info "Sparkle", "Setup OK. After `rake build:release`, you can now run `rake sparkle:package`."
+    end
+
+  end
+end

data/lib/motion/project/sparkle.rb

@@ -0,0 +1,166 @@
+module Motion::Project
+
+  class Sparkle
+
+    SPARKLE_ROOT = "sparkle"
+    CONFIG_PATH = "#{SPARKLE_ROOT}/config"
+    RELEASE_PATH = "#{SPARKLE_ROOT}/release"
+
+    def initialize(config)
+      @config = config
+      publish :public_key, 'dsa_pub.pem'
+      embed_framework
+    end
+
+    def appcast
+      @appcast ||= Appcast.new
+    end
+
+    def publish(key, value)
+      case key
+      when :feed_url
+        feed_url value
+      when :public_key
+        public_key value
+      when :version
+        version value
+      when :base_url 
+        appcast.base_url = value
+        feed_url appcast.full_feed_url
+      when :notes_filename, :package_filename
+        appcast.send(key.to_s + '=', value)
+      when :feed_filename
+        appcast.feed_filename = value
+        feed_url appcast.full_feed_url
+      else
+        raise "Unknown Sparkle config option #{key}"
+      end
+    end
+    alias_method :release, :publish
+
+    def embed_framework
+      framework_path = Pathname.new File.dirname(__FILE__)
+      framework_path = (framework_path.parent.parent.parent + 'vendor/Sparkle.framework').to_s
+      @config.embedded_frameworks << framework_path
+    end
+
+    def version(vstring)
+      @config.version = vstring.to_s
+      @config.short_version = vstring.to_s
+    end
+
+    def version_string
+      "#{@config.version} (#{@config.short_version})"
+    end
+
+    def feed_url(url)
+      @config.info_plist['SUFeedURL'] = url
+    end
+
+    def public_key(path_in_resources_folder)
+      @config.info_plist['SUPublicDSAKeyFile'] = path_in_resources_folder
+    end
+
+    # File manipulation and certificates
+
+    def create_sparkle_folder
+      create_config_folder
+      create_release_folder
+    end
+
+    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
+
+    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
+      end
+      `#{openssl} dsaparam 1024 < /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
+
+    def generate_public_key
+      `#{openssl} dsa -in #{private_key_path} -pubout -out #{public_key_path}`
+    end
+
+    # A few helpers
+
+    def openssl
+      "/usr/bin/openssl"
+    end
+
+    def project_path
+      @project_path ||= Pathname.new(@config.project_dir)
+    end
+
+    def sparkle_release_path
+      project_path + RELEASE_PATH
+    end
+
+    def sparkle_config_path
+      project_path + CONFIG_PATH
+    end
+
+    def dsa_param_path
+      sparkle_config_path + "dsaparam.pem"
+    end
+
+    def private_key_path
+      sparkle_config_path + "dsa_priv.pem"
+    end
+
+    def public_key_path
+      pub_key_file = @config.info_plist['SUPublicDSAKeyFile']
+      project_path + "resources/#{pub_key_file}"
+    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}.zip"
+    end
+
+    def app_file
+      "#{app_name}.app"
+    end
+
+  end
+
+end

data/lib/motion/project/templates.rb

@@ -0,0 +1,40 @@
+require 'erb'
+require 'rexml/document'
+
+module Motion; module Project
+  
+  class Sparkle
+    # for ERB
+    # attr_reader :name
+
+    TemplatePaths = [
+      File.expand_path(File.join(__FILE__, '../appcast'))
+    ]
+
+    Templates = TemplatePaths.map { |path| Dir.glob(path + '/*') }.flatten.map { |x| File.basename(x) }
+
+    def all_templates
+      @all_templates ||= begin
+        templates = {}
+        TemplatePaths.map { |path| Dir.glob(path + '/*') }.flatten.each do |template_path|
+          templates[File.basename(template_path)] = template_path
+        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}"
+        end
+      end
+    end
+
+  end
+
+end; end