jekyll-s3 2.7.0 → 2.8.0

data/README.md

@@ -10,6 +10,7 @@ Deploy your jekyll site to S3.
 * Upload your site to AWS S3
 * Help you use AWS Cloudfront to distribute your Jekyll blog
 * Create an S3 website for you
+* Improve page speed with HTTP cache control and gzipping
 
 ## Install
 
@@ -31,6 +32,10 @@ s3_bucket: your.blog.bucket.com
 
 * Run `jekyll-s3` to push your Jekyll blog to S3. Congratulations! You are live.
 
+(If you are using `jekyll-s3` on an [EC2 instance with IAM
+roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances),
+you can omit the `s3_id` and `s3_secret` keys in the config file.)
+
 ### Using environment variables
 
 You can use ERB in your `_jekyll_s3.yml` file which incorporates environment variables:
@@ -150,7 +155,21 @@ thus force the CDN system to reload the changes from your Jekyll S3 bucket.
 #### Specifying custom settings for your CloudFront distribution
 
 The gem `configure-s3-website`, which is a dependency of `jekyll-s3`, lets you
-define custom settings for your CloudFront distribution. See the [gem's
+define custom settings for your CloudFront distribution.
+
+For example, like this you can define a your own TTL and CNAME:
+
+```yaml
+cloudfront_distribution_config:
+  default_cache_behavior:
+    min_TTL: <%= 60 * 60 * 24 %>
+  aliases:
+    quantity: 1
+    items:
+      CNAME: your.website.com
+```
+
+See the [gem's
 documentation](https://github.com/laurilehmijoki/configure-s3-website) for more
 info.
 
@@ -166,7 +185,30 @@ Enable the headless mode by adding the `--headless` or `-h` argument after
 
 ### Configuring redirects on your Jekyll S3 website
 
-You can set HTTP redirects on your Jekyll S3 website by adding the following
+You can set HTTP redirects on your Jekyll S3 website in two ways. If you only
+need simple "301 Moved Premanently" redirects for certain keys, use the
+Simple Redirects method. Otherwise, use the Routing Rules method.
+
+#### Simple Redirects
+
+For simple redirects Jekyll S3 uses Amazon S3's
+[`x-amz-website-redirect-location`](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html)
+metadata. It will create zero-byte objects for each path you want
+redirected with the appropriate `x-amz-website-redirect-location` value.
+
+For setting up simple redirect rules, simply list each path and target
+as key-value pairs under the `redirects` configuration option:
+
+```yaml
+redirects:
+  index.php: /
+  about.php: about.html
+  music-files/promo.mp4: http://www.youtube.com/watch?v=dQw4w9WgXcQ
+```
+
+#### Routing Rules
+
+You can configure more complex redirect rules by adding the following
 configuration into the `_jekyll_s3.yml` file:
 
 ```yaml
@@ -213,6 +255,11 @@ Jekyll::S3::Uploader.run('/path/to/your/jekyll-site/_site/', config, in_headless
 The code above will assume that you have the `_jekyll_s3.yml` in the directory
 `/path/to/your/jekyll-site`.
 
+## Example configurations
+
+See
+<https://github.com/laurilehmijoki/jekyll-s3/blob/master/example-configurations.md>.
+
 ## Known issues
 
 None. Please send a pull request if you spot any.

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.8.0
+
+* Add support for simple redirects
+
 ## 2.7.0
 
 * Allow s3_id and s3_secret to be omitted

data/example-configurations.md

@@ -0,0 +1,43 @@
+# Example `jekyll-s3` configurations
+
+This document shows examples of complete `_jekyll_s3.yml` configurations.
+
+## Minimal
+
+````yaml
+s3_id: abcd
+s3_secret: 2s+x92
+s3_bucket: your.domain.net
+````
+
+## Minimal with EC2 AIM roles
+
+````yaml
+s3_bucket: your.domain.net
+````
+
+If you run `jekyll-s3` on an EC2 instance with IAM roles, it is possible to omit
+the `s3_id` and `s3_secret`.
+
+## Optimised for speed: using CloudFront, gzip and cache headers
+
+````yaml
+s3_id: <%= ENV['your_domain_net_aws_key'] %>
+s3_secret: <%= ENV['your_domain_net_aws_secret'] %>
+s3_bucket: your.domain.net
+cloudfront_distribution_id: <%= ENV['your_domain_net_cloudfront_distribution_id'] %>
+cloudfront_distribution_config:
+  default_cache_behavior:
+    min_TTL: <%= 60 * 60 * 24 %>
+  aliases:
+    quantity: 1
+    items:
+      CNAME: your.domain.net
+max_age: 120
+gzip: true
+````
+
+Above, we store the AWS credentials and the id of the CloudFront distribution as
+environment variables. It's convenient, since you can keep the `_jekyll_s3.yml`
+in a public Git repo, and thus have your deployment configurations
+version-controlled.

data/features/cassettes/cucumber_tags/create-redirect.yml

@@ -0,0 +1,384 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:09 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - kGCga6NIm0ybqHxPbkdrzL4YTE2Ik7Az88+JBSXk1uPWgj0a0ozR9z5BdOUOZSKy
+      X-Amz-Request-Id:
+      - 87A0319E10B35221
+      Date:
+      - Tue, 28 May 2013 16:43:53 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Name>jekyll-s3-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>.gitkeep</Key><LastModified>2013-05-28T16:27:36.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>'
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:09 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:09 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - bAn0wcE+zU2espZy2XzUQAoKBVY42UbUZ6ELx6Vm4MFsCynvMspnh9xHuPpbw4BR
+      X-Amz-Request-Id:
+      - 16821C1979EFD9FB
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:10 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:10 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - S4qbXk9empwOUKpUl3teDUGS60qYOg0CxRm7v8ccxa1Z5Y9K60DWvq8v7YHWAPWc
+      X-Amz-Request-Id:
+      - 62DB5F01C0BEF2BA
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:10 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:10 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - KIW+hvipZEv+PgPc03LeddPDEcI7EzDH/CuoxrksuGUIHeA3ecmbIA+jlOgpMCi7
+      X-Amz-Request-Id:
+      - CFFC7DE02A902B74
+      Date:
+      - Tue, 28 May 2013 16:43:55 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:11 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/welcome.php
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:11 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Amz-Request-Id:
+      - C3D38989428864B4
+      X-Amz-Id-2:
+      - iEtbd2+jBo4YB/bWQF7S0nIPD04ctKzv8FpUL3vTPUQzwpVE70mCORaHuXASL/6V
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:12 GMT
+- request:
+    method: put
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/welcome.php
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      X-Amz-Website-Redirect-Location:
+      - /welcome
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:12 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - shxpzCHDkXgP6Ru7MjzBbiiONhv8O72UHLa12njGg/Ml16sNy9kGzzCEUp4T450a
+      X-Amz-Request-Id:
+      - 73AD74BF97A9FE39
+      Date:
+      - Tue, 28 May 2013 16:43:56 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:12 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/pets/dogs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:12 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Amz-Request-Id:
+      - 720BC22A793D95A4
+      X-Amz-Id-2:
+      - pc2CHQG08/lLFwc/Cq3upvG3Sm+wDzsmf1FsA+YuUjkfojvJB45NbkL5LCX35bpi
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 28 May 2013 16:43:55 GMT
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:13 GMT
+- request:
+    method: put
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net/pets/dogs
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      X-Amz-Website-Redirect-Location:
+      - /cats-and-dogs/wuf
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:13 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - qnGdeAUFkp76ErkCyx64T/eUilvlp2Y/b7QSCg5u+ghYyTtlR20szfiw0+tO/p7+
+      X-Amz-Request-Id:
+      - A38BEDA58C01CC5A
+      Date:
+      - Tue, 28 May 2013 16:43:57 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:14 GMT
+- request:
+    method: get
+    uri: https://s3.amazonaws.com/jekyll-s3-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:14 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - SEAH/XjpATFm0o1XovAZAXLIsYIktpmxg986HNG//aMuvy+sDLmbee5d+fPpO+x0
+      X-Amz-Request-Id:
+      - 2C139CA22908CC7A
+      Date:
+      - Tue, 28 May 2013 16:43:58 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Name>jekyll-s3-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>.gitkeep</Key><LastModified>2013-05-28T16:27:36.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>pets/dogs</Key><LastModified>2013-05-28T16:43:57.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>welcome.php</Key><LastModified>2013-05-28T16:43:56.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>'
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:14 GMT
+recorded_with: VCR 2.3.0

data/features/jekyll-s3-as-library.feature

@@ -21,3 +21,9 @@ Feature: Using Jekyll-s3 as a library
     When my Jekyll site is in "features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi"
     Then jekyll-s3 will push my blog to S3 and invalidate the Cloudfront distribution
     And report that it invalidated 2 Cloudfront item
+
+  @create-redirect
+  Scenario: Developer wants feedback on how many redirects Jekyll-s3 created
+    When my Jekyll site is in "features/support/test_site_dirs/create-redirects"
+    Then jekyll-s3 will push my blog to S3
+    And report that it created 2 new redirects

data/features/jekyll-s3-redirects.feature

@@ -0,0 +1,16 @@
+Feature: configure redirects
+
+  @create-redirect
+  Scenario: The user wants to configure new redirects for HTTP resources
+    When my Jekyll site is in "features/support/test_site_dirs/create-redirects"
+    Then jekyll-s3 will push my blog to S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      No new or changed files to upload
+      Creating new redirects ...
+        Redirect welcome.php to /welcome: Success!
+        Redirect pets/dogs to /cats-and-dogs/wuf: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3-website-us-east-1.amazonaws.com/index.html
+
+      """

data/features/step_definitions/steps.rb

@@ -31,6 +31,10 @@ Then /^report that it invalidated (\d+) Cloudfront item$/ do |expected|
   @amount_of_invalidated_items.should == expected.to_i
 end
 
+Then /^report that it created (\d+) new redirects$/ do |expected|
+  @amount_of_new_redirects.should == expected.to_i
+end
+
 Then /^report that it deleted (\d+) file from S3$/ do |amount_of_deleted_files|
   @amount_of_deleted_files.should == amount_of_deleted_files.to_i
 end
@@ -43,6 +47,7 @@ def do_run
     @amount_of_changed_files = result[:changed_files_count]
     @amount_of_deleted_files = result[:deleted_files_count]
     @amount_of_invalidated_items = result[:invalidated_items_count]
+    @amount_of_new_redirects = result[:changed_redirects_count]
   }
 end
 

data/features/support/test_site_dirs/create-redirects/_jekyll_s3.yml

@@ -0,0 +1,6 @@
+s3_id: foo
+s3_secret: foo
+s3_bucket: jekyll-s3-test.net
+redirects:
+  welcome.php: welcome
+  pets/dogs: cats-and-dogs/wuf

data/features/support/vcr.rb

@@ -14,4 +14,5 @@ VCR.cucumber_tags do |t|
   t.tag '@s3-and-cloudfront'
   t.tag '@s3-and-cloudfront-when-updating-a-file'
   t.tag '@one-file-to-delete'
+  t.tag '@create-redirect'
 end

data/jekyll-s3.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
-  s.version     = "2.7.0"
+  s.version     = "2.8.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]

data/lib/jekyll-s3/cli.rb

@@ -10,15 +10,16 @@ module Jekyll
       def run(site_dir, in_headless_mode = false)
         CLI.check_configuration site_dir
         config = Jekyll::S3::ConfigLoader.load_configuration site_dir
-        new_files_count, changed_files_count, deleted_files_count, changed_files =
+        new_files_count, changed_files_count, deleted_files_count, changed_files, changed_redirects =
           Uploader.run(site_dir, config, in_headless_mode)
         invalidated_items_count =
-          CLI.invalidate_cf_dist_if_configured(config, changed_files)
+          CLI.invalidate_cf_dist_if_configured(config, changed_files + changed_redirects)
         {
           :new_files_count => new_files_count,
           :changed_files_count => changed_files_count,
           :deleted_files_count => deleted_files_count,
-          :invalidated_items_count => invalidated_items_count
+          :invalidated_items_count => invalidated_items_count,
+          :changed_redirects_count => changed_redirects.size
         }
       rescue JekyllS3Error => e
         puts e.message

data/lib/jekyll-s3/uploader.rb

@@ -16,14 +16,18 @@ module Jekyll
           s3, config, site_dir
         )
 
+        redirects = config['redirects'] || {}
+        changed_redirects = setup_redirects redirects, config, s3
+
         deleted_files_count = remove_superfluous_files(s3, { :s3_bucket => config['s3_bucket'],
                                                              :site_dir => site_dir,
+                                                             :redirects => redirects,
                                                              :in_headless_mode => in_headless_mode,
                                                              :ignore_on_server => config["ignore_on_server"] })
 
         print_done_report config
 
-        [new_files_count, changed_files_count, deleted_files_count, changed_files]
+        [new_files_count, changed_files_count, deleted_files_count, changed_files, changed_redirects]
       end
 
       private
@@ -69,16 +73,53 @@ module Jekyll
         end
       end
 
+      def self.setup_redirects(redirects, config, s3)
+        operations = redirects.map do |path, target|
+          setup_redirect(path, target, s3, config)
+        end
+        performed_operations = operations.reject do |op|
+          op == :no_redirect_operation_performed
+        end
+        unless performed_operations.empty?
+          puts 'Creating new redirects ...'
+        end
+        performed_operations.each do |redirect_operation|
+          puts '  ' + redirect_operation[:report]
+        end
+        performed_operations.map do |redirect_operation|
+          redirect_operation[:path]
+        end
+      end
+
+      def self.setup_redirect(path, target, s3, config)
+        target = '/' + target unless target =~ %r{^(/|https?://)}
+        s3_object = s3.buckets[config['s3_bucket']].objects[path]
+
+        begin
+          current_head = s3_object.head
+        rescue AWS::S3::Errors::NoSuchKey
+        end
+
+        if current_head.nil? or current_head[:website_redirect_location] != target
+          s3_object.write('', :website_redirect_location => target)
+          {
+            :report => "Redirect #{path} to #{target}: Success!",
+            :path => path
+          }
+        else
+          :no_redirect_operation_performed
+        end
+      end
+
       def self.remove_superfluous_files(s3, options)
         s3_bucket_name = options.fetch(:s3_bucket)
         site_dir = options.fetch(:site_dir)
         in_headless_mode = options.fetch(:in_headless_mode)
 
         remote_files = s3.buckets[s3_bucket_name].objects.map { |f| f.key }
-        local_files = load_all_local_files(site_dir)
+        local_files = load_all_local_files(site_dir) + options.fetch(:redirects).keys
         files_to_delete = build_list_of_files_to_delete(remote_files, local_files, options[:ignore_on_server])
 
-
         deleted_files_count = 0
         if in_headless_mode
           files_to_delete.each { |s3_object_key|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -240,6 +240,8 @@ files:
 - Rakefile
 - bin/jekyll-s3
 - changelog.md
+- example-configurations.md
+- features/cassettes/cucumber_tags/create-redirect.yml
 - features/cassettes/cucumber_tags/new-and-changed-files.yml
 - features/cassettes/cucumber_tags/new-files-for-sydney.yml
 - features/cassettes/cucumber_tags/new-files.yml
@@ -252,6 +254,7 @@ files:
 - features/jekyll-s3-as-library.feature
 - features/jekyll-s3-cloudfront.feature
 - features/jekyll-s3-delete.feature
+- features/jekyll-s3-redirects.feature
 - features/jekyll-s3-upload.feature
 - features/jekyll-s3-website-performance.feature
 - features/step_definitions/steps.rb
@@ -262,6 +265,8 @@ files:
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_jekyll_s3.yml
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_site/css/styles.css
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_site/index.html
+- features/support/test_site_dirs/create-redirects/_jekyll_s3.yml
+- features/support/test_site_dirs/create-redirects/_site/.gitkeep
 - features/support/test_site_dirs/index-and-assets.blog.fi/_jekyll_s3.yml
 - features/support/test_site_dirs/index-and-assets.blog.fi/_site/assets/picture.gif
 - features/support/test_site_dirs/index-and-assets.blog.fi/_site/css/styles.css
@@ -337,7 +342,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4368343528403061082
+      hash: 1250183461535379030
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -346,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4368343528403061082
+      hash: 1250183461535379030
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -354,6 +359,7 @@ signing_key:
 specification_version: 3
 summary: Push your Jekyll blog to S3
 test_files:
+- features/cassettes/cucumber_tags/create-redirect.yml
 - features/cassettes/cucumber_tags/new-and-changed-files.yml
 - features/cassettes/cucumber_tags/new-files-for-sydney.yml
 - features/cassettes/cucumber_tags/new-files.yml
@@ -366,6 +372,7 @@ test_files:
 - features/jekyll-s3-as-library.feature
 - features/jekyll-s3-cloudfront.feature
 - features/jekyll-s3-delete.feature
+- features/jekyll-s3-redirects.feature
 - features/jekyll-s3-upload.feature
 - features/jekyll-s3-website-performance.feature
 - features/step_definitions/steps.rb
@@ -376,6 +383,8 @@ test_files:
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_jekyll_s3.yml
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_site/css/styles.css
 - features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_site/index.html
+- features/support/test_site_dirs/create-redirects/_jekyll_s3.yml
+- features/support/test_site_dirs/create-redirects/_site/.gitkeep
 - features/support/test_site_dirs/index-and-assets.blog.fi/_jekyll_s3.yml
 - features/support/test_site_dirs/index-and-assets.blog.fi/_site/assets/picture.gif
 - features/support/test_site_dirs/index-and-assets.blog.fi/_site/css/styles.css