capistrano-s3 0.2.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2012-2013 Jean-Philippe Doyle, Hookt Studios inc., Joshua Delsman/miomoba, Inc.
+
+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,74 @@
+# 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.
+
+```ruby
+# 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 :
+
+```ruby
+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.
+
+### 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 :
+
+```ruby
+# 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/Rakefile

@@ -0,0 +1 @@
+require 'rake'

data/capistrano-s3.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jean-Philippe Doyle","Josh Delsman"]
+  gem.email         = ["jeanphilippe.doyle@hooktstudios.com"]
+  gem.description   = "Using Ruby and Capistrano, build and deploy a static website to Amazon S3"
+  gem.summary       = "Using Ruby and Capistrano, build and deploy a static website to Amazon S3"
+  gem.homepage      = "http://github.com/hooktstudios/capistrano-s3"
+  gem.licenses      = ["MIT"]
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "capistrano-s3"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.2.1"
+
+  # Gem dependencies
+  gem.add_dependency("aws-sdk")
+  gem.add_dependency("capistrano")
+  gem.add_dependency("mime-types")
+end

data/lib/capistrano-s3.rb

@@ -0,0 +1,79 @@
+require 'aws/s3'
+require 'mime/types'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano-s3 requires Capistrano >= 2."
+end
+
+Capistrano::Configuration.instance(true).load do
+  def _cset(name, *args, &block)
+    set(name, *args, &block) if !exists?(name)
+  end
+  
+  _cset :deployment_path, Dir.pwd.gsub("\n", "") + "/public"
+  
+  def base_file_path(file)
+    file.gsub(deployment_path, "")
+  end
+  
+  def files
+    Dir.glob("#{deployment_path}/**/*")
+  end
+  
+  # Establishes the connection to Amazon S3
+  def establish_connection!
+    # Send logging to STDOUT
+    AWS.config(:logger => Logger.new(STDOUT))
+
+    AWS::S3.new(
+      :access_key_id => access_key_id,
+      :secret_access_key => secret_access_key
+    )
+  end
+  
+  # Deployment recipes
+  namespace :deploy do
+    namespace :s3 do      
+      desc "Empties bucket of all files. Caution when using this command, as it cannot be undone!"
+      task :empty do
+        _s3 = establish_connection!
+        _s3.buckets[bucket].clear!
+      end
+
+      desc "Upload files to the bucket in the current state"
+      task :upload_files do
+        _s3 = establish_connection!
+
+        files.each do |file|
+          if !File.directory?(file)
+            path = base_file_path(file)
+            path.gsub!(/^\//, "") # Remove preceding slash for S3
+
+            contents = case File.extname(path)
+            open(file)
+
+            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
+            options.merge!(bucket_write_options)
+            _s3.buckets[bucket].objects[path].write(contents, options)
+          end
+        end
+      end
+    end
+    
+    task :update do
+      s3.upload_files
+    end
+
+    task :restart do; end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-s3
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Jean-Philippe Doyle
+- Josh Delsman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Using Ruby and Capistrano, build and deploy a static website to Amazon
+  S3
+email:
+- jeanphilippe.doyle@hooktstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-s3.gemspec
+- lib/capistrano-s3.rb
+homepage: http://github.com/hooktstudios/capistrano-s3
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Using Ruby and Capistrano, build and deploy a static website to Amazon S3
+test_files: []
+has_rdoc: