static_sync 0.0.1 → 0.1.0

data/README.md

@@ -1,13 +1,19 @@
 # StaticSync
 
-This gem provides a stand alone mechanism for uploading static websites to cloud hosting providers such as 
-[Amazon AWS](http://en.wikipedia.org/wiki/Amazon_S3#Hosting_entire_websites).
+This gem provides a command line tool for uploading static websites to amazon/rackspace.
 
 ### Features
 
-* Standalone.
-* Configurable caching.
-* Automatic gzip compression.
+* Compares the md5 cheksum of each file before deciding to upload it.
+* Automatically gzips non binary files.
+* Sets appropriate HTTP metadata header information for serving html files.
+    * Content Type (text/css, image/png etc).
+    * Cache Control (public, max-age=31536000).
+    * Content Enconding (gzip).
+
+## Requirements
+
+* Ruby 1.9
 
 ## Installation
 
@@ -15,23 +21,36 @@ This gem provides a stand alone mechanism for uploading static websites to cloud
   gem install static_sync
 ```
 
-## Usage
+## Example Usage
 
 In your project directory create a `.static` file:
 
 ```
 > cat .static
+
+# Source directory
 local:
-  directory: build # The directory to upload
+  directory: build
 
+# Target directory
 remote:
   provider: AWS
   username: my-aws-key
   password: my-aws-secret
   directory: my-aws-bucket
+
+# Number of seconds to cache each content type, defaults to no cache.
+cache:
+  html: 31536000
+  javascript: 31536000
+  css: 31536000
+  image: 31536000
+
+# Flag to enable / disable automatic gzip compression.
+gzip: true
 ```
 
-And run the following command any time you want to upload.
+And simply run the following command any time you want to upload.
 
 ```bash
   static_sync
@@ -49,28 +68,6 @@ remote:
   directory: <%= ENV['s3_bucket'] %>
 ```
 
-### Cache Control
-
-By default uploaded files are not cached.
-
-You can cache content for a given number of seconds by updating your `.static` file:
-
-```
-cache:
-  javascript: 31536000
-  css: 31536000
-```
-
-### Compression
-
-By default uploaded files are not compressed.
-
-You can gzip all non binary content by updating your `.static` file:
-
-```
-gzip: true
-```
-
 ## Contributing
 
 1. Fork it

data/bin/static_sync

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require "static_sync"
+require_relative "../lib/static_sync"
 
 StaticSync.upload
-

data/lib/static_sync.rb

@@ -1,10 +1,3 @@
-require "rubygems"
-require "fog"
-require "erb"
-require "logger"
-require "tempfile"
-require "zlib"
-
 require_relative "static_sync/version"
 require_relative "static_sync/config"
 require_relative "static_sync/storage"

data/lib/static_sync/config.rb

@@ -1,10 +1,14 @@
+require "erb"
+
 module StaticSync
   class Config < Hash
 
-    # TODO Validate.
+    def log
+      self.fetch('log', true)
+    end
 
     def cache
-      self['cache'] || {}
+      self.fetch('cache', {})
     end
 
     def source

data/lib/static_sync/meta.rb

@@ -1,45 +1,42 @@
+require "digest/md5"
+require "mime/types"
+
+require_relative "meta/caching"
+require_relative "meta/compression"
+
 module StaticSync
   class Meta
 
     def initialize(config)
-      @config = config
+      @config      = config
+      @compression = Compression.new(@config)
+      @caching     = Caching.new(@config)
     end
 
-    #TODO This class / method has too many responsibilities.
     def for(file)
       meta = {
-        :key    => file,
-        :body   => File.new(file),
-        :public => true
+        :key                => file,
+        :body               => File.new(file),
+        :public             => true,
+        :storage_class      => 'REDUCED_REDUNDANCY'
       }
-      MIME::Types::of(file).each do |mime|
-        if @config.gzip
-          unless mime.binary?
-            meta.merge!(
-              :body             => gzip(file),
-              :content_encoding => 'gzip'
-            )
-          end
-        end
+
+      mime = MIME::Types::of(file).first
+
+      if mime
         meta.merge!(
           :content_type => MIME::Type.simplified(mime)
         )
-        if @config.cache.has_key?(mime.sub_type)
-          expiry = @config.cache[mime.sub_type].to_i
-          meta.merge!(
-            :cache_control => "public, max-age=#{expiry}"
-          )
-        end
+        meta.merge!(@compression.for(file, mime))
+        meta.merge!(@caching.for(file, mime))
       end
-      meta
-    end
 
-    def gzip(file)
-      zipped = Tempfile.new("static_sync")
-      Zlib::GzipWriter.open(zipped) do |archive|
-        archive.write File.read(file)
-      end
-      zipped
+      body = meta[:body].read
+
+      meta.merge!(
+        :etag        => Digest::MD5.hexdigest(body),   # A local version of the etag expected after upload.
+        :content_md5 => Digest::MD5.base64digest(body) # Enable checksum validation during uploads.
+      )
     end
 
   end

data/lib/static_sync/meta/caching.rb

@@ -0,0 +1,24 @@
+module StaticSync
+  class Meta
+    class Caching
+
+      def initialize(config)
+        @config = config
+      end
+
+      def for(file, mime)
+        meta = {}
+        type = mime.sub_type
+        type = mime.media_type if mime.media_type == "image"
+        if @config.cache.has_key?(type)
+          expiry = @config.cache[type].to_i
+          meta.merge!(
+            :cache_control => "public, max-age=#{expiry}"
+          )
+        end
+        meta
+      end
+
+    end
+  end
+end

data/lib/static_sync/meta/compression.rb

@@ -0,0 +1,38 @@
+require "tempfile"
+require "zlib"
+
+module StaticSync
+  class Meta
+    class Compression
+
+      def initialize(config)
+        @config = config
+      end
+
+      def for(file, mime)
+        meta = {}
+        if @config.gzip && !mime.binary?
+          meta.merge!(
+            :body             => gzip(file),
+            :content_encoding => 'gzip'
+          )
+        end
+        meta
+      end
+
+      private
+
+      def gzip(file)
+        zipped = Tempfile.new("static_sync")
+        Zlib::GzipWriter.open(zipped) do |archive|
+          # Gzip by default incorporates file creation time into the content.
+          # For the purpose of repeatable etag comparison we want avoid this.
+          archive.mtime = 1
+          archive.write File.read(file)
+        end
+        zipped
+      end
+
+    end
+  end
+end

data/lib/static_sync/storage.rb

@@ -1,3 +1,6 @@
+require "fog"
+require "logger"
+
 require_relative "meta"
 
 module StaticSync
@@ -9,18 +12,40 @@ module StaticSync
     end
 
     def sync
+      remote_keys = []
+      remote_directory.files.each do |file|
+        remote_keys << [file.key, file.etag]
+      end
       Dir.chdir(@config.source) do
-        Dir.glob("**/*.*") do |file|
-          log.info("Uploading #{file}")
-          @config.storage.directories.get(@config.storage_directory).files.create(
-            @meta.for(file)
-          )
+        local_files.each do |file|
+          current_file     = @meta.for(file)
+          current_file_key = [current_file[:key], current_file[:etag]]
+
+          unless remote_keys.include?(current_file_key)
+            log.info("Uploading #{file}") if @config.log
+            begin
+              remote_directory.files.create(current_file)
+            rescue => error
+              log.error("Failed to upload #{file}")
+              raise error
+            end
+          end
         end
       end
     end
 
     private
 
+    def local_files
+      Dir.glob("**/*.*").reject do |file|
+        File.directory?(file)
+      end
+    end
+
+    def remote_directory
+      @config.storage.directories.new(:key => @config.storage_directory)
+    end
+
     def log
       @log ||= begin
         logger = Logger.new(STDOUT)

data/lib/static_sync/version.rb

@@ -1,3 +1,3 @@
 module StaticSync
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/meta/caching_spec.rb

@@ -0,0 +1,75 @@
+require "mime/types"
+require "./lib/static_sync/config"
+require "./lib/static_sync/meta/caching"
+
+describe StaticSync::Meta::Caching do
+
+  let(:config) { StaticSync::Config.new }
+
+  let(:html)   { MIME::Type.new('text/html') }
+  let(:plain)  { MIME::Type.new('text/plain') }
+  let(:css)    { MIME::Type.new('text/css') }
+  let(:gif)    { MIME::Type.new('image/gif') }
+  let(:jpg)    { MIME::Type.new('image/jpg') }
+  let(:png)    { MIME::Type.new('image/png') }
+
+  subject do
+    StaticSync::Meta::Caching.new(config)
+  end
+
+  context "when caching is completely disabled" do
+
+    before do
+      config['cache'] = { }
+    end
+
+    describe "#for" do
+      it "does not set cache headers for html files" do
+        subject.for("index.html", html).should_not include(:cache_control)
+      end
+    end
+  end
+
+  context "when caching is enabled for html only" do
+
+    before do
+      config['cache'] = { 'html' => '86400' }
+    end
+
+    describe "#for" do
+      it "sets cache headers for html files" do
+        subject.for("index.html", html).should include(:cache_control)
+      end
+
+      it "does not set cache headers for text files" do
+        subject.for("data.txt", plain).should_not include(:cache_control)
+      end
+
+      it "does not set cache headers for css files" do
+        subject.for("screen.css", css).should_not include(:cache_control)
+      end
+    end
+  end
+
+  context "when caching is enabled for images" do
+
+    before do
+      config['cache'] = { 'image' => '86400' }
+    end
+
+    describe "#for" do
+      it "sets cache headers for gif files" do
+        subject.for("spinner.gif", gif).should include(:cache_control)
+      end
+
+      it "sets cache headers for jpg files" do
+        subject.for("kitten.jpg", jpg).should include(:cache_control)
+      end
+
+      it "sets cache headers for png files" do
+        subject.for("cat.png", png).should include(:cache_control)
+      end
+    end
+  end
+
+end

data/spec/meta/compression_spec.rb

@@ -0,0 +1,50 @@
+require "mime/types"
+require "./lib/static_sync/config"
+require "./lib/static_sync/meta/compression"
+
+describe StaticSync::Meta::Compression do
+
+  let(:config) { StaticSync::Config.new }
+
+  let(:html)   { MIME::Type.new('text/html') }
+  let(:image)  { MIME::Type.new('image/gif') }
+
+  subject do
+    StaticSync::Meta::Compression.new(config)
+  end
+
+  before do
+    File.stub(:read).and_return("")
+  end
+
+  context "when compression is disabled" do
+
+    before do
+      config['gzip'] = false
+    end
+
+    describe "#for" do
+      it "does not set compression headers for html files" do
+        subject.for("index.html", html).should_not include(:content_encoding => "gzip")
+      end
+    end
+  end
+
+  context "when compression is enabled" do
+
+    before do
+      config['gzip'] = true
+    end
+
+    describe "#for" do
+      it "sets compression headers for html files" do
+        subject.for("index.html", html).should include(:content_encoding => "gzip")
+      end
+
+      it "does not set compression headers for binary files" do
+        subject.for("assets/images/spinner.gif", image).should_not include(:content_encoding => "gzip")
+      end
+    end
+  end
+
+end

data/spec/meta_spec.rb

@@ -1,7 +1,3 @@
-require "cgi"
-require "mime/types"
-require "tempfile"
-require "zlib"
 require "./lib/static_sync/config"
 require "./lib/static_sync/meta"
 
@@ -13,6 +9,21 @@ describe StaticSync::Meta do
     StaticSync::Meta.new(config)
   end
 
+  it "sets files as public" do
+    Dir.chdir("spec/fixtures/site") do
+      subject.for("index.html").should include(:public => true)
+    end
+  end
+
+  it "sets appropriate content types for a range of common file types" do
+    Dir.chdir("spec/fixtures/site") do
+      subject.for("index.html").should                       include(:content_type => "text/html")
+      subject.for("assets/images/spinner.gif").should        include(:content_type => "image/gif")
+      subject.for("assets/stylesheets/screen.css").should    include(:content_type => "text/css")
+      subject.for("assets/javascripts/jquery.min.js").should include(:content_type => "application/javascript")
+    end
+  end
+
   describe "all files" do
 
     it "should be public" do
@@ -35,41 +46,5 @@ describe StaticSync::Meta do
       end
     end
 
-    it "should cache files when requested" do
-      config['cache'] = {
-        'css'        => '86400',
-        'javascript' => '86400'
-      }
-      Dir.chdir("spec/fixtures/site") do
-        subject.for("index.html").should_not include(
-          :cache_control
-        )
-        subject.for("assets/stylesheets/screen.css").should include(
-          :cache_control
-        )
-        subject.for("assets/javascripts/jquery.min.js").should include(
-          :cache_control
-        )
-      end
-    end
-
-    it "should gzip files when requested" do
-      Dir.chdir("spec/fixtures/site") do
-        subject.for("index.html").should_not include(
-          :content_encoding => 'gzip'
-        )
-        config['gzip'] = true
-        subject.for("index.html").should include(
-          :content_encoding => 'gzip'
-        )
-        subject.for("assets/stylesheets/screen.css").should include(
-          :content_encoding => 'gzip'
-        )
-        subject.for("assets/javascripts/jquery.min.js").should include(
-          :content_encoding => 'gzip'
-        )
-      end
-    end
-
   end
 end

data/spec/storage_spec.rb

@@ -1,9 +1,11 @@
-require "./lib/static_sync"
+require "./lib/static_sync/config"
+require "./lib/static_sync/storage"
 
 describe StaticSync::Storage do
 
   let(:config) do
     StaticSync::Config.new.merge({
+      'log' => false,
       'local' => {
         'directory' => 'spec/fixtures/site'
       },
@@ -22,28 +24,39 @@ describe StaticSync::Storage do
 
   before do
     Fog.mock!
-    config.storage.directories.create(
-      :key    => config.storage_directory,
-      :public => true
-    )
   end
 
   after do
     Fog::Mock.reset
   end
 
-  describe "html files" do
+  context "with a remote storage directory" do
 
-    it "are uploaded to the remote directory" do
-      subject.sync
+    before do
+      config.storage.directories.create(
+        :key    => config.storage_directory,
+        :public => true
+      )
+    end
+
+    context "syncing a new site" do
+
+      describe "#sync" do
 
-      config.storage.directories.get(config.storage_directory).files.map(&:key).should == [
-        "assets/javascripts/jquery.min.js",
-        "assets/stylesheets/screen.css",
-        "index.html"
-      ]
+        it "sets a unique key for each uploaded file" do
+          subject.sync
+
+          config.storage.directories.get(config.storage_directory).files.map(&:key).should == [
+            "assets/images/spinner.gif",
+            "assets/javascripts/jquery.min.js",
+            "assets/stylesheets/screen.css",
+            "assets/stylesheets/screen.scss",
+            "cat.com/index.html",
+            "index.html"
+          ]
+        end
+      end
     end
 
   end
-
 end

data/static_sync.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = StaticSync::VERSION
   gem.authors       = ["Shanon McQuay"]
   gem.email         = ["shanonmcquay@gmail.com"]
-  gem.summary       = %q{Uploads your static website to cloud storage.}
+  gem.summary       = %q{Command line tool for uploading static websites to amazon/rackspace.}
 
   gem.files         = `git ls-files`.split($/)
   gem.bindir        = "bin"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static_sync
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -60,11 +60,18 @@ files:
 - lib/static_sync.rb
 - lib/static_sync/config.rb
 - lib/static_sync/meta.rb
+- lib/static_sync/meta/caching.rb
+- lib/static_sync/meta/compression.rb
 - lib/static_sync/storage.rb
 - lib/static_sync/version.rb
+- spec/fixtures/site/assets/images/spinner.gif
 - spec/fixtures/site/assets/javascripts/jquery.min.js
 - spec/fixtures/site/assets/stylesheets/screen.css
+- spec/fixtures/site/assets/stylesheets/screen.scss
+- spec/fixtures/site/cat.com/index.html
 - spec/fixtures/site/index.html
+- spec/meta/caching_spec.rb
+- spec/meta/compression_spec.rb
 - spec/meta_spec.rb
 - spec/storage_spec.rb
 - static_sync.gemspec
@@ -91,8 +98,9 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Uploads your static website to cloud storage.
+summary: Command line tool for uploading static websites to amazon/rackspace.
 test_files:
+- spec/meta/caching_spec.rb
+- spec/meta/compression_spec.rb
 - spec/meta_spec.rb
 - spec/storage_spec.rb
-has_rdoc: false