s3-static-site 0.2.0 → 0.3.0

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# s3-static-site
+
+> Allows static websites deployment to Amazon S3 website buckets using Capistrano.
+
+## Hosting your website with Amazon S3
+
+S3 provides special website enabled buckets that allows you to deliver website pages directly from S3.
+The most important difference is that theses buckets serves an index document (ex. index.html) whenever a user specifies the URL for the root of your website, or a subfolder. And you can point your domain name directly to the S3 bucket cname.
+
+To learn how to setup your website bucket, see [Amazon Documentation](http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html?HostingWebsiteQS1.html).
+
+## Getting started
+
+Setup capistrano, create a public folder and set your S3 bucket configurations in `deploy.rb`.
+
+    $ capify .
+    $ mkdir public
+    $ touch config/deploy.rb #see config instructions bellow
+    $ cap deploy
+
+### Configuring deployment
+
+s3-static-site overrides the default Capistrano recipes for Rails projects with its own simple s3 publishing scripts.
+
+    # config/deploy.rb
+    require 's3-static-site'
+
+    set :bucket, "www.cool-website-bucket.com"
+    set :access_key_id, "CHANGETHIS"
+    set :secret_access_key, "CHANGETHIS"
+
+If you want to deploy to multiple buckets, have a look at
+[Capistrano multistage](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension)
+and  configure a bucket per stage configuration.
+
+#### S3 write options
+
+s3-static-site sets files `:content_type` and `:acl` to `:public_read`, add or override with :
+
+    set :bucket_write_options, {
+        cache_control: "max-age=94608000, public"
+    }
+
+See aws-sdk [S3Object.write doc](http://rubydoc.info/github/amazonwebservices/aws-sdk-for-ruby/master/AWS/S3/S3Object#write-instance_method) for all available options.
+
+### Built-in HAML template rendering and SASS compile
+  
+On deployment, `.haml` and `.sass` are generated and uploaded (source .haml and .sass are not uploaded).
+
+### Advanced static website generation & assets management
+
+If you wish to manage your assets with a packaging system, a simple way do to it
+is using a combination of :
+
+- [Sinatra](https://github.com/sinatra/sinatra) : simple web framework that we extend for our needs
+- [Sinatra-AssetPack](https://github.com/rstacruz/sinatra-assetpack) : deals with version management for all kind of assets
+- [Sinatra-Static](https://github.com/paulasmuth/sinatra-static) : generate your complete website in `public/`, allowing an `s3-static-site` deployment
+
+IMPORTANT : to achieve `Sinatra-AssetPack` and `Sinatra-Static` compatibility, see [pull request #1](https://github.com/paulasmuth/sinatra-static/pull/1)
+or use [a patched fork](https://github.com/hooktstudios/sinatra-static).
+
+Once you get this together, add a capistrano task to trigger website generation before deploy :
+
+    # config/deploy.rb
+    before 'deploy' do
+      run_locally "bundle exec ruby app.rb"
+      run_locally "bundle exec rake assetpack:build"
+    end
+
+## Copyright
+
+Copyright (c) 2012 Josh Delsman & miomoba, Inc. See LICENSE.txt for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/s3-static-site.rb

@@ -1,5 +1,6 @@
 require 'haml'
 require 'aws/s3'
+require 'mime/types'
 
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "s3-static-site requires Capistrano >= 2."
@@ -10,7 +11,8 @@ Capistrano::Configuration.instance(true).load do
     set(name, *args, &block) if !exists?(name)
   end
   
-  _cset :deployment_path, `pwd`.gsub("\n", "") + "/public"
+  _cset :deployment_path, Dir.pwd.gsub("\n", "") + "/public"
+  _cset :deploy_to, ""
   
   def base_file_path(file)
     file.gsub(deployment_path, "")
@@ -64,7 +66,20 @@ Capistrano::Configuration.instance(true).load do
               open(file)
             end
 
-            _s3.buckets[bucket].objects[path].write(contents, :acl => :public_read)
+            types = MIME::Types.type_for(File.basename(file))
+            if types.empty?
+              options = {
+                :acl => :public_read
+              }
+            else
+              options = {
+                :acl => :public_read,
+                :content_type => types[0]
+              }
+            end
+
+            target = deploy_to.empty? ? path : File.join(deploy_to, path)
+            _s3.buckets[bucket].objects[target].write(contents, options)
           end
         end
       end
@@ -76,4 +91,4 @@ Capistrano::Configuration.instance(true).load do
 
     task :restart do; end
   end
-end
+end

data/s3-static-site.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "s3-static-site"
   gem.require_paths = ["lib"]
-  gem.version       = "0.2.0"
+  gem.version       = "0.3.0"
 
   # Gem dependencies
   gem.add_dependency("aws-sdk")
   gem.add_dependency("capistrano")
   gem.add_dependency("haml")
+  gem.add_dependency("mime-types")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3-static-site
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -56,7 +56,23 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Using Ruby and Capistrano, build and deploy a static website to Amazon
@@ -69,9 +85,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/s3-static-site.rb
@@ -86,19 +101,20 @@ require_paths:
 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.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Using Ruby and Capistrano, build and deploy a static website to Amazon S3
 test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,65 +0,0 @@
-= s3-static-site
-
-Allows users to deploy static websites to Amazon S3 using Capistrano.
-
-== Setup
-
-In order to get started, you need to install the following gem:
-
-  gem install s3-static-site
-  
-This will install the gem, along with the dependencies: Capistrano 2+ and AWS::S3.
-
-== Creating a website
-
-To start a static website, just create a folder somewhere on your hard drive:
-
-  mkdir -p ~/www.tastyrails.com
-  
-Once you do that, you'll need to generate deployment scripts
-
-  cd ~/www.tastyrails.com
-  capify .
-  cat /dev/null > config/deploy.rb
-
-== Configure your deployment
-
-s3-static-site overrides the default Capistrano recipes for Rails projects with its own scripts. Here's a sample deployment script to get you started:
-
-  require 's3-static-site'
-
-  set :bucket, "www.tastyrails.com"
-  set :access_key_id, "access-key-id"
-  set :secret_access_key, "secret-access-key"
-
-Replace the +access_key_id+ and +secret_access_key+ from the values found in the AWS Management Console. 
-
-== Create your bucket
-
-If you haven't already created a bucket for use with Amazon S3 static website hosting, you'll need to do this before deployment. Instructions can be found here:
-
-http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html?HostingWebsiteQS1.html
-
-== Deploying
-
-After setting up your +config/deploy.rb+ file and creating the bucket with Amazon, you can deploy using the following command:
-
-  cap deploy
-
-== Rendering with HAML or SASS
-
-s3-static-site allows you to either upload files to S3 as you'd statically find them on your hard drive, or you can use HAML or SASS to generate HTML using Ruby.
-
-For HAML generation, append +.haml+ to the end of your file, like:
-
-  index.html.haml
-  
-For SASS:
-
-  stylesheet.css.sass
-  
-When uploaded to S3, the +.haml+ and +.sass+ will be removed, leaving either +index.html+ or +stylesheet.css+.
-
-== Copyright 
-
-Copyright (c) 2011 Josh Delsman. See LICENSE.txt for details.