glitter 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in glitter.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+  gem 'guard-rspec'
+  gem 'growl'
+  gem 'ruby-debug'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => '--colour' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -0,0 +1,58 @@
+# About Glitter
+
+Glitter is an easy way to publish Mac software updates to an Amazon S3 bucket using the Sparkle framework (http://sparkle.andymatuschak.org/). It was created at Poll Everywhere to eliminate the need maintaining additional server infrastructure for rolling out Mac desktop software updates. 
+
+It should also be noted that Glitter uses HTTPS S3 URLs to eliminate the need for the maintiance of public/private keys for Sparkle, which further simplifies the publishing process.
+
+# Getting started
+
+1.  Install the gem
+
+        gem install glitter
+
+2.  Generate a Glitterfile in your project directory
+
+        glitter init .
+
+3.  Edit the Glitterfile
+
+        # After you configure this file, deploy your app with `glitter push`
+        
+        name          "My App"
+        version       "1.0.0"
+        archive       "my_app.zip"
+        release_notes "http://myapp.com/release_notes/"
+        
+        s3 {
+          bucket            "my_app"
+          access_key        "access"
+          secret_access_key "sekret"
+        }
+
+4. Publish your app to the web
+
+        glitter push
+
+That's it!
+
+# License
+
+    Copyright (C) 2011 by Brad Gessler
+
+    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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/glitter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require File.expand_path('../../lib/glitter', __FILE__)
+
+Glitter::CLI.start

data/glitter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "glitter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "glitter"
+  s.version     = Glitter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brad Gessler"]
+  s.email       = ["brad@polleverywhere.com"]
+  s.homepage    = "https://github.com/polleverywhere/glitter"
+  s.summary     = %q{Publish Mac software updates with the Sparkle framework and Amazon S3.}
+  s.description = %q{Glitter makes it easy to publish software updates via the Sparkle framework by using S3 buckets.}
+
+  s.rubyforge_project = "glitter"
+  s.add_dependency "aws-s3"
+  s.add_dependency "haml"
+  s.add_dependency "thor"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/glitter.rb

@@ -0,0 +1,150 @@
+require 'aws/s3'
+require 'thor'
+require 'erb'
+
+module Glitter
+  # This mix-in Creates a DSL for configuring a class.
+  module Configurable
+    def self.included(base)
+      base.send :extend,  ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def configure(path=nil,&block)
+        path ? instance_eval(File.read(path), path) : instance_eval(&block)
+        self
+      end
+    end
+
+    module ClassMethods
+      def attr_configurable(*attrs)
+        attrs.each do |attr|
+          class_eval %(
+            attr_writer :#{attr}
+            attr_overloaded :#{attr})
+        end
+      end
+
+      def attr_overloaded(*attrs)
+        attrs.each do |attr|
+          class_eval(%{
+            def #{attr}(val=nil)
+              val ? instance_variable_set('@#{attr}', val) : instance_variable_get('@#{attr}')
+            end})
+        end
+      end
+
+      def configure(*args, &block)
+        new.configure(*args, &block)
+      end
+    end
+  end
+
+  # The configuration class that a release uses to deploy
+  class Configuration
+    TemplatePath = File.expand_path('../glitter/templates/Glitterfile', __FILE__).to_s.freeze
+
+    include Configurable
+    attr_configurable :name, :version, :archive, :release_notes, :s3
+
+    class S3
+      include Configurable
+      attr_configurable :bucket, :access_key, :secret_access_key
+
+      def credentials
+        {:access_key_id => access_key, :secret_access_key => secret_access_key}
+      end
+    end
+
+    def s3(&block)
+      @s3 ||= S3.configure(&block)
+    end
+  end
+
+  class Release
+    FeedTemplate = File.expand_path('../glitter/templates/rss.xml', __FILE__).to_s.freeze
+
+    attr_accessor :config, :released_at
+
+    def push
+      bucket.new_object(archive_name, file, bucket)
+    end
+
+    def initialize(config)
+      @config, @released_at = config, Time.now
+      AWS::S3::Base.establish_connection! config.s3.credentials
+    end
+
+    def name
+      "#{config.name} #{config.version}"
+    end
+
+    def object_name
+      "#{name.downcase.gsub(/\s/,'-')}#{File.extname(config.archive)}"
+    end
+
+    def pub_date
+      released_at.strftime("%a, %d %b %Y %H:%M:%S %z")
+    end
+
+    def appcast_url
+      url_for 'appcast.xml'
+    end
+
+    def url
+      url_for object_name
+    end
+
+    def to_rss
+      @rss ||= ERB.new(File.read(FeedTemplate)).result(binding)
+    end
+
+    def file
+      @file ||= File.open(config.archive, 'r')
+    end
+
+    def push
+      AWS::S3::S3Object.store(object_name, File.open(config.archive), config.s3.bucket)
+      AWS::S3::S3Object.store('appcast.xml', to_rss, config.s3.bucket)
+    end
+
+    def yank
+      AWS::S3::S3Object.store(object_name, config.s3.bucket)
+    end
+
+  private
+    def url_for(path)
+      "https://s3.amazonaws.com/#{config.s3.bucket}/#{path}"
+    end
+  end
+
+  # Command line interface for cutting glitter builds
+  class CLI < Thor
+    desc "init PATH", "Generate a Glitterfile for the path"
+    def init(path)
+      glitterfile_path = File.join(path, 'Glitterfile')
+      puts "Writing new Glitterfile to #{File.expand_path glitterfile_path}"
+
+      File.open glitterfile_path, 'w+' do |file|
+        file.write File.read(Configuration::TemplatePath)
+      end      
+    end
+
+    desc "push", "pushes a build to S3"
+    def push
+      puts "Pushing #{release.object_name} to bucket #{config.s3.bucket}..."
+      release.push
+      puts "Pushed to #{release.url}!"
+    end
+
+  private
+    def config
+      @config ||= Configuration.configure('./Glitterfile')
+    end
+
+    def release
+      @release ||= Release.new(config)
+    end
+  end
+end

data/lib/glitter/templates/Glitterfile

@@ -0,0 +1,11 @@
+# After you configure this file, deploy your app with `glitter push`
+name          "My App"
+version       "1.0.0"
+archive       "my_app.zip"
+release_notes "http://myapp.com/release_notes/"
+
+s3 {
+  bucket            "my_app"
+  access_key        "access"
+  secret_access_key "sekret"
+}

data/lib/glitter/templates/rss.xml

@@ -0,0 +1,14 @@
+<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
+<channel>
+<title><%= config.name %></title>
+<link><%= appcast_url %></link>
+<description>Software updates for <%= config.name %></description>
+<language>en</language>
+<item>
+  <title><%= name %></title>
+  <sparkle:releaseNotesLink><%= config.release_notes %></sparkle:releaseNotesLink>
+  <pubDate><%= pub_date %></pubDate>
+  <enclosure url="<%= url %>" sparkle:version="2.0" length="<%= file.stat.size %>" type="application/octet-stream" />
+</item>
+</channel>
+</rss>

data/lib/glitter/version.rb

@@ -0,0 +1,3 @@
+module Glitter
+  VERSION = "0.0.1"
+end

data/spec/lib/glitter_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'rexml/document'
+
+describe Glitter::Release do
+  before(:all) do
+    @release = Glitter::Release.new Glitter::Configuration.configure {
+      name          "My App"
+      version       "1.0.0"
+      archive       "lib/glitter.rb"
+      release_notes "http://myapp.com/release_notes/"
+
+      s3 {
+        bucket            "my_app"
+        access_key        "access"
+        secret_access_key "sekret"
+      }
+    }
+  end
+
+  it "should have name" do
+    @release.name.should eql("My App 1.0.0")
+  end
+
+  it "should generate rss entry" do
+    REXML::Document.new(@release.to_rss).root.attributes["sparkle"].should eql('http://www.andymatuschak.org/xml-namespaces/sparkle')
+  end
+
+  it "should have object_name" do
+    @release.object_name.should eql("my-app-1.0.0.rb")
+  end
+end
+
+describe Glitter::Configuration do
+
+  shared_examples_for "configuration" do
+    it "should read name" do
+      @config.name.should eql("My App")
+    end
+
+    it "should read version" do
+      @config.version.should eql("1.0.0")
+    end
+
+    it "should read archive" do
+      @config.archive.should eql("my_app.zip")
+    end
+
+    it "should read release notes" do
+      @config.release_notes.should eql("http://myapp.com/release_notes/")
+    end
+
+    context "s3" do
+      it "should read bucket" do
+        @config.s3.bucket.should eql("my_app")
+      end
+
+      it "should read access_key" do
+        @config.s3.access_key.should eql("access")
+      end
+
+      it "should read secret_access_key" do
+        @config.s3.secret_access_key.should eql("sekret")
+      end
+    end
+
+    it "should have a valid Glitterfile template path" do
+      File.exists?(Glitter::Configuration::TemplatePath).should be_true
+    end
+  end
+
+  context "block configuration" do
+    before(:all) do
+      @config = Glitter::Configuration.configure do
+        name          "My App"
+        version       "1.0.0"
+        archive       "my_app.zip"
+        release_notes "http://myapp.com/release_notes/"
+
+        s3 {
+          bucket            "my_app"
+          access_key        "access"
+          secret_access_key "sekret"
+        }
+      end
+    end
+    
+    it_should_behave_like "configuration"
+  end
+
+  context "file configuration" do
+    before(:all) do
+      @config = Glitter::Configuration.configure File.expand_path('../../../lib/glitter/templates/Glitterfile', __FILE__)
+    end
+    
+    it_should_behave_like "configuration"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'ruby-debug'
+require 'glitter'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: glitter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Glitter makes it easy to publish software updates via the Sparkle framework by using S3 buckets.
+email: 
+- brad@polleverywhere.com
+executables: 
+- glitter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/glitter
+- glitter.gemspec
+- lib/glitter.rb
+- lib/glitter/templates/Glitterfile
+- lib/glitter/templates/rss.xml
+- lib/glitter/version.rb
+- spec/lib/glitter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/polleverywhere/glitter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: glitter
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Publish Mac software updates with the Sparkle framework and Amazon S3.
+test_files: 
+- spec/lib/glitter_spec.rb
+- spec/spec_helper.rb