static_sync 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in static_sync.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shanon McQuay
+
+MIT License
+
+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,80 @@
+# 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).
+
+### Features
+
+* Standalone.
+* Configurable caching.
+* Automatic gzip compression.
+
+## Installation
+
+```bash
+  gem install static_sync
+```
+
+## Usage
+
+In your project directory create a `.static` file:
+
+```
+> cat .static
+local:
+  directory: build # The directory to upload
+
+remote:
+  provider: AWS
+  username: my-aws-key
+  password: my-aws-secret
+  directory: my-aws-bucket
+```
+
+And run the following command any time you want to upload.
+
+```bash
+  static_sync
+```
+
+### Environment Variables
+
+You can reference environment variables in your `.static` file like this:
+
+```
+remote:
+  provider: AWS
+  username: <%= ENV['s3_key'] %>
+  password: <%= ENV['s3_secret'] %>
+  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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/static_sync

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

data/lib/static_sync/config.rb

@@ -0,0 +1,36 @@
+module StaticSync
+  class Config < Hash
+
+    # TODO Validate.
+
+    def cache
+      self['cache'] || {}
+    end
+
+    def source
+      self['local']['directory']
+    end
+
+    def storage
+      Fog::Storage.new({
+        :provider              => self['remote']['provider'],
+        :aws_access_key_id     => self['remote']['username'],
+        :aws_secret_access_key => self['remote']['password']
+      })
+    end
+
+    def storage_directory
+      self['remote']['directory']
+    end
+
+    def gzip
+      self['gzip']
+    end
+
+    def load(path = '.static')
+      self.replace(YAML.load_file(ERB.new(path).result))
+      self
+    end
+
+  end
+end

data/lib/static_sync/meta.rb

@@ -0,0 +1,46 @@
+module StaticSync
+  class Meta
+
+    def initialize(config)
+      @config = config
+    end
+
+    #TODO This class / method has too many responsibilities.
+    def for(file)
+      meta = {
+        :key    => file,
+        :body   => File.new(file),
+        :public => true
+      }
+      MIME::Types::of(file).each do |mime|
+        if @config.gzip
+          unless mime.binary?
+            meta.merge!(
+              :body             => gzip(file),
+              :content_encoding => 'gzip'
+            )
+          end
+        end
+        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
+      end
+      meta
+    end
+
+    def gzip(file)
+      zipped = Tempfile.new("static_sync")
+      Zlib::GzipWriter.open(zipped) do |archive|
+        archive.write File.read(file)
+      end
+      zipped
+    end
+
+  end
+end

data/lib/static_sync/storage.rb

@@ -0,0 +1,35 @@
+require_relative "meta"
+
+module StaticSync
+  class Storage
+
+    def initialize(config)
+      @config = config
+      @meta   = Meta.new(config)
+    end
+
+    def sync
+      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)
+          )
+        end
+      end
+    end
+
+    private
+
+    def log
+      @log ||= begin
+        logger = Logger.new(STDOUT)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+            "#{datetime}: #{severity} -- #{msg}\n"
+        end
+        logger
+      end
+    end
+
+  end
+end

data/lib/static_sync/version.rb

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

data/lib/static_sync.rb

@@ -0,0 +1,16 @@
+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"
+
+module StaticSync
+  def self.upload
+    Storage.new(Config.new.load).sync
+  end
+end

data/spec/meta_spec.rb

@@ -0,0 +1,75 @@
+require "cgi"
+require "mime/types"
+require "tempfile"
+require "zlib"
+require "./lib/static_sync/config"
+require "./lib/static_sync/meta"
+
+describe StaticSync::Meta do
+
+  let(:config) { StaticSync::Config.new }
+
+  subject do
+    StaticSync::Meta.new(config)
+  end
+
+  describe "all files" do
+
+    it "should be public" do
+      Dir.chdir("spec/fixtures/site") do
+        subject.for("index.html").should include(
+          :key          => "index.html",
+          :content_type => "text/html",
+          :public       => true
+        )
+        subject.for("assets/stylesheets/screen.css").should include(
+          :key          => "assets/stylesheets/screen.css",
+          :content_type => "text/css",
+          :public       => true
+        )
+        subject.for("assets/javascripts/jquery.min.js").should include(
+          :key          => "assets/javascripts/jquery.min.js",
+          :content_type => "application/javascript",
+          :public       => true
+        )
+      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

@@ -0,0 +1,49 @@
+require "./lib/static_sync"
+
+describe StaticSync::Storage do
+
+  let(:config) do
+    StaticSync::Config.new.merge({
+      'local' => {
+        'directory' => 'spec/fixtures/site'
+      },
+      'remote' => {
+        'provider'  => 'AWS',
+        'username'  => 'lol',
+        'password'  => 'cat',
+        'directory' => 'bucket'
+      }
+    })
+  end
+
+  subject do
+    StaticSync::Storage.new(config)
+  end
+
+  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
+
+    it "are uploaded to the remote directory" do
+      subject.sync
+
+      config.storage.directories.get(config.storage_directory).files.map(&:key).should == [
+        "assets/javascripts/jquery.min.js",
+        "assets/stylesheets/screen.css",
+        "index.html"
+      ]
+    end
+
+  end
+
+end

data/static_sync.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static_sync/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "static_sync"
+  gem.version       = StaticSync::VERSION
+  gem.authors       = ["Shanon McQuay"]
+  gem.email         = ["shanonmcquay@gmail.com"]
+  gem.summary       = %q{Uploads your static website to cloud storage.}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.bindir        = "bin"
+  gem.executables  << "static_sync"
+  gem.test_files    = Dir.glob("spec/**/*.rb")
+  gem.require_paths = ["lib"]
+  gem.has_rdoc      = false
+
+  gem.add_dependency("fog", [">= 1.5.0"])
+
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: static_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shanon McQuay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- shanonmcquay@gmail.com
+executables:
+- static_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/static_sync
+- lib/static_sync.rb
+- lib/static_sync/config.rb
+- lib/static_sync/meta.rb
+- lib/static_sync/storage.rb
+- lib/static_sync/version.rb
+- spec/fixtures/site/assets/javascripts/jquery.min.js
+- spec/fixtures/site/assets/stylesheets/screen.css
+- spec/fixtures/site/index.html
+- spec/meta_spec.rb
+- spec/storage_spec.rb
+- static_sync.gemspec
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Uploads your static website to cloud storage.
+test_files:
+- spec/meta_spec.rb
+- spec/storage_spec.rb
+has_rdoc: false