RubyGems - motion-sparkle-sandbox - Versions diffs - 0.7.0 - Mend

motion-sparkle-sandbox 0.7.0

Files changed (25) hide show

checksums.yaml +7 -0
data/.gitignore +19 -0
data/Gemfile +6 -0
data/LICENSE +21 -0
data/README.md +260 -0
data/Rakefile +8 -0
data/lib/motion-sparkle-sandbox.rb +11 -0
data/lib/motion/project/appcast.rb +127 -0
data/lib/motion/project/appcast/release_notes.content.html +22 -0
data/lib/motion/project/appcast/release_notes.template.erb +19 -0
data/lib/motion/project/install.rb +75 -0
data/lib/motion/project/package.rb +44 -0
data/lib/motion/project/project.rb +59 -0
data/lib/motion/project/rake_tasks.rb +89 -0
data/lib/motion/project/setup.rb +96 -0
data/lib/motion/project/sparkle.rb +189 -0
data/lib/motion/project/templates.rb +34 -0
data/motion-sparkle-sandbox.gemspec +21 -0
data/spec/sparkle_spec.rb +90 -0
data/spec/spec_helper.rb +35 -0
data/vendor/README.md +24 -0
data/vendor/Sparkle.zip +0 -0
data/vendor/codesign_xpc +46 -0
data/vendor/generate_appcast +0 -0
metadata +67 -0

data/lib/motion/project/appcast/release_notes.content.html ADDED Viewed

@@ -0,0 +1,22 @@
+<h1>Your app - version x.yz</h1>
+<h2>The greatest update ever</h2>
+<dl>
+  <dt>An interface to drool for</dt>
+  <dd>I won't say too much (wouldn't want to spoil the surprise)</dd>
+  <dt>Record-breaking performance</dt>
+  <dd>
+    <p>
+      We keep doing it every time and you start to be less impressed, but we're still very proud of ourselves! We could write about our performance for hours, and make you read it for days!
+    </p>
+    <p>
+      <strong>What for?</strong>
+      <br>
+      This does serve a purpose, however, and it is to show you how a longer text would look like. It'll help you figure out your style.
+    </p>
+    <p>
+      Just do the same for your app now :)
+    </p>
+  </dd>
+</dl>

data/lib/motion/project/appcast/release_notes.template.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<html>
+  <head>
+    <title>Release Notes for <%= @config.name %></title>
+    <style>
+      * { font-family: "Helvetica Neue", "Helvetica", "Arial", "Sans";}
+      h1 { background-color: #ABABFF; padding: 10px;}
+      h1 span { font-size: 75%; font-weight: normal; float: right;}
+      dt { font-size: 105%; font-weight: bold; margin: 5px 0;}
+      dd { margin: 0; padding: 5px 0 0 5px; }
+      dd p {margin: 2px 0; padding: 0;}
+    </style>
+  </head>
+  <body>
+    <%= release_notes_html %>
+  </body>
+</html>

data/lib/motion/project/install.rb ADDED Viewed

@@ -0,0 +1,75 @@
+module Motion::Project
+  class Sparkle
+    SPARKLE_ZIP_FILE = 'Sparkle.zip'
+    def sparkle_distrib
+      file_path = Pathname.new File.dirname(__FILE__)
+      distrib_path = "vendor/#{SPARKLE_ZIP_FILE}"
+      (file_path.parent.parent.parent + distrib_path).to_s
+      Pathname.new(sparkle_vendor_path + SPARKLE_ZIP_FILE)
+    end
+    def sparkle_vendor_path
+      file_path = Pathname.new File.dirname(__FILE__)
+      (file_path.parent.parent.parent + 'vendor/').to_s
+    end
+    def sparkle_path
+      Pathname.new(vendor_path + 'Sparkle')
+    end
+    def sparkle_framework_path
+      Pathname.new(vendor_path + 'Sparkle/Sparkle.framework')
+    end
+    def sparkle_xpc_path
+      Pathname.new(vendor_path + 'Sparkle/XPCServices')
+    end
+    def sparkle_zipball
+      Pathname.new(vendor_path + SPARKLE_ZIP_FILE)
+    end
+    def copy_zipball
+      `cp #{sparkle_distrib} #{sparkle_zipball}`
+    end
+    def unzip
+      `unzip #{sparkle_zipball.to_s} -d #{vendor_path.to_s}`
+      `rm #{sparkle_zipball}`
+    end
+    def installed?
+      File.directory?(sparkle_framework_path)
+    end
+    def install
+      FileUtils.rm_rf(sparkle_path) if File.directory?(sparkle_path) # force clean install
+      copy_zipball
+      unzip
+    end
+    def embed
+      @config.embedded_frameworks << sparkle_framework_path
+    end
+    def install_and_embed
+      install unless installed?
+      embed
+    end
+    def verify_installation
+      if installed?
+        App.info "Sparkle", "Framework installed in #{sparkle_framework_path.to_s}"
+      else
+        App.fail "Sparkle framework not correctly copied to #{sparkle_framework_path.to_s}
+Run `rake sparkle:install` manually or, if the problem persists,
+please explain your setup and problem as an issue on GitHub at:
+https://github.com/digitalmoksha/motion-sparkle-sandbox/issues
+"
+      end
+    end
+  end
+end

data/lib/motion/project/package.rb ADDED Viewed

@@ -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.short_version
+      App.info "Build", @config.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 --symlinks "#{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 ADDED Viewed

@@ -0,0 +1,59 @@
+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
+  class Builder
+    # if we're using the sandboxed version of Sparkle, then we need to copy the
+    # xpc services to the proper folder and sign them.  This has to be done
+    # before we sign the app itself
+    #------------------------------------------------------------------------------
+    def codesign_with_sparkle(config, platform)
+      if App.config.embedded_frameworks.any? {|item| item.to_s.include?('Sparkle.framework')}
+        bundle_path = App.config.app_bundle('MacOSX')
+        if File.directory?(App.config.sparkle.sparkle_xpc_path)
+          xpc_path = File.join(bundle_path, "XPCServices")
+          App.info 'Sparkle', "Copying XPCServices to #{xpc_path}"
+          FileUtils.mkdir_p(xpc_path)
+          `cp -R #{App.config.sparkle.sparkle_xpc_path}/*.xpc "#{xpc_path}"`
+          Dir.glob("#{xpc_path}/*.xpc").each do |path|
+            App.info 'Codesign', path
+            results = `#{App.config.sparkle.sparkle_vendor_path}/codesign_xpc "#{App.config.codesign_certificate}" "#{File.expand_path(path)}" 2>&1`
+          end
+        end
+      end
+      codesign_without_sparkle(config, platform)
+    end
+    alias_method "codesign_without_sparkle", "codesign"
+    alias_method "codesign", "codesign_with_sparkle"
+  end
+end

data/lib/motion/project/rake_tasks.rb ADDED Viewed

@@ -0,0 +1,89 @@
+# Rake tasks
+namespace :sparkle do
+  task :install do
+    sparkle = App.config.sparkle
+    sparkle.install
+  end
+  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
+    App.config_without_setup.build_mode = :release
+    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
+    App.config_without_setup.build_mode = :release
+    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
+    App.config_without_setup.build_mode = :release
+    sparkle = App.config.sparkle
+    sparkle.copy_templates(force = true)
+  end
+  desc "Generate the appcast xml feed"
+  task :feed do
+    App.config_without_setup.build_mode = :release
+    sparkle = App.config.sparkle
+    sparkle.create_appcast
+  end
+  desc "Generate the appcast using Sparkle's `generate_appcast`"
+  task :generate_appcast do
+    App.config_without_setup.build_mode = :release
+    sparkle = App.config.sparkle
+    results = `#{sparkle.sparkle_vendor_path}/generate_appcast "#{sparkle.private_key_path}" "#{sparkle.archive_folder}"`
+  end
+  desc "Update the release notes of this build"
+  task :release_notes do
+    App.config_without_setup.build_mode = :release
+    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 ADDED Viewed

@@ -0,0 +1,96 @@
+module Motion::Project
+  class Sparkle
+    def setup_ok?
+      config_ok?
+      certificates_ok?
+    end
+    def config_ok?
+      check_base_url
+      check_feed_url
+      check_public_key
+    end
+    def check_base_url
+      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
+      true
+    end
+    def check_feed_url
+      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
+      true
+    end
+    def check_public_key
+      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
+      verify_installation
+      create_sparkle_folder
+      add_to_gitignore
+      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 ADDED Viewed

@@ -0,0 +1,189 @@
+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'
+      install_and_embed
+    end
+    def appcast
+      @appcast ||= Appcast.new
+    end
+    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}"
+      end
+    end
+    alias_method :release, :publish
+    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 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 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)
+        end
+      end
+      File.open(gitignore_path, 'a') do |f|
+        @ignorable.each do |i|
+          f << "#{i}\n"
+        end
+      end if @ignorable.any?
+      `cat #{gitignore_path}`
+    end
+    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 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
+    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 vendor_path
+      @vendor_path ||= Pathname.new(project_path + 'vendor/')
+    end
+    def gitignore_path
+      project_path + ".gitignore"
+    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 archive_folder
+      appcast.archive_folder
+    end
+    def app_file
+      "#{app_name}.app"
+    end
+  end
+end