sparkle_appcast 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1371a567e13d8c53f4625dc93c5a85a05121fcc8229f7d715abada093726da47
+  data.tar.gz: d6d952e901c2abe3fa1f1035b3ff900c68f963d0804475da26e3db6405889dd3
+SHA512:
+  metadata.gz: 67a6eaed29a811a75075f3b47b61667d6e0fcd484641524a4b10dfc471310b6fb6ccf9d614c1ca28202bd0d4b29584342c11f01997c6219d114a8822470fec43
+  data.tar.gz: fb6649d00d9bd4be1fe454a9471781fb11afc81b31e6bf98b85f02186e997cabae86ed258a29cae8438d79932dc35ebf336dd4fe5dca67ad111ca18da0525895

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Yoshimasa Niwa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+sparkle_appcast
+===============
+
+
+NAME
+----
+
+`sparkle_appcast` -- A simple Sparkle `appcast.xml` tool
+
+
+SYNOPSIS
+--------
+
+    sparkle_appcast COMMAND [OPTIONS...] [ARGS...]
+
+
+DESCRIPTION
+-----------
+
+`sparkle_appcast` is a Ruby gem that provides a command line interface and a Ruby library
+to create and update `appcast.xml` for [Sparkle](https://sparkle-project.org).
+
+`sparkle_appcast` command line interface takes next commands.
+
+### `appcast [OPTIONS...] FILE_PATH`
+
+Create `appcast.xml` with an application archive at `FILE_PATH`.
+The application archive file must contain exact one application bundle.
+
+* `--key=KEY`
+
+    Path to DSA private key file. Required.
+
+* `--url=URL`
+
+    URL to the application archive file published. Required.
+
+* `--release-note=RELEASE_NOTE`
+
+    Path to a release note text file in Markdown format. Required.
+
+* `--output=OUTPUT`
+
+    Path to an output `appcast.xml`. Optional.
+    Default to puts in the standard output.
+
+* `--title=TITLE`
+
+    Title for the release note. Optional.
+    Default to `"{{Bundle Name}} {Bundle Short Version String}} ({{Bundle Version}})"`.
+
+* `--publish-date=PUBLISH_DATE`
+
+    Publish date time in local timezone. Optional.
+    Default to the creation time of the application archive file.
+
+* `--channel-title=CHANNEL_TITLE`
+
+    Title of the channel. Optional.
+    Default to `"Change log"`.
+
+* `--channel-description=CHANNEL_DESCRIPTION`
+
+    Description of the channel. Optional.
+    Default to `"The most recent changes."`.
+
+### `sign [OPTIONS...] [FILE_PATH]`
+    
+Sign data at `FILE_PATH` or reading from the standard input with `DSA_PRIVATE_KEY_PATH`
+and print signature that can be used in `appcast.xml`.
+Use this for testing private key.
+
+* `--key=KEY`
+
+    Path to DSA private key file. Required.
+
+### `markdown [FILE_PATH]`
+
+Format Markdown text file at `FILE_PATH` or reading from the standard input in HTML.
+Use this for writing the release note.
+
+
+USAGE
+-----
+
+Use Ruby Gems to install `sparkle_appcast`.
+
+    gem install sparkle_appcast
+
+Or use [bundler](http://bundler.io/), add next line to `Gemfile` in your project.
+
+    gem "sprkle_appcast"
+
+
+SEE ALSO
+--------
+
+ * [generate-key](https://github.com/sparkle-project/Sparkle/blob/master/bin/generate_keys)
+ * [sign-update](https://github.com/sparkle-project/Sparkle/blob/master/bin/sign_update)
+ * [generate-appcast](https://github.com/sparkle-project/Sparkle/tree/master/generate_appcast)

data/bin/sparkle_appcast

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require "sparkle_appcast"
+
+SparkleAppcast::Cli.start(ARGV)

data/lib/sparkle_appcast/appcast.rb

@@ -0,0 +1,42 @@
+module SparkleAppcast
+  class Appcast
+    attr_reader :signer, :archive, :release_note, :url, :params
+
+    def initialize(archive, signer, url, release_note, params = {})
+      @archive = archive
+      @signer = signer
+      @url = url
+      @release_note = release_note
+      @params = params
+    end
+
+    def rss
+      Rss.new(rss_params)
+    end
+
+    private
+
+    def rss_params
+      {
+        channel_link: archive.feed_url,
+        title: title,
+        description: release_note.html,
+        publish_date: archive.created_at,
+        url: url,
+        length: archive.size,
+        version: archive.bundle_version,
+        short_version_string: archive.bundle_short_version_string,
+        minimum_system_version: archive.minimum_system_version,
+        dsa_signature: dsa_signature
+      }.merge(params)
+    end
+
+    def title
+      "#{archive.bundle_name} #{archive.bundle_short_version_string} (#{archive.bundle_version})"
+    end
+
+    def dsa_signature
+      @dsa_signature ||= signer.sign(archive.data)
+    end
+  end
+end

data/lib/sparkle_appcast/archive.rb

@@ -0,0 +1,80 @@
+require "tmpdir"
+require "plist"
+
+module SparkleAppcast
+  class Archive
+    attr_reader :path
+
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+
+    def bundle_name
+      info_plist["CFBundleDisplayName"] || info_plist["CFBundleName"]
+    end
+
+    def bundle_version
+      info_plist["CFBundleVersion"]
+    end
+
+    def bundle_short_version_string
+      info_plist["CFBundleShortVersionString"]
+    end
+
+    def minimum_system_version
+      info_plist["LSMinimumSystemVersion"]
+    end
+
+    def feed_url
+      info_plist["SUFeedURL"]
+    end
+
+    def created_at
+      File.birthtime(path)
+    end
+
+    def size
+      File.size(path)
+    end
+
+    def data
+      File.binread(path)
+    end
+
+    private
+
+    # TODO: Support localizable string.
+
+    def info_plist
+      @info_plist ||= Dir.mktmpdir do |tmpdir_path|
+        case File.basename(path)
+        when /\.zip\z/i
+          Kernel.system("/usr/bin/ditto", "-x", "-k", path, tmpdir_path)
+        when /\.tar\z/i
+          Kernel.system("/usr/bin/tar", "-x", "-f", path, "-C", tmpdir_path)
+        when /\.tar\.gz\z/i, /\.tgz\z/i, /\.tar\.xz\z/i, /\.txz\z/i, /\.tar\.lzma\z/i
+          Kernel.system("/usr/bin/tar", "-x", "-z", "-f", path, "-C", tmpdir_path)
+        when /\.tar\.bz2\z/i, /\.tbz\z/i
+          Kernel.system("/usr/bin/tar", "-x", "-j", "-f", path, "-C", tmpdir_path)
+        else
+          raise NotImplementedError.new("Disk image support is not implemented yet.")
+        end
+
+        unless $?.success?
+          raise RuntimeError.new("Failed to expand archive: #{path}")
+        end
+
+        app_paths = Dir.glob(File.join(tmpdir_path, "*.app"), File::FNM_CASEFOLD)
+        if app_paths.size == 0
+          raise RuntimeError.new("No application bundle found: #{path}")
+        elsif app_paths.size > 1
+          raise RuntimeError.new("Found multiple application bundles: #{app_paths.map{|path| File.basename(path)}}")
+        else
+          app_path = app_paths.first
+          info_plist_path = File.join(app_path, "Contents", "Info.plist")
+          Plist.parse_xml(info_plist_path)
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_appcast/cli.rb

@@ -0,0 +1,72 @@
+require "rubygems"
+require "thor"
+require "kramdown"
+require "time"
+
+module SparkleAppcast
+  class Cli < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "appcast FILE", "Create `appcast.xml` with an application archive file."
+    long_desc <<-END_OF_DESCRIPTION
+      Create `appcast.xml` with an application archive file.
+      The application archive file must contain exact one application bundle.
+    END_OF_DESCRIPTION
+    option :key, type: :string, required: true, desc: "Path to a DSA private key."
+    option :url, type: :string, required: true, desc: "URL to the application archive file published."
+    option :release_note, type: :string, required: true, desc: "Path to a release note text file in Markdown format."
+    option :output, type: :string, desc: "Path to an output `appcast.xml`."
+    option :title, type: :string, desc: "Title for the release note."
+    option :publish_date, type: :string, desc: "Publish date time in local timezone."
+    option :channel_title, type: :string, default: "Change log", desc: "Title of the channel."
+    option :channel_description, type: :string, default: "The most recent changes.", desc: "Description of the channel."
+    def appcast(file)
+      params = {
+        channel_title: options[:channel_title],
+        channel_description: options[:channel_description]
+      }
+      params[:title] = options[:title] if options[:title]
+      params[:publish_date] = Time.parse(options[:publish_date]) if options[:publish_date]
+
+      appcast = Appcast.new(
+        Archive.new(file),
+        Signer.new(options[:key]),
+        options[:url],
+        ReleaseNote.new(options[:release_note]),
+        params
+      )
+
+      rss = appcast.rss.to_s
+      if options[:output]
+        File.open(options[:output], "w") do |output|
+          output.puts(rss)
+        end
+      else
+        STDOUT.puts(rss)
+      end
+    end
+
+    desc "sign [FILE]", "Sign a file with a DSA private key."
+    option :key, type: :string, required: true, desc: "Path to a DSA private key."
+    def sign(file = nil)
+      source = if file
+        File.binread(file)
+      else
+        STDIN.read
+      end
+      puts Signer.new(options[:key]).sign(source)
+    end
+
+    desc "markdown [FILE]", "Format Markdown text file in HTML."
+    def markdown(file = nil)
+      text = if file
+        File.read(file)
+      else
+        STDIN.read
+      end
+      puts ReleaseNote.markdown(text)
+    end
+  end
+end

data/lib/sparkle_appcast/release_note.rb

@@ -0,0 +1,21 @@
+module SparkleAppcast
+  class ReleaseNote
+    def self.markdown(text)
+      Kramdown::Document.new(text, auto_ids: false).to_html
+    end
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def html
+      @html ||= self.class.markdown(text)
+    end
+
+    def text
+      @text ||= File.read(path)
+    end
+  end
+end

data/lib/sparkle_appcast/rss.rb

@@ -0,0 +1,88 @@
+require "rexml/document"
+require "time"
+
+module SparkleAppcast
+  class Rss
+    REQUIRED_FILEDS = [
+      :url,
+      :length,
+      :version,
+      :dsa_signature
+    ]
+
+    attr_reader :params
+
+    def initialize(params)
+      REQUIRED_FILEDS.each do |field|
+        unless params[field]
+          raise ArgumentError.new("Missing #{field} param")
+        end
+      end
+      @params = params
+    end
+
+    def to_s
+      StringIO.new.tap do |output|
+        output << %(<?xml version="1.0" encoding="UTF-8"?>\n)
+        formatter = REXML::Formatters::Pretty.new(2)
+        formatter.compact = true
+        formatter.write(document, output)
+      end.string
+    end
+
+    private
+
+    def document
+      @document ||= REXML::Document.new.tap do |document|
+        document.context = {
+          # Use double quote for attributes escape.
+          attribute_quote: :quote
+        }
+
+        # <rss ... > ... </rss>
+        document.add_element("rss").tap do |rss|
+          rss.add_namespace("xmlns:sparkle", "http://www.andymatuschak.org/xml-namespaces/sparkle")
+          rss.add_namespace("xmlns:dc", "http://purl.org/dc/elements/1.1/")
+          rss.add_attribute("version", "2.0")
+
+          # <channel> ... </channel>
+          rss.add_element("channel").tap do |channel|
+            channel.add_element("title").add_text(params[:channel_title]) if params[:channel_title]
+            channel.add_element("description").add_text(params[:channel_description]) if params[:channel_description]
+            channel.add_element("link").add_text(params[:channel_link]) if params[:channel_link]
+            channel.add_element("language").add_text(params[:language]) if params[:language]
+
+            # <item> ... </item>
+            channel.add_element("item").tap do |item|
+              item.add_element("title").add_text(params[:title]) if params[:title]
+              item.add_element("description").add(REXML::CData.new(params[:description])) if params[:description]
+              item.add_element("pubDate").add_text(publish_date) if publish_date
+
+              # <enclosure ... />
+              item.add_element("enclosure").tap do |enclosure|
+                enclosure.add_attribute("url", params[:url])
+                enclosure.add_attribute("type", "application/octet-stream")
+                enclosure.add_attribute("length", params[:length])
+                enclosure.add_attribute("sparkle:version", params[:version])
+                enclosure.add_attribute("sparkle:shortVersionString", params[:short_version_string]) if params[:short_version_string]
+                enclosure.add_attribute("sparkle:dsaSignature", params[:dsa_signature])
+                enclosure.add_attribute("sparkle:minimumSystemVersion", params[:minimum_system_version]) if params[:minimum_system_version]
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def publish_date
+      case params[:publish_date]
+      when nil
+        nil
+      when Time
+        params[:publish_date].utc.rfc2822
+      else
+        params[:publish_date]
+      end
+    end
+  end
+end

data/lib/sparkle_appcast/signer.rb

@@ -0,0 +1,26 @@
+require "openssl"
+require "base64"
+
+module SparkleAppcast
+  class Signer
+    attr_reader :private_key_path
+
+    def initialize(private_key_path)
+      @private_key_path = private_key_path
+    end
+
+    def sign(data)
+      # Sparkle is signing SHA1 digest with DSA private key and encoding it in Base64.
+      # See <https://github.com/sparkle-project/Sparkle/blob/master/bin/sign_update>.
+      digest = OpenSSL::Digest::SHA1.digest(data)
+      signature = private_key.sign(OpenSSL::Digest::SHA1.new, digest)
+      Base64.strict_encode64(signature)
+    end
+
+    private
+
+    def private_key
+      @private_key ||= OpenSSL::PKey::DSA.new(File.binread(private_key_path))
+    end
+  end
+end

data/lib/sparkle_appcast.rb

@@ -0,0 +1,8 @@
+module SparkleAppcast
+  autoload :Appcast, "sparkle_appcast/appcast"
+  autoload :Archive, "sparkle_appcast/archive"
+  autoload :Cli, "sparkle_appcast/cli"
+  autoload :ReleaseNote, "sparkle_appcast/release_note"
+  autoload :Rss, "sparkle_appcast/rss"
+  autoload :Signer, "sparkle_appcast/signer"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sparkle_appcast
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshimasa Niwa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate Sparkle appcast.xml
+email:
+- niw@niw.at
+executables:
+- sparkle_appcast
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/sparkle_appcast
+- lib/sparkle_appcast.rb
+- lib/sparkle_appcast/appcast.rb
+- lib/sparkle_appcast/archive.rb
+- lib/sparkle_appcast/cli.rb
+- lib/sparkle_appcast/release_note.rb
+- lib/sparkle_appcast/rss.rb
+- lib/sparkle_appcast/signer.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Generate Sparkle appcast.xml
+test_files: []