capistrano-s3 0.2.5 → 0.2.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTU0Yjg4Y2JlOTIyNmUwYzg0NDRmNWY5MDdkNGU0MjJlMGQxNGJkNA==
+  data.tar.gz: !binary |-
+    YTE5ODIwOTAwZDJiMDQ0YmViNTlmODI0MTIxNjQ2M2YwYWU0MjU4NA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZThlYmNlOGY0Y2FjZGYxZTRlMjcyNGZlZDdlZTFkYzY4ZTZhODIyMjc4NzBj
+    ZDdlNDc3MmVmNTZlZjVmOTBiMDM5MjVmZGRkZTEzZTgyNzIyMTE1Y2MzYTEw
+    NTJkMjk1OTg1OGQ4ZWJiNmNhNTg2ZTk2ZTBiZjI3ZmY0OWRkMzQ=
+  data.tar.gz: !binary |-
+    N2VlNzAxYWQ0N2UzNTdlMDg0MDExNGU2NTU1NTllZDQ1ODZiMzFjMWI4Yzk5
+    MTYwYmU0ZjY5ZWU1OThkNzcyMjM3Mzk5OGZhNTI4ZWMzMmZkODk0MzEyNzlh
+    YWY4YTQxMWQ5OTU3Mzc5NjRkZGQ0ZDY3OGM3YzQwYjhhNDkzNzA=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-s3 (0.2.5)
+    capistrano-s3 (0.2.6)
       aws-sdk
       capistrano
       mime-types
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-sdk (1.8.3.1)
+    aws-sdk (1.8.5)
       json (~> 1.4)
       nokogiri (>= 1.4.4)
       uuidtools (~> 2.1)
@@ -19,9 +19,9 @@ GEM
       net-sftp (>= 2.0.0)
       net-ssh (>= 2.0.14)
       net-ssh-gateway (>= 1.1.0)
-    highline (1.6.15)
+    highline (1.6.16)
     json (1.7.7)
-    mime-types (1.21)
+    mime-types (1.22)
     net-scp (1.1.0)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.1)
@@ -29,8 +29,8 @@ GEM
     net-ssh (2.6.6)
     net-ssh-gateway (1.2.0)
       net-ssh (>= 2.6.5)
-    nokogiri (1.5.6)
-    rake (10.0.3)
+    nokogiri (1.5.9)
+    rake (10.0.4)
     uuidtools (2.1.3)
 
 PLATFORMS

data/NEWS

@@ -1,3 +1,10 @@
+New in 0.2.6
+
+* Feature : Adds ability to specify redirect location for files. (#13) @aledovsky
+* Feature : Adds S3 endpoint selection option. (#11) @aledovsky
+* Improvement : Require fileutils to support newer rubies. (#10) @douglasjarquin
+* Bugfix : Pass a string to the content_type option (#11) @douglasjarquin
+
 New in 0.2.5
 
 * Improvement : signed gem.

data/README.md

@@ -8,23 +8,30 @@
 
 ## 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.
+Amazon S3 provides special websites enabled buckets that allows you to serve web pages from S3.
 
-To learn how to setup your website bucket, see [Amazon Documentation](http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html?HostingWebsiteQS1.html).
+To learn how to setup your website bucket, see [Amazon Documentation](http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
 
 ## Getting started
 
-Setup capistrano, create a public folder and set your S3 bucket configurations in `deploy.rb`.
+Create a project `Gemfile` :
 
-    $ capify .
-    $ mkdir public
-    $ touch config/deploy.rb #see config instructions bellow
-    $ cap deploy
+```ruby
+source 'https://rubygems.org'
+gem 'capistrano-s3'
+```
+
+### Setup
+
+Install gem, init capistrano & create a public folder that will be published :
+
+    bundle install
+    bundle exec capify .
+    mkdir public
 
-### Configuring deployment
+### Credentials
 
-capistrano-s3 overrides the default Capistrano recipes for Rails projects with its own simple s3 publishing scripts.
+Set your S3 bucket credentials :
 
 ```ruby
 # config/deploy.rb
@@ -35,9 +42,36 @@ set :access_key_id, "CHANGETHIS"
 set :secret_access_key, "CHANGETHIS"
 ```
 
+_Note_: If you are using S3 in non-default region (e.g. EU), you should provide
+corresponding
+[endpoint](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) 
+via configuration option
+```ruby
+set :s3_endpoint, 's3-eu-west-1.amazonaws.com'
+```
+
+### Deploying
+
+Add content to you public folder and deploy with :
+
+    cap deploy
+
 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.
+and configure a bucket per stage configuration.
+
+#### Redirecting
+
+Use `:redirect_options` to natively redirect (via HTTP 301 status code)
+any hosted page. For example:
+```ruby
+set :redirect_options, {
+  'index.html' => 'http://example.org',
+  'another.html' => '/test.html',
+}
+```
+Valid redirect destination should either start with `http` or `https` scheme,
+or begin with leading slash `/`.
 
 #### S3 write options
 
@@ -49,9 +83,9 @@ set :bucket_write_options, {
 }
 ```
 
-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.
+See aws-sdk [S3Client.put_object doc](http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/S3/Client.html#put_object-instance_method) for all available options.
 
-## Exemple of usage
+## Example of usage
 
 Our Ruby stack for static websites :
 
@@ -69,7 +103,9 @@ before 'deploy' do
 end
 ```
 
-See our boilerplate [sinatra-static-bp](https://github.com/hooktstudios/sinatra-static-bp) for an exemple of the complete setup.
+See our boilerplate
+[sinatra-static-bp](https://github.com/hooktstudios/sinatra-static-bp)
+for an example of the complete setup.
 
 ## Contributing
 
@@ -80,3 +116,5 @@ See [CONTRIBUTING.md](https://github.com/hooktstudios/capistrano-s3/blob/master/
 ![hooktstudios](http://hooktstudios.com/logo.png)
 
 [capistrano-s3](https://rubygems.org/gems/capistrano-s3) is maintained and funded by [hooktstudios](http://github.com/hooktstudios)
+
+Thanks & credits also to all other [contributors](https://github.com/hooktstudios/capistrano-s3/contributors).

data/capistrano-s3.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.authors       = ['Jean-Philippe Doyle','Josh Delsman']
+  s.authors       = ['Jean-Philippe Doyle','Josh Delsman','Aleksandrs Ļedovskis','Douglas Jarquin']
   s.email         = ['jeanphilippe.doyle@hooktstudios.com']
   s.description   = 'Enables static websites deployment to Amazon S3 website buckets using Capistrano.'
   s.summary       = 'Build and deploy a static website to Amazon S3'
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.name          = 'capistrano-s3'
   s.require_paths = ['lib']
-  s.version       = '0.2.5'
+  s.version       = '0.2.6'
   s.cert_chain  = ['certs/j15e.pem']
   s.signing_key = File.expand_path('~/.gem/private_key.pem') if $0 =~ /gem\z/
 

data/lib/capistrano/s3.rb

@@ -2,31 +2,35 @@ require 'capistrano'
 require 'capistrano/s3/publisher'
 
 unless Capistrano::Configuration.respond_to?(:instance)
-  abort "capistrano-s3 requires Capistrano >= 2."
+  abort "capistrano-s3 requires Capistrano 2.0 or newer"
 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"
   _cset :bucket_write_options, :acl => :public_read
-  
+  _cset :s3_endpoint, 's3.amazonaws.com'
+  _cset :redirect_options, {}
+
   # Deployment recipes
   namespace :deploy do
-    namespace :s3 do      
+    namespace :s3 do
       desc "Empties bucket of all files. Caution when using this command, as it cannot be undone!"
       task :empty do
-        Publisher.clear!(access_key_id, secret_access_key)
+        Publisher.clear!(s3_endpoint, access_key_id, secret_access_key, bucket)
       end
 
       desc "Upload files to the bucket in the current state"
       task :upload_files do
-        Publisher.publish!(access_key_id, secret_access_key, bucket, deployment_path, bucket_write_options)
+        extra_options = { :write => bucket_write_options, :redirect => redirect_options }
+        Publisher.publish!(s3_endpoint, access_key_id, secret_access_key,
+                           bucket, deployment_path, extra_options)
       end
     end
-    
+
     task :update do
       s3.upload_files
     end

data/lib/capistrano/s3/publisher.rb

@@ -1,12 +1,13 @@
 require 'aws/s3'
 require 'mime/types'
+require 'fileutils'
 
 module Publisher
 
   LAST_PUBLISHED_FILE = '.last_published'
 
-  def self.publish!(key, secret, bucket, source, extra_options)
-    s3 = self.establish_connection!(key, secret)
+  def self.publish!(s3_endpoint, key, secret, bucket, source, extra_options)
+    s3 = self.establish_s3_client_connection!(s3_endpoint, key, secret)
 
     self.files(source).each do |file|
       if !File.directory?(file)
@@ -15,48 +16,45 @@ module Publisher
         path = self.base_file_path(source, file)
         path.gsub!(/^\//, "") # Remove preceding slash for S3
 
-        contents = 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!(extra_options)
-        s3.buckets[bucket].objects[path].write(contents, options)
+        self.put_object(s3, bucket, path, file, extra_options)
       end
     end
 
     FileUtils.touch(LAST_PUBLISHED_FILE)
   end
 
-  def self.clear!(key, secret, bucket)    
-    s3 = self.establish_connection!(key, secret)
+  def self.clear!(s3_endpoint, key, secret, bucket)
+    s3 = self.establish_s3_connection!(s3_endpoint, key, secret)
     s3.buckets[bucket].clear!
+
+    FileUtils.rm(LAST_PUBLISHED_FILE)
   end
 
   private
 
     # Establishes the connection to Amazon S3
-    def self.establish_connection!(key, secret)
+    def self.establish_connection!(klass, s3_endpoint, key, secret)
       # Send logging to STDOUT
       AWS.config(:logger => Logger.new(STDOUT))
-      AWS::S3.new(
+      klass.new(
+        :s3_endpoint => s3_endpoint,
         :access_key_id => key,
         :secret_access_key => secret
       )
     end
 
+    def self.establish_s3_client_connection!(s3_endpoint, key, secret)
+      self.establish_connection!(AWS::S3::Client, s3_endpoint, key, secret)
+    end
+
+    def self.establish_s3_connection!(s3_endpoint, key, secret)
+      self.establish_connection!(AWS::S3, s3_endpoint, key, secret)
+    end
+
     def self.base_file_path(root, file)
       file.gsub(root, "")
     end
-  
+
     def self.files(deployment_path)
       Dir.glob("#{deployment_path}/**/*")
     end
@@ -65,4 +63,32 @@ module Publisher
       return false unless File.exists? LAST_PUBLISHED_FILE
       File.mtime(file) < File.mtime(LAST_PUBLISHED_FILE)
     end
-end
+
+    def self.put_object(s3, bucket, path, file, extra_options)
+      options = {
+        :bucket_name => bucket,
+        :key => path,
+        :data => open(file),
+        :acl => :public_read,
+      }
+
+      options.merge!( self.build_content_type_hash(file) )
+      options.merge!( self.build_redirect_hash(path, extra_options[:redirect]) )
+      options.merge!(extra_options[:write])
+
+      s3.put_object(options)
+    end
+
+    def self.build_content_type_hash(file)
+      type = MIME::Types.type_for(File.basename(file))
+      return {} unless type
+
+      { :content_type => type.first.content_type }
+    end
+
+    def self.build_redirect_hash(path, redirect_options)
+      return {} unless redirect_options && redirect_options[path]
+
+      { :website_redirect_location => redirect_options[path] }
+    end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-s3
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.2.6
 platform: ruby
 authors:
 - Jean-Philippe Doyle
 - Josh Delsman
+- Aleksandrs Ļedovskis
+- Douglas Jarquin
 autorequire: 
 bindir: bin
 cert_chain:
@@ -38,12 +39,11 @@ cert_chain:
   MjN3ZTRFMUx2ZlJuNWdWNzdEaWo2czlWNEhIek1CdUx3bk5iOFQrNmxPblVX
   YnRpSWRkRAplOGM4aTdQbHJ6aFZKLzhzWFVKc0NreUU4ZDJNeVJ5amx4TT0K
   LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-04-11 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
@@ -51,7 +51,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -59,7 +58,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -67,7 +65,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -75,7 +72,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,7 +79,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -91,7 +86,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -99,7 +93,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -127,26 +120,25 @@ files:
 homepage: http://github.com/hooktstudios/capistrano-s3
 licenses:
 - MIT
+metadata: {}
 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.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Build and deploy a static website to Amazon S3
 test_files: []