middleman-s3_sync 4.0.1.rc.1 → 4.0.1.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aa620355fa36d4086923227d59faf63c45d32d1
-  data.tar.gz: 0eba8d4e743a9d1b73a7a6ee5ef5fcf28447cdf1
+  metadata.gz: c3d7517dd1c40614ca272b6b33c3ac6363532ce6
+  data.tar.gz: bfaedfa1b4485554a3446bd87e86a596db1d79c3
 SHA512:
-  metadata.gz: 19f333be406383826315d40513bc14ab10cce8dfb9cc68767078caab99ed27b095336599d10f9370c5c7d8d12bd83bb2ef7d90478dbbbc339c84ff534748ab48
-  data.tar.gz: b9606e5f31b4537dcac23e603d75e9a532d49675348733225ee6d1d5325f9ba9a78bcfd7c61de8fdea60a8767e540a3f4869e0c8f4cb3b4d5e3124b38e25e2ef
+  metadata.gz: f90ea23d7a08702f1299a1a00a61b33a8527ecc1f793abbd86adda2dff116791c8dfb51168d722b09a7a8023beb2d846578218765197b5eb4c0b1b62eca7192a
+  data.tar.gz: 2034640bb056f492c1188997bc83d61c70eb94299f73829cc20aa4f10d80c5f34d9acf404746ffd0b514221e702bba0340188af8302eab6f3ed20c7ea96650a2

data/README.md

@@ -52,6 +52,8 @@ activate :s3_sync do |s3_sync|
   s3_sync.encryption                 = false
   s3_sync.prefix                     = ''
   s3_sync.version_bucket             = false
+  s3_sync.index_document             = 'index.html'
+  s3_sync.error_document             = '404.html'
 end
 ```
 
@@ -333,6 +335,15 @@ headers will be set correctly. This will cause Amazon to serve the
 compressed version of the resource. In order for this to work, you need to
 have the `:gzip` extension activated in your `config.rb`.
 
+#### Custom S3 Index and Error Documents
+
+You can enable a custom [index document](http://docs.aws.amazon.com/AmazonS3/latest/dev/IndexDocumentSupport.html)
+and [error document](http://docs.aws.amazon.com/AmazonS3/latest/dev/CustomErrorDocSupport.html)
+settings. The ```index_document``` option tells which file name gets used as
+the index document of a directory (typically, ```index.html```), while
+```error_document``` specifies the document to display for 4xx errors (ie,
+the 404 page).
+
 ## A Debt of Gratitude
 
 I used Middleman Sync as a template for building a Middleman extension.

data/lib/middleman-s3_sync/extension.rb

@@ -23,6 +23,8 @@ module Middleman
     option :version_bucket, false, 'Whether to enable versionning on the S3 bucket content'
     option :verbose, false, 'Whether to provide more verbose output'
     option :dry_run, false, 'Whether to perform a dry-run'
+    option :index_document, nil, 'S3 custom index document path'
+    option :error_document, nil, 'S3 custom error document path'
 
     # S3Sync must be the last action in the manipulator chain
     self.resource_list_manipulator_priority = 9999

data/lib/middleman/s3_sync.rb

@@ -37,6 +37,8 @@ module Middleman
 
         update_bucket_versioning
 
+        update_bucket_website
+
         ignore_resources
         create_resources
         update_resources
@@ -75,6 +77,21 @@ module Middleman
         connection.put_bucket_versioning(s3_sync_options.bucket, "Enabled") if s3_sync_options.version_bucket
       end
 
+      def update_bucket_website
+        opts = {}
+        opts[:IndexDocument] = s3_sync_options.index_document if s3_sync_options.index_document
+        opts[:ErrorDocument] = s3_sync_options.error_document if s3_sync_options.error_document
+
+        if opts[:ErrorDocument] && !opts[:IndexDocument]
+          raise 'S3 requires `index_document` if `error_document` is specified'
+        end
+
+        unless opts.empty?
+          say_status "Putting bucket website: #{opts.to_json}"
+          connection.put_bucket_website(s3_sync_options.bucket, opts)
+        end
+      end
+
       def connection
         connection_options = {
           :region => s3_sync_options.region,
@@ -185,4 +202,3 @@ module Middleman
     end
   end
 end
-

data/lib/middleman/s3_sync/options.rb

@@ -21,7 +21,9 @@ module Middleman
         :version_bucket,
         :dry_run,
         :verbose,
-        :content_types
+        :content_types,
+        :index_document,
+        :error_document
       ]
       attr_accessor *OPTIONS
 

data/lib/middleman/s3_sync/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module S3Sync
-    VERSION = "4.0.1.rc.1"
+    VERSION = "4.0.1.rc.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-s3_sync
 version: !ruby/object:Gem::Version
-  version: 4.0.1.rc.1
+  version: 4.0.1.rc.2
 platform: ruby
 authors:
 - Frederic Jean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core