middleman-s3_sync 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4274b6ae700e7ada09737ca3bc4a4759e5296f84
-  data.tar.gz: 3577abf69438b8f29aa8883c021501c9a4cd22cd
+  metadata.gz: a6071ceb81646793152f2cea3d256f2d72fc9be0
+  data.tar.gz: 40fa042f69caa0f1cb11080f46c58b7617cebf18
 SHA512:
-  metadata.gz: 20af8b1a06d25eb867eea58ae34f61fa571539ed3db35b3258d76eb156a71646bcf6bbece977cdda6e9c3857034a581682e0d0d2557c6a1f9dc19cebdd5989b7
-  data.tar.gz: 509254dbfde2791ef44e63e4cf55e13b5562c1294283a4375446a3d026216896f1c5e11f45465cc8edac8d6a33b32c30edf137527a9a5d8fa905a3689ec971d5
+  metadata.gz: c8b469c2462cbbab0a69ee4b62b7e540c3d4931058fa75768671d081ea10a68858f437da65a3087bb1aa6add9032781c427ccf7258ad93cd98d26adadcefaa19
+  data.tar.gz: ac19ceff36c306b7efb4f9507332c141a1521017c810a637a574b07c8de8eecf3053a21a626c60bac8d1cfbf13fd640960a21ce7d02dd80dbd2063591239fb4d

data/README.md

@@ -47,6 +47,8 @@ activate :s3_sync do |s3_sync|
   s3_sync.encryption                 = false
   s3_sync.prefix                     = ''
   s3_sync.version_bucket             = false
+  s3_sync.error_document             = '404.html'
+  s3_sync.index_suffix               = 'index.html'
 end
 ```
 
@@ -69,6 +71,7 @@ The following defaults apply to the configuration items:
 | encryption                 | ```false```                        |
 | acl                        | ```'public-read'```                |
 | version_bucket             | ```false```                        |
+| index_suffix               | ```index.html```                   |
 
 You do not need to specify the settings that match the defaults. This
 simplify the configuration of the extension:
@@ -303,6 +306,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 index suffix and error document
+
+You can enable a custom [index suffix](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_suffix``` 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_suffix, nil, 'Path of S3 directory index document'
+    option :error_document, nil, 'Path of S3 custom error document'
 
     def initialize(app, options_hash = {}, &block)
       super

data/lib/middleman/s3_sync.rb

@@ -35,6 +35,8 @@ module Middleman
 
         update_bucket_versioning
 
+        update_bucket_website
+
         ignore_resources
         create_resources
         update_resources
@@ -78,6 +80,17 @@ module Middleman
         connection.put_bucket_versioning(s3_sync_options.bucket, "Enabled") if s3_sync_options.version_bucket
       end
 
+      def update_bucket_website
+        opts = {}
+        opts[:ErrorDocument] = s3_sync_options.error_document unless s3_sync_options.error_document.nil?
+        opts[:IndexDocument] = s3_sync_options.index_suffix unless s3_sync_options.index_suffix.nil?
+        unless opts.empty?
+          opts[:IndexDocument] ||= 'index.html' # IndexDocument is mandatory in put_bucket_website
+          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,
@@ -188,4 +201,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_suffix,
+        :error_document
       ]
       attr_accessor *OPTIONS
 

data/lib/middleman/s3_sync/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module S3Sync
-    VERSION = "3.3.3"
+    VERSION = "3.3.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-s3_sync
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.3.4
 platform: ruby
 authors:
 - Frederic Jean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core