fog_site 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end
+
+gem "fog", ">= 0.10.0"
+gem "colorize"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brian P O'Rourke
+
+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,63 @@
+# fog_site #
+
+*fog_site* is a simple utility gem for deploying a static site to Amazon S3 and
+CloudFront using the *fog* gem.
+
+To make deployments fast, this gem calculates the MD5 sum of every file locally
+and compares them against the information stored on S3 (in the 'etag' property
+of the S3 object). Files are only uploaded if the etag has changed.
+
+## Usage ##
+
+Create a new site
+
+    site = FogSite.new "www.stovepipeapp.com"
+
+Decide what you want to deploy
+
+    site.path = "/home/bpo/stovepipe"
+
+Decide whether to destroy resources that aren't local
+
+    site.destroy_old_files = true
+
+If you're using CloudFront, specify a distribution ID:
+
+    site.distribution_id = "Z99120CAFEBABE"
+
+And push it to the cloud
+
+    site.deploy!
+
+All local settings for a site can be passed into the `new_site` method:
+
+    FogSite.new "stovepipeapp.com", :path => "/home/bpo/stovepipe",
+                                             :destroy_old_files => true
+
+AWS credentials are read from the environment variables `AWSAccessKeyId` and
+`AWSSecretKey`, but can also be set programmatically:
+
+    site = FogSite.new "stovepipeapp.com"
+    site.access_key_id = "E7L8CCM59BFXJOAMEAPT"
+    site.secret_key = "t5nszajv3y8u4zI/LtP/r5xUmPnqAT/Tv2n7Xr7n"
+
+## Notes ##
+
+### Choice of Domains ###
+You can't point a CNAME to the apex of a zone, which means you can't use S3 +
+CloudFront to deploy to 'foo.com', you can only deploy to a subdomain like
+'www.foo.com'. If you want to have a URL like 'foo.com' work, you'll need to set
+up a lightweight server that can accept requests for 'foo.com' and send a 301
+permanent redirect to www.foo.com.
+
+### Cloudfront Cache Invalidation ###
+
+This gem uses cache invalidation to force new content to be refreshed by
+CloudFront distributions. This works just fine, but if your content changes
+often, it's better (and cheaper) to use versioning. See the CloudFront developer
+guide for details on how to implement a versioning system.
+
+## Copyright ##
+
+Copyright (c) 2011 Brian P O'Rourke. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fog_site"
+  gem.homepage = "http://github.com/bpo/fog_site"
+  gem.license = "MIT"
+  gem.summary = %Q{Deploys static sites to S3 using fog}
+  gem.description = %Q{Simple utility gem for deploying static sites to S3 and CloudFront using fog.}
+  gem.email = "bpo@somnambulance.net"
+  gem.authors = ["Brian P O'Rourke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/fog_site.rb

@@ -0,0 +1,157 @@
+require 'fog'
+require "colorize"
+
+# 
+# A FogSite represents a site to be deployed to S3 and CloudFront. This object
+# is a simple data structure, which is deployed with a `FogSite::Deployer`
+#
+class FogSite
+  attr_reader :domain_name
+  attr_writer :access_key_id, :secret_key
+  attr_accessor :path, :destroy_old_files, :distribution_id
+
+  def initialize( domain_name, attributes_map = {})
+    @domain_name = domain_name
+    attributes_map.each do |name, val|
+      setter = (name.to_s + "=").to_sym
+      self.send(setter, val)
+    end
+  end
+
+  def access_key_id
+    @access_key_id || ENV["AWSAccessKeyId"]
+  end
+
+  def secret_key
+    @secret_key || ENV["AWSSecretKey"]
+  end
+
+  def deploy!
+    Deployer.run(self)
+  end
+
+  # Used to actually execute a deploy. This object is not safe for reuse - the
+  # `@index` and `@updated_paths` stay dirty after a deploy to allow debugging
+  # and inspection by client scripts.
+  class Deployer
+    attr_reader :index, :updated_paths
+    class UsageError < StandardError ; end
+
+    # Run a single deploy. Creates a new `Deployer` and calls `run`.
+    def self.run( site, options = {} )
+      deployer = Deployer.new( site )
+      deployer.run
+    end
+
+    def initialize( site )
+      @site = site
+      @index = {}
+      @updated_paths = []
+    end
+
+    # Validate our `Site`, create a and configure a bucket, build the index,
+    # sync the files and (finally) invalidate all paths which have been updated
+    # on the content distribution network.
+    def run
+      validate
+      make_directory
+      Dir.chdir @site.path do
+        build_index
+        sync_remote
+        if( @site.distribution_id )
+          invalidate_cache(@site.distribution_id)
+        end
+      end
+    end
+
+    def validate
+      assert_not_nil @site.access_key_id, "No AccessKeyId specified"
+      assert_not_nil @site.secret_key, "No SecretKey specified"
+    end
+
+    # Creates an S3 bucket for web site serving, using `index.html` and
+    # `404.html` as our special pages.
+    def make_directory
+      domain = @site.domain_name
+      puts "Using bucket: #{domain}".blue
+      @directory = connection.directories.create :key => domain,
+                                                 :public => true
+      connection.put_bucket_website(domain, 'index.html', :key => "404.html")
+    end
+
+    # Build an index of all the local files and their md5 sums. This will be
+    # used to decide what needs to be deployed.
+    def build_index
+      Dir["**/*"].each do |path|
+        unless File.directory?( path )
+          @index[path] = Digest::MD5.file(path).to_s
+        end
+      end
+    end
+
+    # Synchronize our local copy of the site with the remote one. This uses the
+    # index to detect what has been changed and upload only new/updated files.
+    # Helpful debugging information is emitted, and we're left with a populated
+    # `updated_paths` instance variable which can be used to invalidate cached
+    # content.
+    def sync_remote
+      @directory.files.each do |remote_file|
+        path = remote_file.key
+        local_file_md5 = @index[path]
+
+        if local_file_md5.nil? and @site.destroy_old_files
+          puts "#{path}: deleted".red
+          remote_file.destroy
+        elsif local_file_md5 == remote_file.etag
+          puts "#{path}: unchanged".white
+          @index.delete( path )
+        else
+          puts "#{path}: updated".green
+          write_file( path )
+          @index.delete( path )
+          @updated_paths << ("/" + path)
+        end
+      end
+
+      @index.each do |path, md5|
+        puts "#{path}: new".green
+        write_file( path )
+      end
+    end
+
+    # Push a single file out to S3.
+    def write_file( path )
+      @directory.files.create :key => path,
+                              :body => File.open( path ),
+                              :public => true
+    end
+
+    # Compose and post a cache invalidation request to CloudFront. This will
+    # ensure that all CloudFront distributions get the latest content quickly.
+    def invalidate_cache( distribution_id )
+      unless @updated_paths.empty?
+        cdn.post_invalidation distribution_id, @updated_paths
+      end
+    end
+
+    def cdn
+      @cdn ||= Fog::CDN.new( credentials )
+    end
+
+    def connection
+      @connection ||= Fog::Storage.new( credentials )
+    end
+
+    def credentials
+      {
+        :provider              => 'AWS',
+        :aws_access_key_id     => @site.access_key_id,
+        :aws_secret_access_key => @site.secret_key
+      }
+    end
+
+    def assert_not_nil( value, error )
+      raise UsageError.new( error ) unless value
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fog_site'
+
+class Test::Unit::TestCase
+end

data/test/test_fog_site.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFogSite < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: fog_site
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Brian P O'Rourke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-22 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  name: fog
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: colorize
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  name: jeweler
+  version_requirements: *id004
+description: Simple utility gem for deploying static sites to S3 and CloudFront using fog.
+email: bpo@somnambulance.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/fog_site.rb
+- test/helper.rb
+- test/test_fog_site.rb
+has_rdoc: true
+homepage: http://github.com/bpo/fog_site
+licenses: 
+- MIT
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Deploys static sites to S3 using fog
+test_files: []
+