s3_website 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75048b9591b2516d217424c859f4154ea117cf57
-  data.tar.gz: ace75278f0925aa842b0e6a27d8c69a3a10b1fa3
+  metadata.gz: bad4fc74f724a4017ad910badbaeaebd90d0f2b7
+  data.tar.gz: 6c7e6efac417531ef5afec5b94a6bd74e795cc20
 SHA512:
-  metadata.gz: 493f9be03d3fdbc1253590cfb2762082a0928fc10b9dbcc176300d810cede4aa9af2e1b02ce36394ddbd4c9da79fd832999188add3b2014610c7901a5e11cb6f
-  data.tar.gz: 1a043fb4b2d95c2b2ab5839b8cc35289cfd389eefc2670d4c13b635b62afbd22ea9c2e366f45283e87dff6c8610269404291b31e4af2a3e102f062994575b576
+  metadata.gz: 47b2d9003a269827e1e0b3f8ebe7bb6816f284209e510009c306c30cf9c426477ca1345af15147cb8ba699b74c23af00f2cb55780586b656909aeb0a969e12e9
+  data.tar.gz: 9bbc213d27d7f8069e85031941252a2604ff28e2c2ac3656c402e43743b29991b7e990f7bac0f4c043883744957605e560eb53f9088ee94706e48aa72af19524

data/README.md

@@ -210,6 +210,25 @@ cloudfront_distribution_config:
 Once you've saved the configuration into `s3_website.yml`, you can apply them by
 running `s3_website cfg apply`.
 
+#### Invalidating root resources instead of index.htmls
+
+By default, `s3_website push` calls the CloudFront invalidation API with the
+file-name-as-it-is. This means that if your file is *article/index.html*, the
+push command will call the invalidation API on the resource
+*article/index.html*.
+
+You can instruct the push command to invalidate the root resource instead of the
+*index.html* resource by adding the following setting into the configuration
+file:
+
+    cloudfront_invalidate_root: true
+
+To recap, this setting instructs s3_website to invalidate the root resource
+(e.g., *article/*) instead of the filename'd resource (e.g.,
+*article/index.html).
+
+No more index.htmls in your URLs!
+
 ### The headless mode
 
 s3_website has a headless mode, where human interactions are disabled.

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 1.4.0
+
+* Add setting `cloudfront_invalidate_root`
+
 ## 1.3.2
 
 * Move blacklist filtering into a better place

data/lib/cloudfront/invalidator.rb

@@ -4,19 +4,27 @@ module S3Website
       def self.invalidate(config, changed_files)
         aws_key = config['s3_id']
         aws_secret = config['s3_secret']
-        s3_bucket_name = config['s3_bucket']
         cloudfront_distribution_id = config['cloudfront_distribution_id']
-        s3 = AWS::S3.new(
-          :access_key_id => aws_key,
-          :secret_access_key => aws_secret)
-        s3_object_keys = changed_files
+        s3_object_keys = apply_config config, changed_files
         s3_object_keys << ""
         report = SimpleCloudfrontInvalidator::CloudfrontClient.new(
-          aws_key, aws_secret, cloudfront_distribution_id).invalidate(
-            s3_object_keys)
+          aws_key, aws_secret, cloudfront_distribution_id
+        ).invalidate(s3_object_keys)
         puts report[:text_report]
         report[:invalidated_items_count]
       end
+
+      private
+
+      def self.apply_config(config, changed_files)
+        if config['cloudfront_invalidate_root']
+          changed_files.map { |changed_file|
+            changed_file.sub /\/index.html$/, '/'
+          }
+        else
+          changed_files
+        end
+      end
     end
   end
 end

data/resources/configuration_file_template.yml

@@ -30,6 +30,8 @@ s3_bucket: your.blog.bucket.com
 #     items:
 #       CNAME: your.website.com
 
+# cloudfront_invalidate_root: true
+
 # concurrency_level: 100
 
 # redirects:

data/s3_website.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "s3_website"
-  s.version     = "1.3.2"
+  s.version     = "1.4.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Lauri Lehmijoki"]
   s.email       = ["lauri.lehmijoki@iki.fi"]

data/spec/lib/cloudfront/invalidator_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe S3Website::Cloudfront::Invalidator do
+  describe 'default behaviour' do
+    let(:config) {
+      {
+        's3_id' => 'aws id',
+        's3_secret' => 'aws secret',
+        'cloudfront_distribution_id' => 'EFXX'
+      }
+    }
+
+    it 'invalidates the root resource' do
+      invalidator = double('invalidator')
+      SimpleCloudfrontInvalidator::CloudfrontClient.
+        should_receive(:new).
+        with('aws id', 'aws secret', 'EFXX').
+        and_return(invalidator)
+
+      invalidator.
+        should_receive(:invalidate).
+        with(['index.html', '']).
+        and_return(:text_report => 'report txt')
+
+      S3Website::Cloudfront::Invalidator.invalidate(config, ['index.html'])
+    end
+  end
+
+  describe 'option cloudfront_invalidate_root = true' do
+    let(:config) {
+      {
+        's3_id' => 'aws id',
+        's3_secret' => 'aws secret',
+        'cloudfront_distribution_id' => 'EFXX',
+        'cloudfront_invalidate_root' => true
+      }
+    }
+
+    it 'invalidates all root resources' do
+      invalidator = double('invalidator')
+      SimpleCloudfrontInvalidator::CloudfrontClient.
+        should_receive(:new).
+        with('aws id', 'aws secret', 'EFXX').
+        and_return(invalidator)
+
+      invalidator.
+        should_receive(:invalidate).
+        with(['article/', '']).
+        and_return(:text_report => 'report txt')
+
+      S3Website::Cloudfront::Invalidator.invalidate(config, ['article/index.html'])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -314,6 +314,7 @@ files:
 - lib/s3_website/uploader.rb
 - resources/configuration_file_template.yml
 - s3_website.gemspec
+- spec/lib/cloudfront/invalidator_spec.rb
 - spec/lib/config_loader_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/keyboard_spec.rb
@@ -429,6 +430,7 @@ test_files:
 - features/support/test_site_dirs/unpublish-a-post.com/s3_website.yml
 - features/support/vcr.rb
 - features/website-performance.feature
+- spec/lib/cloudfront/invalidator_spec.rb
 - spec/lib/config_loader_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/keyboard_spec.rb