motion-sparkle 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTIxZWYzYTgzZGZlNWU0YzE0YjE4YzUyYzY5ODFlYTk4NzBmYWE4MA==
+    ZTFkMzBjNTA5NzJlNDk4ZjU2YmNlZjAzMDE2YWIyZjliMTBmMWFlOA==
   data.tar.gz: !binary |-
-    N2IwNWRlNmZmYTZlOGZjY2U3Y2ZlZTBmOTBkOWRhMDJkOWZjMTcyOQ==
+    MWRkZjEyOTFlNTAxYWZjMGQ4NDdlNzM2NmEwNWNkMjNjNTk1YmUxNg==
 SHA512:
   metadata.gz: !binary |-
-    MzBmY2QxMzE2YTVlYzUxNDkwNzliOTYwYmFjM2MzNWQ1Zjc0ZDlkOTgwYmQ1
-    YWM3OGJlOWM2MjcyYmFhNGY2ZjY0OGI5ZTA3ZmJkNjUxZTQxMmU0MDNlNzEz
-    NjE4NjdlN2VjN2ZlYjk3ZTIxOTVlODgzMzYxOTVmYjA0NGVjMTI=
+    N2Q4OWFiOTJkM2FkM2U5MjQxMzM0YmFhNmY2ZGI2ZjNjNjU0ZGFmZjgyY2Fl
+    YThmNTgxOTQ2YzZkODE1MTQxNGQ3NTM5ODM5YTAwYmRhMjRmMjAwOWMwMDZl
+    MzY2YjZmYTFhNDNjMjY2Mjg2NGZlYTJlYmNkNzhkZGM4M2IwNjY=
   data.tar.gz: !binary |-
-    ZTRjMjMzZDI4ZDJkODY0YzY2OGFiMDg2NmExNmI1ODU4ZTRhYjE3Zjk5ZjQ0
-    NzFiZjU1MWMzOGI3NmFmMjI5ZGI2YjY0MjAzMjViMmU4ZGJhNzljMjM5NTA2
-    OTlkNGNlY2YyZWVmOWRlYjExZmQ2NDcyMGI5N2I2MzcyY2NhNGI=
+    MDk1OTZiNGQyNzdjMmQzNjIwOTg3ZTFjMzk5M2U0MGFhMmEyNmNiZTE2OWY5
+    MTAwMWYxMjIzMTNkMzExODFiYjg3NWI3MDhiZmI5YmY5YTc1YjZiNTBmMGNi
+    OGM0MmJhMjU1NWEzOTBkNGVjODg0ZjdjNjI5NjA5ZjMyZmE4ZGI=

data/README.md

@@ -30,44 +30,62 @@ Easily package and release updates of your RubyMotion app with Sparkle.
 
 ## Overview
 
-[Sparkle](http://sparkle.andymatuschak.org/) powers countless Mac applications' "Check for updates" feature. In a nutshell, when users click "Check for updates..." in an app, Sparkle checks for updates against an XML file that you post somewhere on the web. That XML file contains information about your new release, such as the version number, the URL of the package and its digital signature. If there's a newer version available than the one that is currently running, it'll ask for permission to retrieve the package and replace the current app with the new release.
+[Sparkle](http://sparkle.andymatuschak.org/) powers the "Check for updates" feature of countless Mac applications. 
 
-While it's easy to use Sparkle with RubyMotion without motion-sparkle, it's even easier if you use it. The gem takes care of the Sparkle framework integration, simplifies its configuration and then automates the preparation of a release, creating a ZIP file, XML and release notes for you.
+In a nutshell, when users click "Check for updates..." in an app, Sparkle checks for available updates against an XML file that you post somewhere on the web. That XML file contains information about your new release, such as the version number, the URL of the package and its digital signature. If there's a newer version available than the one that is currently running, it'll ask for permission to retrieve the package and replace the current app with the new release.
 
-After building your app for release and running `rake sparkle:package`, all you need to do is upload 3 files to an URL you specified in the Rakefile and your users will be able to get the new release.
+While it's easy to use Sparkle with RubyMotion without `motion-sparkle`, it's even easier if you use it. The gem takes care of the Sparkle framework integration, simplifies its configuration and then automates the preparation of a release, creating the ZIP, XML and release notes HTML file for you.
+
+After building your app for release and running `rake sparkle:package`, all you need to do is upload 3 files to the URL you specify in the `Rakefile` and your users will be able to get the new release.
 
 ## Installation
 
 In your project's Gemfile, add:
+```ruby
+# Gemfile
 
-    gem 'motion-sparkle'
-
-and then run 
+gem 'motion-sparkle'
+```
+and then run
 
     $ bundle install
 
 ## Settings configuration
 
-Configure Sparkle in your `Rakefile` using motion-sparkle's DSL:
+Configure Sparkle in your `Rakefile` using `motion-sparkle`'s DSL:
+```ruby
+# Rakefile
+
+app.sparkle do
+  # Required setting
+  release :base_url, 'http://example.com/releases/current' # `current` is a folder, don't use a trailing slash
+
+  # Recommended setting
+  # This will set both your `app.version` and `app.short_version` to the same value
+  # It's fine not to use it, just remember to set both as Sparkle needs them
+  release :version, '1.0'
+
+  ## Optional settings and their default values and/or examples
+
+  ## Please note that `base_url` must always be set (at the moment), 
+  ## even you override it completely with the options below
 
-    # Rakefile
-  
-    app.sparkle do
-      # Required setting
-      release :base_url, 'http://example.com/releases/current' # `current` is a folder, don't use a trailing slash
+  # Public Key
+  release :public_key, 'dsa_pub.pem' # default
 
-      # Recommended setting
-      # This will set both your `app.version` and `app.short_version` to the same value
-      # It's fine not to use it, just remember to set both as Sparkle needs them
-      release :version, '1.0'
+  # Appcast Feed 
+  release :feed_base_url, 'http://downloads.example.com/releases' # defaults to base_url
+  release :feed_filename, 'releases.xml' # default
+
+  # Release Notes
+  release :notes_base_url, 'http://downloads.example.com/releases' # defaults to base_url
+  release :notes_filename, 'release_notes.html' # default
       
-      # Optional settings and their default values
-      release :feed_filename, 'releases.xml'
-      release :notes_filename, 'release_notes.html'
-      release :package_filename, "#{app.name}.zip"
-      release :public_key, 'dsa_pub.pem'
-    
-    end
+  # App Package
+  release :package_base_url, 'http://downloads.example.com/releases' # defaults to base_url
+  release :package_filename, "#{app.name}.zip" # default
+end
+```
 
 To complete the configuration, run
 
@@ -98,11 +116,11 @@ By default, your certificates need to be placed in the following directories:
     ./sparkle/config/dsa_priv.pem   # private certificate
 
 
-### Notes about the public certificate 
+### Notes about the public certificate
 
 The public certificate is placed at the root of the default `resources/` folder by default, as it needs to bundled with your app. If you chose to rename it, remember to set its correct value in the `Rakefile`, using `release :public_key, 'new_name.pem'`.
 
-### Notes about the private certificate 
+### Notes about the private certificate
 
 The private certificate cannot be renamed nor placed elsewhere. If you have an existing certificate, please name it `dsa_priv.pem` and place inside the `sparkle/config/` folder
 
@@ -110,8 +128,8 @@ The private certificate cannot be renamed nor placed elsewhere. If you have an e
 
 Be careful when handling the private certificate: you should never lose it nor share it. If you do, you'd lose the ability to sign your packages and users wouldn't be able to update your app. If someone takes it, they could sign the packages in your name and have your users install who knows what.
 
-Tips: 
-* add it go your `.gitignore` or equivalent 
+Tips:
+* add it go your `.gitignore` or equivalent
 * make a backup of it
 
 ### Run `rake sparkle:setup` at any moment to make sure your config is OK
@@ -120,9 +138,9 @@ When all is good, move forward. If you need help, you can always open an issue o
 
 ## Adding "Check for updates..." to the menu
 
-Sparkle makes it incredibly easy to add a "Check for updates" feature to your app. 
+Sparkle makes it incredibly easy to add a "Check for updates" feature to your app.
 
-Sparkle's `SUUpdater` class has a shared updater instance that can serve as a `target` for Sparkle actions. To launch the typical Sparkle flow, call the `checkForUpdates:` action. 
+Sparkle's `SUUpdater` class has a shared updater instance that can serve as a `target` for Sparkle actions. To launch the typical Sparkle flow, call the `checkForUpdates:` action.
 
 So, to launch the "Check for updates" flow, you can call `SUUpdater.new.checkForUpdates`.
 
@@ -131,16 +149,17 @@ Here's an example based on the RubyMotion default OS X app example, "Hello". You
 This will add the classic "Check for updates..." entry on the menu; when the user clicks it, the nice default of experience of Sparkle will begin.
 
 In `menu.rb`, right below the line that adds the "Preferences" item:
-
-    sparkle = addItemWithTitle("Check for updates...", action: nil, keyEquivalent: '')
-    sparkle.setTarget SUUpdater.new
-    sparkle.setAction 'checkForUpdates:'
+```ruby
+  sparkle = addItemWithTitle("Check for updates...", action: nil, keyEquivalent: '')
+  sparkle.setTarget SUUpdater.new
+  sparkle.setAction 'checkForUpdates:'
+```
 
 Once you build your application, you should be able to see a "Check for updates..." item in the Application menu. Using it will work but will quickly produce an error. Keep going to make it work.
 
 ## First publication
 
-Before you build, make sure you've set your `:base_url` to a destination where you can upload/download your files. 
+Before you build, make sure you've set your `:base_url` to a destination where you can upload/download your files.
 
 Note that packaging with motion-sparkle only works with the `:release` target at the moment, so make sure your build with be compatible with `rake build:release`.
 
@@ -164,11 +183,13 @@ To do so, follow the same steps every time:
 
 ### 1. Bump the version
 
-    # In your Rakefile
-  
-    sparkle.app do
-      release :version, '1.1' # bump the versions
-    end
+```ruby
+  # In your Rakefile
+
+  sparkle.app do
+    release :version, '1.1' # bump the versions
+  end
+```
 
 ### 2. Build your app for release
 
@@ -188,13 +209,13 @@ Run the `sparkle:package` task and you'll be one step away from distribution.
 
 ### 5. Upload
 
-Upload the 3 files and your new version is up. When users click "Check for updates...", the app should now display your release notes and ask the user to update. And when they do, the app will update and relaunch itself cleanly. 
+Upload the 3 files and your new version is up. When users click "Check for updates...", the app should now display your release notes and ask the user to update. And when they do, the app will update and relaunch itself cleanly.
 
 Sparkle for the win.
 
 ## Help, Limitations, Troubleshooting and Testing
 
-If you need further help, please open an Issue on Github.
+If you need further help, please open an [Issue on Github](https://github.com/webcracy/motion-sparkle/issues/).
 
 Limitations:
 
@@ -211,7 +232,7 @@ Test coverage currently only extends to configuration and certificate generation
 
 ## Contributing
 
-Please do help with comments, issues and pull requests! 
+Please do help with comments, issues and pull requests! The gem's repository is at [github.com/webcracy/motion-sparkle](https://github.com/webcracy/motion-sparkle/).
 
 I've made a list of features that I look forward to having. You can attack those or suprise me :)
 
@@ -229,13 +250,15 @@ Thanks!
 
 ## Credits
 
+Contributors: [View all on Github](https://github.com/webcracy/motion-sparkle/graphs/contributors)
+
 Author: Alexandre L. Solleiro
 
-* Twitter - http://twitter.com/als
 * Github - http://github.com/webcracy
+* Twitter - http://twitter.com/als
 * Website - http://webcracy.org
 
 Thanks to the authors and contributors of [HipByte/motion-cocoapods](https://github.com/HipByte/motion-cocoapods) and [drnic/choctop](https://github.com/drnic/choctop) gems, as I have looked for inspiration in their code.
 
-And a low bow to [andymatuschak/Sparkle](https://github.com/andymatuschak/Sparkle)! 
+And a low bow to [andymatuschak/Sparkle](https://github.com/andymatuschak/Sparkle)!
 

data/lib/motion/project/appcast.rb

@@ -19,7 +19,7 @@ module Motion::Project
         doc = REXML::Formatters::Pretty.new
         doc.write(appcast_xml, xml_string)
         f << "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
-        f << xml_string 
+        f << xml_string
         f << "\n"
       end
       if appcast_file
@@ -30,7 +30,6 @@ module Motion::Project
     end
 
     def appcast_xml
-      base_url = appcast.base_url
       rss = REXML::Element.new 'rss'
       rss.attributes['xmlns:atom'] = "http://www.w3.org/2005/Atom"
       rss.attributes['xmlns:sparkle'] = "http://www.andymatuschak.org/xml-namespaces/sparkle"
@@ -52,9 +51,9 @@ module Motion::Project
       guid = item.add_element('guid')
       guid.text = "#{@config.name}-#{@config.version}"
       guid.attributes['isPermaLink'] = false
-      item.add_element('sparkle:releaseNotesLink').text = "#{base_url}/#{appcast.notes_filename}"
+      item.add_element('sparkle:releaseNotesLink').text = "#{appcast.notes_url}/#{appcast.notes_filename}"
       enclosure = item.add_element('enclosure')
-      enclosure.attributes['url'] = "#{base_url}/#{@package_file}"
+      enclosure.attributes['url'] = "#{appcast.package_url}/#{@package_file}"
       enclosure.attributes['length'] = "#{@package_size}"
       enclosure.attributes['type'] = "application/octet-stream"
       enclosure.attributes['sparkle:version'] = @config.version
@@ -88,18 +87,36 @@ module Motion::Project
 
 
     class Appcast
-      attr_accessor :base_url, :feed_filename, :notes_filename, :package_filename
+      attr_accessor :base_url,
+        :feed_base_url,
+        :feed_filename,
+        :notes_base_url, 
+        :notes_filename, 
+        :package_base_url,
+        :package_filename
 
       def initialize
+        @feed_base_url = nil
         @feed_filename = 'releases.xml'
+        @notes_base_url = nil
         @notes_filename = 'release_notes.html'
+        @package_base_url = nil
         @package_filename = nil
         @base_url = nil
       end
 
-      def full_feed_url
-        "#{base_url}/#{feed_filename}"
+      def feed_url
+        "#{feed_base_url || base_url}/#{feed_filename}"
       end
+
+      def notes_url
+        "#{notes_base_url || base_url}/#{notes_filename}"
+      end
+
+      def package_url
+        "#{package_base_url || base_url}/#{package_filename}"
+      end
+
     end
 
   end

data/lib/motion/project/package.rb

@@ -24,7 +24,7 @@ module Motion::Project
         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}"`
+        `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}"
@@ -41,4 +41,4 @@ module Motion::Project
 
 
   end
-end
+end

data/lib/motion/project/sparkle.rb

@@ -18,20 +18,21 @@ module Motion::Project
 
     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 
+      when :base_url
         appcast.base_url = value
-        feed_url appcast.full_feed_url
-      when :notes_filename, :package_filename
+        feed_url appcast.feed_url
+      when :feed_base_url
         appcast.send(key.to_s + '=', value)
+        feed_url appcast.feed_url
       when :feed_filename
         appcast.feed_filename = value
-        feed_url appcast.full_feed_url
+        feed_url appcast.feed_url
+      when :version
+        version value
+      when :notes_base_url, :package_base_url, :notes_filename, :package_filename
+        appcast.send(key.to_s + '=', value)
       else
         raise "Unknown Sparkle config option #{key}"
       end
@@ -71,10 +72,10 @@ module Motion::Project
           @ignorable.delete(line) if @ignorable.include?(line)
         end
       end
-      File.open(gitignore_path, 'a') do |f|  
+      File.open(gitignore_path, 'a') do |f|
         @ignorable.each do |i|
           f << "#{i}\n"
-        end 
+        end
       end if @ignorable.any?
       `cat #{gitignore_path}`
     end
@@ -137,7 +138,7 @@ If you lose it, your users will be unable to upgrade.
     end
 
     def gitignore_path
-      project_path + ".gitignore"  
+      project_path + ".gitignore"
     end
 
     def sparkle_release_path

data/lib/motion/project/version.rb

@@ -1,5 +1,5 @@
 module Motion::Project
   class Sparkle
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/spec/sparkle_spec.rb

@@ -24,6 +24,13 @@ describe "motion-sparkle" do
           release :base_url, 'http://example.com' 
           release :public_key, 'public_key.pem'
           release :version, '1.0'
+          # Optional config options
+          release :feed_base_url, 'http://rss.example.com'
+          release :feed_filename, 'example.xml'
+          release :notes_base_url, 'http://www.example.com'
+          release :notes_filename, 'example.html'
+          release :package_base_url, 'http://download.example.com'
+          release :package_filename, 'example.zip'
         end
       end
     end
@@ -34,7 +41,15 @@ describe "motion-sparkle" do
   end
 
   it "Sparkle's feed url should be set correctly" do
-    @config.info_plist['SUFeedURL'].should.equal 'http://example.com/releases.xml'
+    @config.info_plist['SUFeedURL'].should.equal 'http://rss.example.com/example.xml'
+  end
+
+  it "Sparkle's release notes url should be set correctly" do
+    @config.sparkle.appcast.notes_url.should.equal 'http://www.example.com/example.html'
+  end
+
+  it "Sparkle's appcast package url should be set correctly" do
+    @config.sparkle.appcast.package_url.should.equal 'http://download.example.com/example.zip'
   end
 
   it "Sparkle's public key should have custom name" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-sparkle
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexandre L. Solleiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies: []
 description: motion-sparkle makes it easy to use Sparkle with your RubyMotion projects
 email: alex@webcracy.org
@@ -1002,8 +1002,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sparkle integration for Rubymotion projects
 test_files: []
+has_rdoc: